| 1 |
# Overview |
| 2 |
|
| 3 |
Shoutrrr can be used via the CLI to both generate and verify service notification URL's, in addition to sending notifications. |
| 4 |
|
| 5 |
```bash title="Shoutrrr run without arguments" |
| 6 |
shoutrrr |
| 7 |
``` |
| 8 |
|
| 9 |
```text title="Expected Output" |
| 10 |
Shoutrrr CLI |
| 11 |
|
| 12 |
Usage: |
| 13 |
shoutrrr [command] |
| 14 |
|
| 15 |
Available Commands: |
| 16 |
completion Generate the autocompletion script for the specified shell |
| 17 |
docs Print documentation for services |
| 18 |
generate Generates a notification service URL from user input |
| 19 |
help Help about any command |
| 20 |
send Send a notification using a service url |
| 21 |
verify Verify the validity of a notification service URL |
| 22 |
|
| 23 |
Flags: |
| 24 |
-h, --help help for shoutrrr |
| 25 |
-v, --version version for shoutrrr |
| 26 |
|
| 27 |
Use "shoutrrr [command] --help" for more information about a command. |
| 28 |
``` |