1APPRISE(1) APPRISE(1)
2
6 apprise - Push Notifications that work with just about every platform!
7
9 apprise [options...] service-url...
10
12 Apprise allows you to send a notification to almost all of the most
13 popular notification services available to us today such as: Discord,
14 Telegram, Pushbullet, Slack, Twitter, etc.
15 · One notification library to rule them all.
17 · A common and intuitive notification syntax.
19 · Supports the handling of images (to the notification services that
21 will accept them).
22
26 The Apprise options are as follows:
27 -b, --body=TEXT
29 Specify the message body. If no body is specified then content
30 is read from stdin.
31 -t, --title=TEXT
33 Specify the message title. This field is complete optional.
34 -c, --config=CONFIG-URL
36 Specify one or more configuration locations.
37 -a, --attach=ATTACH-URL
39 Specify one or more file attachment locations.
40 -n, --notification-type=TYPE
42 Specify the message type (default=info). Possible values are
43 "info", "success", "failure", and "warning".
44 -T, --theme=THEME
46 Specify the default theme.
47 -g, --tag=TAG
49 Specify one or more tags to filter which services to notify. Use
50 multiple --tag (-g) entries to OR the tags together and comma
51 separated to AND them. If no tags are specified then all ser‐
52 vices are notified.
53 -d, --dry-run
55 Perform a trial run but only prints the notification services
56 to-be triggered to stdout. Notifications are never sent using
57 this mode.
58 -v, --verbose
60 The more of these you specify, the more verbose the output is.
61 -V, --version
63 Display the apprise version and exit.
64 --help Show this message and exit.
66
68 apprise exits with a status 0 if all notifications were sent success‐
69 fully otherwise apprise returns a value of 1.
70 apprise exits with a status of 2 if there were no notifcations sent due
72 (as a result of end user actions). This occurs in the case where you
73 have assigned one or more tags to all of the Apprise URLs being noti‐
74 fied and did not match any when actually executing the apprise tool.
75 This can also occur if you specified a tag that has not been assigned
76 to anything defined in your configuration.
77
79 There are to many service URL and combinations to list here. It´s best
80 to visit the Apprise GitHub page
81 https://github.com/caronc/apprise/wiki#notification-services and see
82 what´s available.
83
85 Send a notification to as many servers as you want to specify as you
86 can easily chain them together:
87 $ apprise -t ´my title´ -b ´my notification body´ \
91 ´mailto://myemail:mypass@gmail.com´ \
92 ´pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b´
93 If you don´t specify a --body (-b) then stdin is used allowing you to
97 use the tool as part of your every day administration:
98 $ cat /proc/cpuinfo | apprise -t ´cpu info´ \
102 ´mailto://myemail:mypass@gmail.com´
103 Load in a configuration file which identifies all of your notification
107 service URLs and notify them all:
108 $ apprise -t ´my title´ -b ´my notification body´ \
112 --config=~/apprise.yml
113 Load in a configuration file from a remote server that identifies all
117 of your notification service URLs and only notify the ones tagged as
118 devops.
119 $ apprise -t ´my title´ -b ´my notification body´ \
123 --config=https://localhost/my/apprise/config \
124 -t devops
125 Include an attachment:
129 $ apprise -t ´School Assignment´ -b ´See attached´ \
133 --attach=Documents/FinalReport.docx
134
138 Apprise is written in Python with 100% test coverage; but it still
139 makes it far from perfect since the notification services it talks to
140 change all the time. If you find any bugs, please make them known at:
141 https://github.com/caronc/apprise/issues
142
144 Apprise is Copyright (C) 2020 Chris Caron lead2gold@gmail.com
145 January 2020 APPRISE(1)