Debian Codegraph @

docs/usage/cli/help/index.md

raw
1 # Help
2
3 ## Overview
4
5 The `help` command provides general information about available commands for the Shoutrrr CLI.
6
7 ## Usage
8
9 ```bash title="Help Command Syntax"
10 shoutrrr help
11 ```
12
13 | Flag | Description |
14 |-----------------|-----------------------------------------------------------|
15 | `-h, --help` | Displays help for the Shoutrrr CLI or a specific command. |
16 | `-v, --version` | Displays the Shoutrrr version information. |
17
18 ## Example
19
20 <!-- markdownlint-disable -->
21 !!! Example
22 ```bash title="General Help Command"
23 shoutrrr help
24 ```
25
26 ```text title="Expected Output"
27 Shoutrrr CLI
28 Usage:
29 shoutrrr [command]
30 Available Commands:
31 completion Generate the autocompletion script for the specified shell
32 docs Print documentation for services
33 generate Generates a notification service URL from user input
34 help Help about any command
35 send Send a notification using a service url
36 verify Verify the validity of a notification service URL
37 Flags:
38 -h, --help help for shoutrrr
39 -v, --version version for shoutrrr
40 Use "shoutrrr [command] --help" for more information about a command.
41 ```
42 <!-- markdownlint-restore -->