1APPRISE(1)                                                          APPRISE(1)
2
3
4

NAME

6       apprise - Push Notifications that work with just about every platform!
7

SYNOPSIS

9       apprise [options...] service-url...
10

DESCRIPTION

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
16       ·   One notification library to rule them all.
17
18       ·   A common and intuitive notification syntax.
19
20       ·   Supports  the handling of images (to the notification services that
21           will accept them).
22
23
24

OPTIONS

26       The Apprise options are as follows:
27
28       -b, --body=TEXT
29              Specify the message body. If no body is specified  then  content
30              is read from stdin.
31
32       -t, --title=TEXT
33              Specify the message title. This field is complete optional.
34
35       -c, --config=CONFIG-URL
36              Specify one or more configuration locations.
37
38       -n, --notification-type=TYPE
39              Specify  the  message  type  (default=info). Possible values are
40              "info", "success", "failure", and "warning".
41
42       -T, --theme=THEME
43              Specify the default theme.
44
45       -g, --tag=TAG
46              Specify one or more tags to filter which services to notify. Use
47              multiple  --tag  (-g)  entries to OR the tags together and comma
48              separated to AND them. If no tags are specified  then  all  ser‐
49              vices are notified.
50
51       -v, --verbose
52              The more of these you specify, the more verbose the output is.
53
54       -V, --version
55              Display the apprise version and exit.
56
57       --help Show this message and exit.
58

SERVICE URLS

60       There  are to many service URL and combinations to list here. It´s best
61       to visit the Apprise GitHub page https://github.com/caronc/apprise  and
62       see what´s available.
63

EXAMPLES

65       Send  a  notification  to as many servers as you want to specify as you
66       can easily chain them together:
67
68
69
70           $ apprise -t ´my title´ -b ´my notification body´ \
71              ´mailto://myemail:mypass@gmail.com´ \
72              ´pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b´
73
74
75
76       If you don´t specify a --body (-b) then stdin is used allowing  you  to
77       use the tool as part of your every day administration:
78
79
80
81           $ cat /proc/cpuinfo | apprise -t ´cpu info´ \
82               ´mailto://myemail:mypass@gmail.com´
83
84
85
86       Load  in a configuration file which identifies all of your notification
87       service URLs and notify them all:
88
89
90
91           $ apprise -t ´my title´ -b ´my notification body´ \
92              --config=~/apprise.yml
93
94
95
96       Load in a configuration file from a remote server that  identifies  all
97       of  your  notification  service URLs and only notify the ones tagged as
98       devops.
99
100
101
102           $ apprise -t ´my title´ -b ´my notification body´ \
103              --config=https://localhost/my/apprise/config \
104              -t devops
105
106
107

BUGS

109       Apprise is written in Python with 100%  test  coverage;  but  it  still
110       makes  it  far from perfect since the notification services it talks to
111       change all the time. If you find any bugs, please make them  known  at:
112       https://github.com/caronc/apprise/issues
113

115       Apprise is Copyright (C) 2019 Chris Caron lead2gold@gmail.com
116
117
118
119                                  March 2019                        APPRISE(1)
Impressum