extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-13 10:21:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

Created CLI_Usage (markdown)

Chris Caron 2019-09-30 12:56:14 -04:00
parent 8a145cc997
commit afc8f2289d
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
CLI_Usage.md Normal file

@ -0,0 +1,25 @@
## Apprise CLI
This small tool wraps the apprise python library to allow individuals such as Developers, DevOps, and Administrators to send notifications from the command line.
Apprise in it's most basic form requires that you provide it a message and an Apprise URL which contains enough information to send the notification with.
```bash
# Set a notification to a hotmail (email) account:
python apprise --body="My Message" mailto://user:password@hotmail.com
```
If you don't specify a **--body** (**-b**) then Apprise reads from **stdin** instead:
```bash
# without a --body, you can use a pipe | to redirect output
# into you're notification:
uptime | python apprise mailto://user:password@hotmail.com
```
There is no limit to the number of services you want to notify, just keep adding/chaining them one after another:
```bash
# Set a notification to a yahoo email account, Slack, and a Kodi Server:
python apprise --body="Notify more than one service" \
mailto://user:password@yahoo.com \
slack://token_a/token_b/token_c \
kodi://example.com
```