https://github.com/markwragg/PowerShell-MacNotify

A PowerShell module with a cmdlet for triggering notifications on MacOS.
https://github.com/markwragg/PowerShell-MacNotify

Last synced: 5 days ago
JSON representation

A PowerShell module with a cmdlet for triggering notifications on MacOS.

• Host: GitHub
• URL: https://github.com/markwragg/PowerShell-MacNotify
• Owner: markwragg
• Created: 2018-10-02T10:47:13.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-17T01:59:30.000Z (8 months ago)
• Last Synced: 2024-08-02T17:37:19.930Z (3 months ago)
• Language: PowerShell
• Homepage:
• Size: 226 KB
• Stars: 11
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# PowerShell-MacNotify

[![Build Status](https://dev.azure.com/markwragg/GitHub/_apis/build/status/markwragg.PowerShell-MacNotify?branchName=master)](https://dev.azure.com/markwragg/GitHub/_build/latest?definitionId=5&branchName=master) ![Test Coverage](https://img.shields.io/badge/coverage-55%25-red.svg?maxAge=60)

This PowerShell module contains cmdlets for triggering notifications to appear on MacOS.

![alt text](https://github.com/markwragg/PowerShell-MacNotify/raw/master/Media/Invoke-StackOverflowAlert.png "Example of Invoke-StackOverflowAlert")

## Installation

The module is published in the PSGallery, so can be installed by running:

```

Install-Module MacNotify -Scope CurrentUser

```

## Requires

- Mac OSX (Currently only tested on 10.14 Mojave).

- PowerShell Core 6.0+

## Usage

### Invoke-AlerterNotification

You can use `Invoke-AlerterNotification` to trigger a notification to appear with Show and Dismiss buttons via the command-line tool [Alerter](https://github.com/vjeantet/alerter). You do not need to install Alerter manually, a version of it has been bundled with this module.

> Note: Due to a potential bug with the way nuget packages are installed/extracted via .NET core this module currently checks if the bundled Alerter application has execute permissions assigned and if not, assigns them via chmod. This assumes bash is available in order to function.

**Examples:**

- [Invoke-StackOverflowAlert](https://github.com/markwragg/PowerShell-MacNotify/blob/master/Examples/Invoke-StackOverflowAlert.ps1) -- This example code shows how you could configure a PowerShell script to run as a cron job to notify you of new StackOverflow questions on a specified tag. By using Alerter for the notification you can then also configure it to take you directly to the question when "Show" is clicked.

### Invoke-MacNotification

You can use `Invoke-MacNotification` to trigger a notification to appear via Apple Script.  You must minimally specify the message text to display via `-Message`, the pipeline or as the first positional parameter. Note that with this type of notification you cannot configure an action to occur when the notification is clicked.

**Examples:**

```

Invoke-MacNotification -Message 'Hello!'

Invoke-MacNotification Hello -Sound Frog

Invoke-MacNotification 'How are you?' -Title 'Some title'

Invoke-MacNotification 'Some message' -Title 'Some title' -Subtitle 'Some subtitle' -Sound 'Ping'

1,2,3 | Invoke-MacNotification -Title 'Numbers'

Invoke-MacNotification Hi

```

Note: the `-Sound` parameter uses a class to get a dynamic list of the available sound files under the default sound paths. As such you must specify the name of a sound from one of these locations for this parameter (or see tab completion for the parameter for the available options):

- '/System/Library/Sounds/'

- '/Library/Sounds'

- '~/Library/Sounds'

## Examples

For usage examples, see the /Examples folder.

## Cmdlets

A full list of cmdlets in this module is provided below for reference. Use `Get-Help ` with these to learn more about their usage.

Cmdlet           | Description

-----------------| -------------------------------------------------------------------------------------------------------

Invoke-MacNotification | Triggers a notification to appear in OSX with the specified message and optional title, subtitle and sound alert.

Invoke-AlerterNotification | Triggers an alerter notification to appear in OSX with the specified message and optional title, subtitle and sound alert.