5 Notify_macosx
Chris Caron edited this page 2023-09-17 15:59:10 -04:00

MacOS X Desktop Notifications

  • Source: n/a
  • Icon Support: Yes
  • Message Format: Text
  • Message Limit: 250 Characters per message

Display notifications right on your Mac OS X desktop provided you're running version 10.8 or higher and have installed terminal-notifier. This only works if you're sending the notification to the same system you're currently accessing. Hence this notification can not be sent from one PC to another.

# Make sure terminal-notifier is installed into your system
brew install terminal-notifier

Syntax

There are currently no options you can specify for this kind of notification, so it's really easy to reference:

  • macosx://

You can also choose to set a sound to play (such as default):

  • macosx://_/?sound=default

The sound can be set any of the sound names listed in Sound Preferences of your Mac OS.

Parameter Breakdown

Variable Required Description
sound No The sound can be set any of the sound names listed in Sound Preferences of your Mac OS.
image No Associate an image with the message. By default this is enabled.

Example

We can send a notification to ourselves like so:

# Send ourselves a MacOS desktop notification
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "macosx://"

# Send ourselves a MacOS desktop notification with the default sound
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "macosx://_/?sound=default"