Data

Tools

Indexes

Applications

Experiments

Ruby

A summary of data about the Ruby ecosystem.

https://github.com/julienXX/terminal-notifier

Send User Notifications on macOS from the command-line.
https://github.com/julienXX/terminal-notifier

Keywords

command-line notifications objective-c osx ruby

Keywords from Contributors

rack activerecord error-handler sinatra

Last synced: 40 minutes ago
JSON representation

Repository metadata

Send User Notifications on macOS from the command-line.

README.markdown

terminal-notifier

GitHub release

terminal-notifier is a command-line tool to send macOS User Notifications,
which are available on macOS 10.10 and higher.

News

alerter features were merged in terminal-notifier 1.7. This led to some issues and even more issues in the 1.8 release. We decided with Valère Jeantet to rollback this merge.

From now on terminal-notifier won't have the sticky notification feature nor the actions buttons. If you need them please use alerter. I also want to follow semver hence this latest version starts at 2.0.0.

Sticking to two smaller specialized tools will hopefully make them easier to maintain and less error prone.

Caveats

  • It is currently packaged as an application bundle, because NSUserNotification
    does not work from a ‘Foundation tool’. radar://11956694

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

  • If you're using macOS < 10.10 you should use terminal-notifier 1.6.3.

  • If you're looking for sticky notifications or more actions on a notification please use alerter

Download

Prebuilt binaries are available from the
releases section.

Or if you want to use this from
Ruby, you can
install it through RubyGems:

$ [sudo] gem install terminal-notifier

You can also install it via Homebrew:

$ brew install terminal-notifier

Usage

$ ./terminal-notifier.app/Contents/MacOS/terminal-notifier -[message|group|list] [VALUE|ID|ID] [options]

In order to use terminal-notifier, you have to call the binary inside the
application bundle.

The Ruby gem, which wraps this tool, does have a bin wrapper. If installed
you can simply do:

$ terminal-notifier -[message|group|list] [VALUE|ID|ID] [options]

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

If you'd like notifications to stay on the screen until dismissed, go to System Preferences -> Notifications -> terminal-notifier and change the style from Banners to Alerts. You cannot do this on a per-notification basis.

Example Uses

Display piped data with a sound:

$ echo 'Piped Message Data!' | terminal-notifier -sound default

Example 1

Use a custom icon:

$ terminal-notifier -title ProjectX -subtitle "new tag detected" -message "Finished" -appIcon http://vjeantet.fr/images/logo.png

Example 3

Open an URL when the notification is clicked:

$ terminal-notifier -title '💰' -message 'Check your Apple stock!' -open 'http://finance.yahoo.com/q?s=AAPL'

Example 4

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'

Example 5

Options

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

-message VALUE [required]

The message body of the notification.

If you pipe data into terminal-notifier, you can omit this option,
and the piped data will become the message body instead.

-title VALUE

The title of the notification. This defaults to ‘Terminal’.

-subtitle VALUE

The subtitle of the notification.

-sound NAME

Play the NAME sound when the notification appears.
Sound names are listed in /System/Library/Sounds.

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

-group ID

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

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

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).

-remove ID [required]

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.

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

Activate the application specified by ID when the user clicks the
notification.

You can find the bundle identifier (CFBundleIdentifier) of an application in its Info.plist file
inside the application bundle.

Examples application IDs are:

  • com.apple.Terminal to activate Terminal.app
  • com.apple.Safari to activate Safari.app

-sender ID

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.

-appIcon PATH

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.

-contentImage PATH

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

Open URL when the user clicks the notification. This can be a web or file URL,
or any custom URL scheme.

-execute COMMAND

Run the shell command COMMAND when the user clicks the notification.

-ignoreDnD

Ignore Do Not Disturb settings and unconditionally show the notification.

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

License

All the works are available under the MIT license. Except for
‘Terminal.icns’, which is a copy of Apple’s Terminal.app icon and as such is
copyright of Apple.

Copyright (C) 2012-2017 Eloy Durán eloy.de.enige@gmail.com, Julien Blanchard
julien@sideburns.eu

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 1 day ago

Total Commits: 160
Total Committers: 34
Avg Commits per committer: 4.706
Development Distribution Score (DDS): 0.544

Commits in past year: 0
Committers in past year: 0
Avg Commits per committer in past year: 0.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
Eloy Durán e****e@g****m 73
Julien Blanchard j****n@s****u 41
Bernhard Seeger f****n@g****m 4
Matt Grosso m****o@a****g 3
Tsukasa OMOTO h****2@g****m 3
Zearin Z****n 2
Jonas j****r 2
Erran Carey e@i****m 2
David Cordero d****z@g****m 2
Chih-Wei Lee d****y@g****m 2
Alex i****6@g****m 2
Sébastien Gross s****g 2
Ufuk Kayserilioglu u****k@e****m 1
Dru Kepple d****e@b****m 1
Ben Aubin b****n@b****m 1
Christopher Hiller b****l@b****m 1
Darwin Wu d****n@b****u 1
jefeweisen j****n 1
fukayatsu f****u@g****m 1
aspinall c****l@g****m 1
Vladislav Bogomolov v****k@g****m 1
Timo Schilling t****o@s****o 1
Russell Hancox r****l@h****s 1
Rany Keddo r****y@p****t 1
Nick Campbell n****8@g****m 1
Max Beizer m****r@g****m 1
Konstantin Dorodov d****v@g****m 1
Joe Simpson h****y@g****m 1
Jeremy Matthews j****s@m****m 1
Henrik Brix Andersen h****k@b****k 1
and 4 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 14 days ago

Total issues: 104
Total pull requests: 15
Average time to close issues: 6 months
Average time to close pull requests: 5 months
Total issue authors: 92
Total pull request authors: 14
Average comments per issue: 4.65
Average comments per pull request: 1.87
Merged pull request: 4
Bot issues: 0
Bot pull requests: 0

Past year issues: 6
Past year pull requests: 3
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 6
Past year pull request authors: 2
Past year average comments per issue: 2.0
Past year average comments per pull request: 2.33
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/julienXX/terminal-notifier

Top Issue Authors

  • forthrin (6)
  • JayBrown (3)
  • franton (2)
  • nhooyr (2)
  • tjluoma (2)
  • lgarron (2)
  • JeganMSD (2)
  • staticfloat (1)
  • R0maric (1)
  • BambiB (1)
  • luchofariello (1)
  • lucasmen9527 (1)
  • getaaron (1)
  • guidovizioli (1)
  • n1ck3 (1)

Top Pull Request Authors

  • mikestaub (2)
  • idhruvs (1)
  • johnlee999 (1)
  • ryanfaerman (1)
  • glasser (1)
  • wilkinson4 (1)
  • tmaher (1)
  • varenc (1)
  • abcdenis (1)
  • DidierA (1)
  • fmaclen (1)
  • shalecraig (1)
  • y-yagi (1)
  • fromdavelewis (1)

Top Issue Labels

  • bug (12)
  • waiting for answer (9)
  • question (8)
  • enhancement (7)
  • Catalina (3)
  • documentation (3)
  • wontfix (3)
  • wrapper (3)
  • 10.11 (1)
  • tmux (1)
  • Big Sur (1)

Top Pull Request Labels

Package metadata

gem.coop: terminal-notifier

Send User Notifications on macOS 10.10 or higher.

  • Homepage: https://github.com/julienXX/terminal-notifier
  • Documentation: http://www.rubydoc.info/gems/terminal-notifier/
  • Licenses: MIT
  • Latest release: 2.0.0 (published over 8 years ago)
  • Last Synced: 2026-02-28T21:01:16.734Z (3 days ago)
  • Versions: 17
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 115,774,239 Total
  • Docker Downloads: 42,438,163
  • Rankings:
    • Dependent repos count: 0.0%
    • Dependent packages count: 0.0%
    • Average: 0.216%
    • Downloads: 0.23%
    • Docker downloads count: 0.633%
  • Maintainers (2)
rubygems.org: terminal-notifier

Send User Notifications on macOS 10.10 or higher.

  • Homepage: https://github.com/julienXX/terminal-notifier
  • Documentation: http://www.rubydoc.info/gems/terminal-notifier/
  • Licenses: MIT
  • Latest release: 2.0.0 (published over 8 years ago)
  • Last Synced: 2026-03-02T12:03:05.282Z (1 day ago)
  • Versions: 17
  • Dependent Packages: 185
  • Dependent Repositories: 22,106
  • Downloads: 115,846,051 Total
  • Docker Downloads: 42,438,163
  • Rankings:
    • Stargazers count: 0.187%
    • Dependent packages count: 0.196%
    • Dependent repos count: 0.24%
    • Downloads: 0.271%
    • Average: 0.525%
    • Docker downloads count: 0.774%
    • Forks count: 1.484%
  • Maintainers (2)
formulae.brew.sh: terminal-notifier

Send macOS User Notifications from the command-line

  • Homepage: https://github.com/julienXX/terminal-notifier
  • Licenses: MIT
  • Latest release: 2.0.0 (published almost 4 years ago)
  • Last Synced: 2026-02-28T21:01:15.991Z (3 days ago)
  • Versions: 1
  • Dependent Packages: 10
  • Dependent Repositories: 401
  • Downloads: 8,005 Last month
  • Rankings:
    • Dependent repos count: 0.954%
    • Dependent packages count: 2.764%
    • Stargazers count: 4.534%
    • Average: 5.001%
    • Forks count: 8.141%
    • Downloads: 8.611%
nixpkgs-23.11: terminal-notifier

nixpkgs-unstable: terminal-notifier

nixpkgs-24.05: terminal-notifier

nixpkgs-24.11: terminal-notifier

nixpkgs-23.05: terminal-notifier

Score: 31.962616641752085