extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2025-08-09 16:35:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated CLI_Usage (markdown)

Chris Caron
2019-10-01 14:48:53 -04:00
parent a51f16e99b
commit 4ceda4c7d7
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
CLI_Usage.md

@ -72,6 +72,9 @@ Apprise makes this easy by simply allowing you to tag your URLs. There is no li
# Syntax: <tags>=<url> # Syntax: <tags>=<url>
# Here we set up a mailto:// URL and assign it the tags: me, and family # Here we set up a mailto:// URL and assign it the tags: me, and family
# maybe we are doing this to just identify our personal email and
# additionally tag ourselves with the family (which we will tag elsewhere
# too)
me,family=mailto://user:password@yahoo.com me,family=mailto://user:password@yahoo.com
# Here we set up a mailto:// URL and assign it the tag: family # Here we set up a mailto:// URL and assign it the tag: family
@ -99,21 +102,19 @@ mytv=kodi://example.com
Now there is a lot to ingest from the configuration above, but it will make more sense when you see how the content is referenced. Here are a few examples (based on config above): Now there is a lot to ingest from the configuration above, but it will make more sense when you see how the content is referenced. Here are a few examples (based on config above):
```bash ```bash
# Send an alert to yourself and your spouse; this would trigger # This would notify the first 2 entries they have the tag `family`
# the first 2 entries because 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" \ python apprise --body="Hi guys, I'm going to be late getting home tonight" \
--tag=family --tag=family
# This would just send yourself an email: # This would only notify the first entry as it is the only one
# that has the tag: me
python apprise --body="Don't forget to buy eggs!" \ python apprise --body="Don't forget to buy eggs!" \
--tag=me --tag=me
``` ```
If you're building software, you can set up your continuous integration to notify your `team` AND `devops` by simply identifying 2 tags: If you're building software, you can set up your continuous integration to notify your `team` AND `devops` by simply identifying 2 tags:
```bash ```bash
# This would just send yourself an email:
```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" \ python apprise --title="Apprise Build" \