mirror of
https://github.com/caronc/apprise.git
synced 2025-08-07 15:39:21 +02:00
Updated CLI_Usage (markdown)
35
CLI_Usage.md
35
CLI_Usage.md
@ -36,10 +36,12 @@ apprise --help
|
||||
|
||||
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
|
||||
URLs the content provided within the title, body and notification-type.
|
||||
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
|
||||
@ -49,6 +51,23 @@ Options:
|
||||
specified then content is read from <stdin>.
|
||||
-t, --title TEXT Specify the message title. This field is
|
||||
complete optional.
|
||||
-P, --plugin-path PLUGIN_PATH Specify one or more plugin paths to scan.
|
||||
-S, --storage-path STORAGE_PATH
|
||||
Specify the path to the persistent storage
|
||||
location
|
||||
(default=~/.local/share/apprise/cache).
|
||||
-SPD, --storage-prune-days INTEGER
|
||||
Define the number of days the storage prune
|
||||
should run using. Setting this to zero (0)
|
||||
will eliminate all accumulated content. By
|
||||
default this value is 30 (days).
|
||||
-SUL, --storage-uid-length INTEGER
|
||||
Define the number of unique characters to
|
||||
store persistentcache in. By default this
|
||||
value is 6 (characters).
|
||||
-SM, --storage-mode MODE Persistent disk storage write mode
|
||||
(default=auto). Possible values are "auto",
|
||||
"flush", and "memory".
|
||||
-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).
|
||||
@ -75,12 +94,20 @@ Options:
|
||||
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 [x>=0]
|
||||
-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
|
||||
|
Reference in New Issue
Block a user