Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Zearin authored and julienXX committed Oct 29, 2017
1 parent 3ebc111 commit e4eb0ba
Showing 1 changed file with 57 additions and 43 deletions.
100 changes: 57 additions & 43 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# terminal-notifier

terminal-notifier is a command-line tool to send Mac OS X User Notifications,
which are available in Mac OS X 10.8 and higher.
terminal-notifier is a command-line tool to send OS X User Notifications,
which are available on OS X 10.8 and higher.


## Caveats

* Under OS X 10.8, the Notification Center _always_ uses the application’s own
icon, there’s currently no way to specify a custom icon for a notification. The only
way to use this tool with your own icon is to use the `-sender` option or include a
build of terminal-notifier with your icon and **a different bundle identifier**
instead. (If you do not change the bundle identifier, launch services will use
a cached version of the icon.)
<br/>Consequently the `-appIcon` & `-contentImage` options aren't doing anything
under 10.8.
<br/>However, you _can_ use unicode symbols and emojis. See the examples.
* On OS X 10.8, the `-appIcon` and `-contentImage` options do nothing.
This is because Notification Center on 10.8 _always_ uses the application’s own icon.

You can do one of the following to work around this limitation on 10.8:
- Use the `-sender` option to “fake it” (see below)
- Include a build of terminal-notifier with your icon **and a different bundle identifier**.
(If you don’t change the bundle identifier, launch services uses a cached version of the icon.)

However, you _can_ use unicode symbols and emojis! See the examples.

* It is currently packaged as an application bundle, because `NSUserNotification`
does not work from a ‘Foundation tool’. [radar://11956694](radar://11956694)

* If you intend to package terminal-notifier with your app to distribute it on the
MAS, please use 1.5.2 since 1.6.0+ uses a private method override which is not
allowed in the AppStore guidelines.
MAS, please use 1.5.2; version 1.6.0+ uses a private method override, which is not
allowed in the App Store Guidelines.


## Download
Expand Down Expand Up @@ -60,28 +60,38 @@ $ terminal-notifier -[message|group|list] [VALUE|ID|ID] [options]

This will obviously be a bit slower than using the tool without the wrapper.

Some examples are:

### Example Uses

Display piped data with a sound:
```
$ echo 'Piped Message Data!' | terminal-notifier -sound default
```

Open an URL when the notification is clicked:
```
$ terminal-notifier -title '💰' -message 'Check your Apple stock!' -open 'http://finance.yahoo.com/q?s=AAPL'
```

Open an app when the notification is clicked:
```
$ terminal-notifier -group 'address-book-sync' -title 'Address Book Sync' -subtitle 'Finished' -message 'Imported 42 contacts.' -activate 'com.apple.AddressBook'
```


#### Options
### Options

At a minimum, you have to specify either the `-message` , the `-remove`
or the `-list` option.
At a minimum, you must specify either the `-message` , the `-remove`, or the
`-list` option.

-------------------------------------------------------------------------------

`-message VALUE` **[required]**

The message body of the notification.

Note that if this option is omitted and data is piped to the application, that
data will be used instead.
If you pipe data into terminal-notifier, you can omit this option,
and the piped data will become the message body instead.

-------------------------------------------------------------------------------

Expand All @@ -99,52 +109,56 @@ The subtitle of the notification.

`-sound NAME`

The name of a sound to play when the notification appears. The names are listed
in Sound Preferences. Use 'default' for the default notification sound.
Play the `NAME` sound when the notification appears.
Sound names are listed in Sound Preferences.

Use the special `NAME` “default” for the default notification sound.

-------------------------------------------------------------------------------

`-group ID`

Specifies the ‘group’ a notification belongs to. For any ‘group’ only _one_
Specifies the notification’s ‘group’. For any ‘group’, only _one_
notification will ever be shown, replacing previously posted notifications.

A notification can be explicitely removed with the `-remove` option, describe
below.
A notification can be explicitly removed with the `-remove` option (see
below).

Examples are:
Example group IDs:

* The sender’s name to scope the notifications by tool.
* The sender’s process ID to scope the notifications by a unique process.
* The current working directory to scope notifications by project.
* The sender’s name (to scope the notifications by tool).
* The sender’s process ID (to scope the notifications by a unique process).
* The current working directory (to scope notifications by project).

-------------------------------------------------------------------------------

`-remove ID` **[required]**

Removes a notification that was previously sent with the specified ‘group’ ID,
if one exists. If used with the special group "ALL", all message are removed.
Remove a previous notification from the `ID` ‘group’, if one exists.

Use the special `ID` “ALL” to remove all messages.

-------------------------------------------------------------------------------

`-list ID` **[required]**

Lists details about the specified ‘group’ ID. If used with the special group
"ALL", details about all currently active messages are displayed.
Lists details about the specified ‘group’ `ID`.

Use the special `ID` “ALL” to list details about all currently active messages.

The output of this command is tab-separated, which makes it easy to parse.

-------------------------------------------------------------------------------

`-activate ID`

Specifies which application should be activated when the user clicks the
Activate the application specified by `ID` when the user clicks the
notification.

You can find the bundle identifier of an application in its `Info.plist` file
_inside_ the application bundle.

Examples are:
Examples application IDs are:

* `com.apple.Terminal` to activate Terminal.app
* `com.apple.Safari` to activate Safari.app
Expand All @@ -153,45 +167,45 @@ Examples are:

`-sender ID`

Specifying this will make it appear as if the notification was send by that
application instead, including using its icon.
Fakes the sender application of the notification. This uses the specified
application’s icon, and will launch it when the notification is clicked.

Using this option fakes the sender application, so that the notification system
will launch that application when the notification is clicked. Because of this
it is important to note that you cannot combine this with options like
`-execute` and `-activate` which depend on the sender of the notification to be
‘terminal-notifier’ to perform its work.

For information on the `ID` see the `-activate` option.
For information on the `ID`, see the `-activate` option.

-------------------------------------------------------------------------------

`-appIcon PATH` **[10.9+ only]**

Specifies The PATH of an image to display instead of the application icon.
Specify an image `PATH` to display instead of the application icon.

**WARNING: This option is subject to change since it relies on a private method.**
**WARNING: This option is subject to change, since it relies on a private method.**

-------------------------------------------------------------------------------

`-contentImage PATH` **[10.9+ only]**

Specifies The PATH of an image to display attached inside the notification.
Specify an image `PATH` to attach inside of the notification.

**WARNING: This option is subject to change since it relies on a private method.**

-------------------------------------------------------------------------------

`-open URL`

Specifies a resource to be opened when the user clicks the notification. This
can be a web or file URL, or any custom URL scheme.
Open `URL` when the user clicks the notification. This can be a web or file URL,
or any custom URL scheme.

-------------------------------------------------------------------------------

`-execute COMMAND`

Specifies a shell command to run when the user clicks the notification.
Run the shell command `COMMAND` when the user clicks the notification.


## License
Expand Down

0 comments on commit e4eb0ba

Please sign in to comment.