Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 164 lines (102 sloc) 5.587 kB
c02b1a2 @foxycoder Updated the Readme's
foxycoder authored
1 # TerminalNotifier for [Guard][GUARD]
7e5c36e @alloy Add README.
alloy authored
2
69b1dd1 @alloy Update README
alloy authored
3 terminal-notifier is a command-line tool to send Mac OS X User Notifications,
4 which are available in Mac OS X 10.8.
7e5c36e @alloy Add README.
alloy authored
5
6 It is currently packaged as an application bundle, because `NSUserNotification`
69b1dd1 @alloy Update README
alloy authored
7 does not work from a ‘Foundation tool’. [radar://11956694](radar://11956694)
7e5c36e @alloy Add README.
alloy authored
8
40f94db @alloy Fix docs regarding `title` and add note about custom icons being unsu…
alloy authored
9 The Notification Center _always_ uses the application’s own icon, there’s
c02b1a2 @foxycoder Updated the Readme's
foxycoder authored
10 currently no way to specify a custom icon for a notification. However, we have
11 supplied you with 4 different apps, each with their own icon, to represent
12 statuses like: failed, success, pending, and the default notify / info style
13 notification.
40f94db @alloy Fix docs regarding `title` and add note about custom icons being unsu…
alloy authored
14
c02b1a2 @foxycoder Updated the Readme's
foxycoder authored
15 This tool will be used by [Guard][GUARD] to show the
16 status of commands which are executed due to filesystem changes.
7e5c36e @alloy Add README.
alloy authored
17
18
df4ace2 @alloy Fix README markup.
alloy authored
19 ## Download
7e5c36e @alloy Add README.
alloy authored
20
b66dfd0 @alloy Time, a good concept.
alloy authored
21 Prebuilt binaries, which are code-signed and ready to use, are available from
e633555 @foxycoder Fixed link to the download section in the Readme
foxycoder authored
22 the [downloads section](https://github.com/Springest/terminal-notifier-guard/downloads).
7e5c36e @alloy Add README.
alloy authored
23
dc92907 @alloy Release 1.3.0
alloy authored
24 Or if you want to use this from
c02b1a2 @foxycoder Updated the Readme's
foxycoder authored
25 [Ruby](https://github.com/Springest/terminal-notifier-guard/tree/master/Ruby), you can
dc92907 @alloy Release 1.3.0
alloy authored
26 install it through RubyGems:
27
28 ```
c02b1a2 @foxycoder Updated the Readme's
foxycoder authored
29 $ [sudo] gem install terminal-notifier-guard
dc92907 @alloy Release 1.3.0
alloy authored
30 ```
31
7e5c36e @alloy Add README.
alloy authored
32
df4ace2 @alloy Fix README markup.
alloy authored
33 ## Usage
7e5c36e @alloy Add README.
alloy authored
34
ba3c9fb @alloy More fixes to README markup.
alloy authored
35 ```
c02b1a2 @foxycoder Updated the Readme's
foxycoder authored
36 $ ./terminal-notifier-notify.app/Contents/MacOS/terminal-notifier -[message|group|list] [VALUE|ID|ID] [options]
37 $ ./terminal-notifier-failed.app/Contents/MacOS/terminal-notifier -[message|group|list] [VALUE|ID|ID] [options]
ba3c9fb @alloy More fixes to README markup.
alloy authored
38 ```
7e5c36e @alloy Add README.
alloy authored
39
fd71a70 @alloy Update README.
alloy authored
40 In order to use terminal-notifier, you have to call the binary _inside_ the
dc92907 @alloy Release 1.3.0
alloy authored
41 application bundle.
42
43 The Ruby gem, which wraps this tool, _does_ have a bin wrapper. If installed
44 you can simply do:
45
46 ```
c02b1a2 @foxycoder Updated the Readme's
foxycoder authored
47 $ terminal-notifier-notify -[message|group|list] [VALUE|ID|ID] [options]
48 $ terminal-notifier-succes -[message|group|list] [VALUE|ID|ID] [options]
dc92907 @alloy Release 1.3.0
alloy authored
49 ```
50
51 This will obviously be a bit slower than using the tool without the wrapper.
52
7e5c36e @alloy Add README.
alloy authored
53
fd71a70 @alloy Update README.
alloy authored
54 #### Options
7e5c36e @alloy Add README.
alloy authored
55
576ac43 @frostrubin Corrections for the Readme
frostrubin authored
56 At a minimum, you have to specify either the `-message` , the `-remove`
8358889 @frostrubin updated README
frostrubin authored
57 option or the `-list` option.
7e5c36e @alloy Add README.
alloy authored
58
fd71a70 @alloy Update README.
alloy authored
59 -------------------------------------------------------------------------------
60
61 `-message VALUE` **[required]**
62
63 The message body of the notification.
64
65 -------------------------------------------------------------------------------
66
67 `-title VALUE`
68
69 The title of the notification. This defaults to ‘Terminal’.
70
71 -------------------------------------------------------------------------------
72
282f4ab @henrikbrixandersen Add support for NSUserNotification.subtitle #8
henrikbrixandersen authored
73 `-subtitle VALUE`
74
75 The subtitle of the notification.
76
77 -------------------------------------------------------------------------------
78
fd71a70 @alloy Update README.
alloy authored
79 `-group ID`
80
81 Specifies the ‘group’ a notification belongs to. For any ‘group’ only _one_
82 notification will ever be shown, replacing previously posted notifications.
83
9039a4a @alloy Add `-remove groupID` option which removes a notfiication. Closes #6.
alloy authored
84 A notification can be explicitely removed with the `-remove` option, describe
85 below.
86
fd71a70 @alloy Update README.
alloy authored
87 Examples are:
88
89 * The sender’s name to scope the notifications by tool.
90 * The sender’s process ID to scope the notifications by a unique process.
91 * The current working directory to scope notifications by project.
92
93 -------------------------------------------------------------------------------
9039a4a @alloy Add `-remove groupID` option which removes a notfiication. Closes #6.
alloy authored
94
95 `-remove ID` **[required]**
96
97 Removes a notification that was previously sent with the specified ‘group’ ID,
8358889 @frostrubin updated README
frostrubin authored
98 if one exists. If used with the special group "ALL", all message are removed.
99
100 -------------------------------------------------------------------------------
101
102 `-list ID` **[required]**
103
4145da7 @alloy Don’t output anything if there are no notifications to list.
alloy authored
104 Lists details about the specified ‘group’ ID. If used with the special group
105 "ALL", details about all currently active messages are displayed.
106
107 The output of this command is tab-separated, which makes it easy to parse.
9039a4a @alloy Add `-remove groupID` option which removes a notfiication. Closes #6.
alloy authored
108
109 -------------------------------------------------------------------------------
fd71a70 @alloy Update README.
alloy authored
110
111 `-activate ID`
112
113 Specifies which application should be activated when the user clicks the
114 notification.
115
116 You can find the bundle identifier of an application in its `Info.plist` file
117 _inside_ the application bundle.
118
119 Examples are:
120
121 * `com.apple.Terminal` to activate Terminal.app
122 * `com.apple.Safari` to activate Safari.app
123
124 -------------------------------------------------------------------------------
125
126 `-open URL`
127
128 Specifies a resource to be opened when the user clicks the notification. This
129 can be a web or file URL, or any custom URL scheme.
130
131 -------------------------------------------------------------------------------
132
133 `-execute COMMAND`
134
135 Specifies a shell command to run when the user clicks the notification.
7e5c36e @alloy Add README.
alloy authored
136
137
df4ace2 @alloy Fix README markup.
alloy authored
138 ## License
7e5c36e @alloy Add README.
alloy authored
139
c02b1a2 @foxycoder Updated the Readme's
foxycoder authored
140 All the works are available under the MIT license.
7e5c36e @alloy Add README.
alloy authored
141
142 Copyright (C) 2012 Eloy Durán <eloy.de.enige@gmail.com>
c02b1a2 @foxycoder Updated the Readme's
foxycoder authored
143 & Wouter de Vos <wouter.de.vos@springest.com>
7e5c36e @alloy Add README.
alloy authored
144
145 Permission is hereby granted, free of charge, to any person obtaining a copy of
146 this software and associated documentation files (the "Software"), to deal in
147 the Software without restriction, including without limitation the rights to
148 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
149 of the Software, and to permit persons to whom the Software is furnished to do
150 so, subject to the following conditions:
151
152 The above copyright notice and this permission notice shall be included in all
153 copies or substantial portions of the Software.
154
155 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
156 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
157 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
158 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
159 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
160 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
161 SOFTWARE.
c02b1a2 @foxycoder Updated the Readme's
foxycoder authored
162
163 [GUARD]: https://github.com/guard/guard
Something went wrong with that request. Please try again.