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: Specify the message body. If no body is specified then
29 content is read from stdin.
30 -t, --title=TEXT: Specify the message title. This field is complete
32 optional.
33 -c, --config=CONFIG-URL: Specify one or more configuration locations.
35 -a, --attach=ATTACH-URL: Specify one or more file attachment locations.
37 -n, --notification-type=TYPE: Specify the message type (default=info).
39 Possible values are "info", "success", "failure", and "warning".
40 -i, --input-format=FORMAT: Specify the input message format
42 (default=text). Possible values are "text", "html", and "markdown".
43 -T, --theme=THEME: Specify the default theme.
45 -g, --tag=TAG: Specify one or more tags to filter which services to
47 notify. Use multiple --tag (-g) entries to OR the tags together and
48 comma separated to AND them. If no tags are specified then all services
49 are notified.
50 -Da, --disable-async: Send notifications synchronously (one after the
52 other) instead of all at once.
53 -R, --recursion-depth: he number of recursive import entries that can
55 be loaded from within Apprise configuration. By default this is set to
56 1. If this is set to zero, then import statements found in any configu‐
57 ration is ignored.
58 -e, --interpret-escapes Enable interpretation of backslash escapes. For
60 example, this would convert sequences such as \n and \r to their
61 respected ascii new-line and carriage
62 -d, --dry-run: Perform a trial run but only prints the notification
64 services to-be triggered to stdout. Notifications are never sent using
65 this mode.
66 return characters prior to the delivery of the notification.
68 -v, --verbose: The more of these you specify, the more verbose the out‐
70 put is. e.g: -vvvv
71 -D, --debug: A debug mode; useful for troubleshooting.
73 -V, --version: Display the apprise version and exit.
75 -h, --help: Show this message and exit.
77
79 apprise exits with a status of:
80 · 0 if all of the notifications were sent successfully.
82 · 1 if one or more notifications could not be sent.
84 · 2 if there was an error specified on the command line such as not
86 providing an valid argument.
87 · 3 if there was one or more Apprise Service URLs successfully loaded
89 but none could be notified due to user filtering (via tags).
90
94 There are to many service URL and combinations to list here. It´s best
95 to visit the Apprise GitHub page
96 https://github.com/caronc/apprise/wiki#notification-services and see
97 what´s available.
98
100 Send a notification to as many servers as you want to specify as you
101 can easily chain them together:
102 $ apprise -vv -t "my title" -b "my notification body" \
106 "mailto://myemail:mypass@gmail.com" \
107 "pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b"
108 If you don´t specify a --body (-b) then stdin is used allowing you to
112 use the tool as part of your every day administration:
113 $ cat /proc/cpuinfo | apprise -vv -t "cpu info" \
117 "mailto://myemail:mypass@gmail.com"
118 Load in a configuration file which identifies all of your notification
122 service URLs and notify them all:
123 $ apprise -vv -t "my title" -b "my notification body" \
127 --config=~/apprise.yml
128 Load in a configuration file from a remote server that identifies all
132 of your notification service URLs and only notify the ones tagged as
133 devops.
134 $ apprise -vv -t "my title" -b "my notification body" \
138 --config=https://localhost/my/apprise/config \
139 -t devops
140 Include an attachment:
144 $ apprise -vv -t "School Assignment" -b "See attached" \
148 --attach=Documents/FinalReport.docx
149
153 A configuration file can be in the format of either TEXT or YAML where
154 [TEXT][textconfig] is the easiest and most ideal solution for most
155 users. However YAML https://github.com/caronc/apprise/wiki/config_yaml
156 configuration files grants the user a bit more leverage and access to
157 some of the internal features of Apprise. Reguardless of which format
158 you choose, both provide the users the ability to leverage tagging
159 which adds a more rich and powerful notification environment.
160 Configuration files can be directly referenced via apprise when refer‐
162 encing the --config= (-c) CLI directive. You can identify as many as
163 you like on the command line and all of them will be loaded. You can
164 also point your configuration to a cloud location (by referencing
165 http:// or https://. By default apprise looks in the following local
166 locations for configuration files and loads them:
167 $ ~/.apprise
171 $ ~/.apprise.yml
172 $ ~/.config/apprise
173 $ ~/.config/apprise.yml
174 If a default configuration file is referenced in any way by the apprise
178 tool, you no longer need to provide it a Service URL. Usage of the
179 apprise tool simplifies to:
180 $ apprise -vv -t "my title" -b "my notification body"
184 If you leveraged tagging
188 https://github.com/caronc/apprise/wiki/CLI_Usage#label-leverage-tag‐
189 ging, you can define all of Apprise Service URLs in your configuration
190 that you want and only specifically notify a subset of them:
191 $ apprise -vv -t "Will Be Late" -b "Go ahead and make dinner without me" \
195 --tag=family
196
200 If you find any bugs, please make them known at:
201 https://github.com/caronc/apprise/issues
202
204 Apprise is Copyright (C) 2021 Chris Caron lead2gold@gmail.com
205ff February 2021 APPRISE(1)