github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated CLI_Usage (markdown)

master
Chris Caron 2019-10-01 17:41:41 -04:00
parent 4ceda4c7d7
commit 399ffb32bf
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
CLI_Usage.md

@ -5,20 +5,20 @@ This small tool wraps the apprise python library to allow individuals such as De
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. 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 ```bash
# Set a notification to a hotmail (email) account: # Set a notification to a hotmail (email) account:
python apprise --body="My Message" mailto://user:password@hotmail.com apprise --body="My Message" mailto://user:password@hotmail.com
``` ```
If you don't specify a **--body** (**-b**) then Apprise reads from **stdin** instead: If you don't specify a **--body** (**-b**) then Apprise reads from **stdin** instead:
```bash ```bash
# without a --body, you can use a pipe | to redirect output # without a --body, you can use a pipe | to redirect output
# into you're notification: # into you're notification:
uptime | python apprise mailto://user:password@hotmail.com uptime | 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: There is no limit to the number of services you want to notify, just keep adding/chaining them one after another:
```bash ```bash
# Set a notification to a yahoo email account, Slack, and a Kodi Server: # Set a notification to a yahoo email account, Slack, and a Kodi Server:
python apprise --body="Notify more than one service" \ apprise --body="Notify more than one service" \
mailto://user:password@yahoo.com \ mailto://user:password@yahoo.com \
slack://token_a/token_b/token_c \ slack://token_a/token_b/token_c \
kodi://example.com kodi://example.com
@ -38,7 +38,7 @@ kodi://example.com
Then you can notify all of your services like so: Then you can notify all of your services like so:
```bash ```bash
# Set a notification to a yahoo email account, Slack, and a Kodi Server: # Set a notification to a yahoo email account, Slack, and a Kodi Server:
python apprise --body="Notify more than one service" \ apprise --body="Notify more than one service" \
--config=/path/to/your/apprise/config.txt --config=/path/to/your/apprise/config.txt
``` ```
@ -53,7 +53,7 @@ If you stick your configuration in the right locations, you don't even need to r
With default configuration file(s) in place, reference to the Apprise CLI gets even easier: With default configuration file(s) in place, reference to the Apprise CLI gets even easier:
```bash ```bash
# Set a notification to a yahoo email account, Slack, and a Kodi Server: # Set a notification to a yahoo email account, Slack, and a Kodi Server:
python apprise --body="Notify all of my services" apprise --body="Notify all of my services"
``` ```
### :label: Leverage Tagging ### :label: Leverage Tagging
@ -104,12 +104,12 @@ Now there is a lot to ingest from the configuration above, but it will make more
```bash ```bash
# This would notify the first 2 entries they have the tag `family` # This would notify the first 2 entries they have the tag `family`
# It would 'NOT' send to any other entry defined # It would 'NOT' send to any other entry defined
python apprise --body="Hi guys, I'm going to be late getting home tonight" \ apprise --body="Hi guys, I'm going to be late getting home tonight" \
--tag=family --tag=family
# This would only notify the first entry as it is the only one # This would only notify the first entry as it is the only one
# that has the tag: me # that has the tag: me
python apprise --body="Don't forget to buy eggs!" \ apprise --body="Don't forget to buy eggs!" \
--tag=me --tag=me
``` ```
@ -117,7 +117,7 @@ If you're building software, you can set up your continuous integration to notif
```bash ```bash
# notify the services that have either a `devops` or `team` tag # notify the services that have either a `devops` or `team` tag
# If you check our our configuration; this matches 3 separate URLs # If you check our our configuration; this matches 3 separate URLs
python apprise --title="Apprise Build" \ apprise --title="Apprise Build" \
--body="Build was a success!" \ --body="Build was a success!" \
--tag=devops --tag=team --tag=devops --tag=team
``` ```
@ -127,7 +127,7 @@ If you identify more than one element on the same **--tag** using a space and/or
```bash ```bash
# notify only the services that have both a team and email tag # notify only the services that have both a team and email tag
# In this example, there is only one match. # In this example, there is only one match.
python apprise --title="Meeting this Friday" \ apprise --title="Meeting this Friday" \
--body="Guys, there is a meeting this Friday with our director." \ --body="Guys, there is a meeting this Friday with our director." \
--tag=team,email --tag=team,email
``` ```
@ -137,12 +137,12 @@ There is a special reserved tag called `all`. `all` will match ALL of your entr
Here is another way of looking at it: Here is another way of looking at it:
```bash ```bash
# assuming you got your configuration in place; tagging works like so: # assuming you got your configuration in place; tagging works like so:
notify -b "has TagA" --tag=TagA apprise -b "has TagA" --tag=TagA
notify -b "has TagA OR TagB" --tag=TagA --tag=TagB apprise -b "has TagA OR TagB" --tag=TagA --tag=TagB
# For each item you group with the same --tag value is AND'ed # For each item you group with the same --tag value is AND'ed
notify -b "has TagA AND TagB" --tag="TagA, TagB" apprise -b "has TagA AND TagB" --tag="TagA, TagB"
notify -b "has (TagA AND TagB) OR TagC" --tag="TagA, TagB" --tag=TagC apprise -b "has (TagA AND TagB) OR TagC" --tag="TagA, TagB" --tag=TagC
``` ```
### Testing Configuration and Tags ### Testing Configuration and Tags
@ -150,7 +150,7 @@ Once you've built your elaborate configuration file and assigned all your tags.
```bash ```bash
# Test which services would have been notified if the tags team and email # Test which services would have been notified if the tags team and email
# were activated: # were activated:
python apprise --title="Meeting this Friday" \ apprise --title="Meeting this Friday" \
--body="Guys, there is a meeting this Friday with our director." \ --body="Guys, there is a meeting this Friday with our director." \
--tag=team,email \ --tag=team,email \
--dry-run --dry-run
@ -160,7 +160,7 @@ If you use the **--dry-run** (**-d**) switch, then some rules don't apply. For o
```bash ```bash
# Test which services would have been notified if the tags team and email # Test which services would have been notified if the tags team and email
# were activated: # were activated:
python apprise --tag=team,email --dry-run apprise --tag=team,email --dry-run
``` ```
Happy notifying! Happy notifying!