From 18bc2bf7838edfae06f4ea1b8da4227416543b54 Mon Sep 17 00:00:00 2001 From: Chris Caron Date: Sun, 19 Sep 2021 00:02:31 -0400 Subject: [PATCH] Updated CLI_Usage (markdown) --- CLI_Usage.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) diff --git a/CLI_Usage.md b/CLI_Usage.md index 0a91b6b..c771b75 100644 --- a/CLI_Usage.md +++ b/CLI_Usage.md @@ -27,6 +27,67 @@ apprise -vv --body="Notify more than one service" \ kodi://example.com ``` +#### CLI Switches and Options +All of the switches and options available to you can be presented by adding `--help` (`-h`) to the command line: +```bash +# Print all of the help information: +apprise --help +``` + +The switches/options are as follows: +``` +Usage: apprise [OPTIONS] SERVER_URL [SERVER_URL2 [SERVER_URL3]] + + Send a notification to all of the specified servers identified by their + URLs the content provided within the title, body and notification-type. + + For a list of all of the supported services and information on how to use + them, check out at https://github.com/caronc/apprise + +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. + + -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 + + -e, --interpret-escapes Enable interpretation of backslash escapes + -D, --debug Debug mode + -V, --version Display the apprise version and exit. + -h, --help Show this message and exit. +``` + #### File Based Configuration Ideally it's never safe to store your personal details on the command line; others might see it! So the best thing to do is stick your configuration into a simple [[configuration file|config]]. With respect to the above example, maybe your file will look like this: ```apache