From 94d1c51a51baae72841ffe0718b9081038b46673 Mon Sep 17 00:00:00 2001 From: Chris Caron Date: Thu, 2 Dec 2021 10:34:02 -0500 Subject: [PATCH] Updated CLI_Usage (markdown) --- CLI_Usage.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/CLI_Usage.md b/CLI_Usage.md index c771b75..c009986 100644 --- a/CLI_Usage.md +++ b/CLI_Usage.md @@ -47,41 +47,35 @@ Usage: apprise [OPTIONS] SERVER_URL [SERVER_URL2 [SERVER_URL3]] Options: -b, --body TEXT Specify the message body. If no body is specified then content is read from . - -t, --title TEXT Specify the message title. This field is complete optional. - -c, --config CONFIG_URL Specify one or more configuration locations. -a, --attach ATTACHMENT_URL Specify one or more attachment. -n, --notification-type TYPE Specify the message type (default=info). Possible values are "info", "success", "warning", and "failure". - -i, --input-format FORMAT Specify the message input format (default=text). Possible values are "text", "html", and "markdown". - -T, --theme THEME Specify the default theme. -g, --tag TAG Specify one or more tags to filter which services to notify. Use multiple --tag (-g) entries to "OR" the tags together and comma separated to "AND" them. If no tags are specified then all services are notified. - -Da, --disable-async Send all notifications sequentially -d, --dry-run Perform a trial run but only prints the notification services to-be triggered to stdout. Notifications are never sent using this mode. - + -l, --details Prints details about the current services + supported by Apprise. -R, --recursion-depth INTEGER The number of recursive import entries that can be loaded from within Apprise configuration. By default this is set to 1. - -v, --verbose Makes the operation more talkative. Use multiple v to increase the verbosity. I.e.: - -vvvv - + -vvvv [x>=0] -e, --interpret-escapes Enable interpretation of backslash escapes -D, --debug Debug mode -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 ``` -### :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: ```bash # An HTML Example: