Skip to content

Commit 61df87b

Browse files
committed
Update README
1 parent 67422e7 commit 61df87b

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

README.markdown

+59
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,28 @@ This will obviously be a bit slower than using the tool without the wrapper.
6262

6363
Some examples are:
6464

65+
Display piped data with a sound
6566
```
6667
$ echo 'Piped Message Data!' | terminal-notifier -sound default
68+
```
69+
70+
Multiple actions and custom dropdown list
71+
```
72+
$ terminal-notifier -message "Deploy now on UAT ?" -actions Now,"Later today","Tomorrow" -dropdownLabel "When ?"
73+
```
74+
75+
Yes or No ?
76+
```
77+
$ terminal-notifier -title ProjectX -subtitle "new tag detected" -message "Deploy now on UAT ?" -closeLabel No -actions Yes -appIcon http://vjeantet.fr/images/logo.png
78+
```
79+
80+
Open an URL when the notification is clicked
81+
```
6782
$ terminal-notifier -title '💰' -message 'Check your Apple stock!' -open 'http://finance.yahoo.com/q?s=AAPL'
83+
```
84+
85+
Open an app when the notification is clicked
86+
```
6887
$ terminal-notifier -group 'address-book-sync' -title 'Address Book Sync' -subtitle 'Finished' -message 'Imported 42 contacts.' -activate 'com.apple.AddressBook'
6988
```
7089

@@ -104,6 +123,46 @@ in Sound Preferences. Use 'default' for the default notification sound.
104123

105124
-------------------------------------------------------------------------------
106125

126+
`-reply`
127+
128+
The notification will be displayed as a reply type alert.
129+
130+
-------------------------------------------------------------------------------
131+
132+
`-actions VALUE1,VALUE2,"VALUE 3"`
133+
134+
The notification actions avalaible.
135+
When you provide more than one value, a dropdown will be displayed.
136+
You can customize this dropdown label with the next option
137+
Does not work when -reply is used
138+
139+
-------------------------------------------------------------------------------
140+
141+
`-dropdownLabel VALUE`
142+
143+
The notification actions dropdown title (only when multiples -actions values are provided).
144+
Does not work when -reply is used
145+
146+
-------------------------------------------------------------------------------
147+
148+
`-closeLabel VALUE`
149+
150+
The notification "Close" button label.
151+
152+
-------------------------------------------------------------------------------
153+
154+
`-timeout NUMBER`
155+
156+
Auto close the alert notification after NUMBER seconds.
157+
158+
-------------------------------------------------------------------------------
159+
160+
`-json`
161+
162+
Outputs the event as JSON.
163+
164+
-------------------------------------------------------------------------------
165+
107166
`-group ID`
108167

109168
Specifies the ‘group’ a notification belongs to. For any ‘group’ only _one_

0 commit comments

Comments
 (0)