Debian Codegraph @

docs/usage/cli/verify/index.md

raw
1 # Verify
2
3 ## Overview
4
5 The `verify` command checks the validity of a notification service URL.
6
7 ## Usage
8
9 ```bash title="Verify Command Syntax"
10 shoutrrr verify [FLAGS]
11 ```
12
13 | Flag | Description |
14 |---------------------|-------------------------------------------------------|
15 | `-h, --help` | Displays help for the `verify` command. |
16 | `-u, --url string` | Specifies the notification service URL to verify. |
17
18 !!! Note
19 The `--url` flag is required. The command validates the URL format and service configuration, reporting errors for issues like unknown services or invalid URL formats.
20
21 ### URL
22
23 - Specifies the service URL to validate. The URL is parsed to identify the service, and its configuration is checked for correctness.
24
25 ## Examples
26
27 <!-- markdownlint-disable -->
28 ### Verify a Valid Discord URL
29
30 !!! Example
31 ```bash title="Verify Discord URL"
32 shoutrrr verify --url "discord://abc123@123456789"
33 ```
34
35 ```text title="Expected Output"
36 Token: abc123
37 WebhookID: 123456789
38 ```
39
40 ### Verify an Invalid URL
41
42 !!! Example
43 ```bash title="Verify Invalid URL"
44 shoutrrr verify --url "invalid://abc123"
45 ```
46
47 ```text title="Expected Output"
48 error verifying URL: service not recognized
49 ```
50
51 ### Verify a Malformed URL
52
53 !!! Example
54 ```bash title="Verify Malformed URL"
55 shoutrrr verify --url "discord://"
56 ```
57
58 ```text title="Expected Output"
59 error verifying URL: invalid URL format
60 ```
61 <!-- markdownlint-restore -->