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

Updated CLI_Usage (markdown)

Chris Caron 2021-12-02 10:34:02 -05:00
parent 3d43481012
commit 94d1c51a51
1 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
CLI_Usage.md

@ -47,41 +47,35 @@ Usage: apprise [OPTIONS] SERVER_URL [SERVER_URL2 [SERVER_URL3]]
Options: Options:
-b, --body TEXT Specify the message body. If no body is -b, --body TEXT Specify the message body. If no body is
specified then content is read from <stdin>. specified then content is read from <stdin>.
-t, --title TEXT Specify the message title. This field is -t, --title TEXT Specify the message title. This field is
complete optional. complete optional.
-c, --config CONFIG_URL Specify one or more configuration locations. -c, --config CONFIG_URL Specify one or more configuration locations.
-a, --attach ATTACHMENT_URL Specify one or more attachment. -a, --attach ATTACHMENT_URL Specify one or more attachment.
-n, --notification-type TYPE Specify the message type (default=info). -n, --notification-type TYPE Specify the message type (default=info).
Possible values are "info", "success", Possible values are "info", "success",
"warning", and "failure". "warning", and "failure".
-i, --input-format FORMAT Specify the message input format -i, --input-format FORMAT Specify the message input format
(default=text). Possible values are "text", (default=text). Possible values are "text",
"html", and "markdown". "html", and "markdown".
-T, --theme THEME Specify the default theme. -T, --theme THEME Specify the default theme.
-g, --tag TAG Specify one or more tags to filter which -g, --tag TAG Specify one or more tags to filter which
services to notify. Use multiple --tag (-g) services to notify. Use multiple --tag (-g)
entries to "OR" the tags together and comma entries to "OR" the tags together and comma
separated to "AND" them. If no tags are separated to "AND" them. If no tags are
specified then all services are notified. specified then all services are notified.
-Da, --disable-async Send all notifications sequentially -Da, --disable-async Send all notifications sequentially
-d, --dry-run Perform a trial run but only prints the -d, --dry-run Perform a trial run but only prints the
notification services to-be triggered to notification services to-be triggered to
stdout. Notifications are never sent using stdout. Notifications are never sent using
this mode. this mode.
-l, --details Prints details about the current services
supported by Apprise.
-R, --recursion-depth INTEGER The number of recursive import entries that -R, --recursion-depth INTEGER The number of recursive import entries that
can be loaded from within Apprise can be loaded from within Apprise
configuration. By default this is set to 1. configuration. By default this is set to 1.
-v, --verbose Makes the operation more talkative. Use -v, --verbose Makes the operation more talkative. Use
multiple v to increase the verbosity. I.e.: multiple v to increase the verbosity. I.e.:
-vvvv -vvvv [x>=0]
-e, --interpret-escapes Enable interpretation of backslash escapes -e, --interpret-escapes Enable interpretation of backslash escapes
-D, --debug Debug mode -D, --debug Debug mode
-V, --version Display the apprise version and exit. -V, --version Display the apprise version and exit.
@ -250,7 +244,18 @@ If you use the **--dry-run** (**-d**) switch, then some rules don't apply. For o
apprise --tag=team,email --dry-run apprise --tag=team,email --dry-run
``` ```
### :baggage_claim: Message Body Source ## :heavy_check_mark: Compatibility and Notification Details
Apprise offers a lot of services at your fingertips, but some of them may or may not be available to you depending on your Operating system and/or what packages you have installed. You can see a list of what is available by doing the following:
```bash
# List all of the supported services available to you
# you can also use -l as well:
apprise --details
```
Here is an example of the output (as it is now) on the CLI:
![image](https://user-images.githubusercontent.com/850374/142778418-11e87c7f-1b07-4314-ab86-cbf8d268dabf.png)
## :baggage_claim: Message Body Source
The Apprise CLI doesn't know what you are feeding it when sending a message to a Notification provider. It just assumes that whatever you message you feed it, it should just pass it along *as is* to the upstream provider *as text*. In most cases, this is perfect and this is the default behaviour. If you are passing along HTML content or markdown content, you should just let Apprise know by specifying the `--input-format` (`-i`) switch. For example: The Apprise CLI doesn't know what you are feeding it when sending a message to a Notification provider. It just assumes that whatever you message you feed it, it should just pass it along *as is* to the upstream provider *as text*. In most cases, this is perfect and this is the default behaviour. If you are passing along HTML content or markdown content, you should just let Apprise know by specifying the `--input-format` (`-i`) switch. For example:
```bash ```bash
# An HTML Example: # An HTML Example: