File: index.md

package info (click to toggle)
golang-github-nicholas-fedor-shoutrrr 0.8.17-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,332 kB
  • sloc: sh: 61; makefile: 5
file content (42 lines) | stat: -rw-r--r-- 1,273 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# Help

## Overview

The `help` command provides general information about available commands for the Shoutrrr CLI.

## Usage

```bash title="Help Command Syntax"
shoutrrr help
```

| Flag            | Description                                               |
|-----------------|-----------------------------------------------------------|
| `-h, --help`    | Displays help for the Shoutrrr CLI or a specific command. |
| `-v, --version` | Displays the Shoutrrr version information.                |

## Example

<!-- markdownlint-disable -->
!!! Example
    ```bash title="General Help Command"
    shoutrrr help
    ```

    ```text title="Expected Output"
    Shoutrrr CLI
    Usage:
      shoutrrr [command]
    Available Commands:
      completion Generate the autocompletion script for the specified shell
      docs Print documentation for services
      generate Generates a notification service URL from user input
      help Help about any command
      send Send a notification using a service url
      verify Verify the validity of a notification service URL
    Flags:
      -h, --help help for shoutrrr
      -v, --version version for shoutrrr
    Use "shoutrrr [command] --help" for more information about a command.
    ```
<!-- markdownlint-restore -->