extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2025-03-03 09:31:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated CLI_Usage (markdown)

Chris Caron 2024-08-23 17:17:09 -04:00
parent 8863ccd024
commit 54461ef416
1 changed files with 68 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

109
CLI_Usage.md

@ -36,51 +36,78 @@ apprise --help
The switches/options are as follows: The switches/options are as follows:
``` ```
Usage: apprise [OPTIONS] SERVER_URL [SERVER_URL2 [SERVER_URL3]] Usage:
apprise [OPTIONS] [APPRISE_URL [APPRISE_URL2 [APPRISE_URL3]]]
apprise storage [OPTIONS] [ACTION] [UID1 [UID2 [UID3]]]
Send a notification to all of the specified servers identified by their Send a notification to all of the specified servers identified by their URLs
URLs the content provided within the title, body and notification-type. 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 For a list of all of the supported services and information on how to use
them, check out at https://github.com/caronc/apprise them, check out at https://github.com/caronc/apprise
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. -P, --plugin-path PLUGIN_PATH Specify one or more plugin paths to scan.
-a, --attach ATTACHMENT_URL Specify one or more attachment. -S, --storage-path STORAGE_PATH
-n, --notification-type TYPE Specify the message type (default=info). Specify the path to the persistent storage
Possible values are "info", "success", location
"warning", and "failure". (default=~/.local/share/apprise/cache).
-i, --input-format FORMAT Specify the message input format -SPD, --storage-prune-days INTEGER
(default=text). Possible values are "text", Define the number of days the storage prune
"html", and "markdown". should run using. Setting this to zero (0)
-T, --theme THEME Specify the default theme. will eliminate all accumulated content. By
-g, --tag TAG Specify one or more tags to filter which default this value is 30 (days).
services to notify. Use multiple --tag (-g) -SUL, --storage-uid-length INTEGER
entries to "OR" the tags together and comma Define the number of unique characters to
separated to "AND" them. If no tags are store persistentcache in. By default this
specified then all services are notified. value is 6 (characters).
-Da, --disable-async Send all notifications sequentially -SM, --storage-mode MODE Persistent disk storage write mode
-d, --dry-run Perform a trial run but only prints the (default=auto). Possible values are "auto",
notification services to-be triggered to "flush", and "memory".
stdout. Notifications are never sent using -c, --config CONFIG_URL Specify one or more configuration locations.
this mode. -a, --attach ATTACHMENT_URL Specify one or more attachment.
-l, --details Prints details about the current services -n, --notification-type TYPE Specify the message type (default=info).
supported by Apprise. Possible values are "info", "success",
-R, --recursion-depth INTEGER The number of recursive import entries that "warning", and "failure".
can be loaded from within Apprise -i, --input-format FORMAT Specify the message input format
configuration. By default this is set to 1. (default=text). Possible values are "text",
-v, --verbose Makes the operation more talkative. Use "html", and "markdown".
multiple v to increase the verbosity. I.e.: -T, --theme THEME Specify the default theme.
-vvvv [x>=0] -g, --tag TAG Specify one or more tags to filter which
-e, --interpret-escapes Enable interpretation of backslash escapes services to notify. Use multiple --tag (-g)
-j, --interpret-emojis Enable interpretation of :emoji: definitions entries to "OR" the tags together and comma
-D, --debug Debug mode separated to "AND" them. If no tags are
-V, --version Display the apprise version and exit. specified then all services are notified.
-h, --help Show this message and exit. -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
-e, --interpret-escapes Enable interpretation of backslash escapes
-j, --interpret-emojis Enable interpretation of :emoji: definitions
-D, --debug Debug mode
-V, --version Display the apprise version and exit.
-h, --help Show this message and exit.
Actions:
storage Access the persistent storage disk administration
list List all URL IDs associated with detected URL(s). This
is also the default action ran if nothing is provided
prune Eliminates stale entries found based on --storage-prune-
days (-SPD)
clean Removes any persistent data created by Apprise
``` ```
#### File Based Configuration #### File Based Configuration