Generate¶

Overview¶

The generate command creates a notification service URL by guiding the user through an interactive process or using provided properties. If no service is specified, the command displays the list of supported services and exits.

Usage¶

Generate Command Syntax

shoutrrr generate [FLAGS] [SERVICE] [GENERATOR] [GENERATOR ARGS...]

Flag	Description
`-g, --generator string`	Specifies the generator to use (e.g., `basic`, `oauth2`, `telegram`). Defaults to a service-specific generator if available, or `basic` otherwise.
`-p, --property stringArray`	Provides configuration properties in `key=value` format (e.g., `token=abc123`). Multiple properties can be specified by repeating the flag. Invalid properties are reported but ignored.
`-s, --service string`	Specifies the notification service to generate a URL for (e.g., `discord`, `smtp`, `telegram`). Can also be provided as a positional argument.
`-x, --show-sensitive`	Displays sensitive data (e.g., tokens, passwords) in the generated URL. By default, sensitive fields are masked with `REDACTED` for security.

Note

Positional arguments fill the SERVICE and then the GENERATOR, skipping any of them already given with -s or -g, so generate smtp oauth2 and generate -s smtp oauth2 both select the oauth2 generator. Any remaining arguments are passed to the generator, such as the credentials file for oauth2. If no generator is specified, a service-specific generator is used if available; otherwise, the basic generator is used. Flags can also be set with SHOUTRRR_ environment variables, as listed in the CLI overview.

Generators¶

Basic¶

The default generator that dynamically prompts for service configuration fields.

Inspects service struct tags (key, desc, default) to generate prompts, in alphabetical order of the field names.
Fails when a required field is left blank, or when input ends before a required field has a value.
Integrates with -p properties to skip prompts for prefilled fields. A property whose value is invalid is reported, and the field is prompted for instead.

Example

shoutrrr generate discord -g basic

OAuth2¶

Specialized generator for OAuth2 authentication in SMTP services.

Supports JSON credential files (specified as a positional argument after the service and generator) or interactive prompts for details like Client ID, Client Secret, and Auth URL. The gmail provider requires a credentials file.
Generates an authentication URL and exchanges verification codes for access tokens.
Configures Gmail-specific defaults (port 587, STARTTLS, sender email as FromAddress and ToAddresses).

Example

shoutrrr generate smtp oauth2 -p provider=gmail credentials.json

Telegram¶

Interactive generator tailored for Telegram bot and chat configuration.

Prompts for bot token (from @BotFather) and fetches bot info.
Listens for real-time messages to collect chat IDs (PMs, groups, channels).
Supports dynamic chat addition via user interaction.
Generates URL with token and selected chat IDs.

Example

shoutrrr generate telegram -g telegram

Properties¶

Properties prefill configuration fields, reducing or eliminating interactive prompts. For example, -p token=abc123 sets the token field without prompting.

Example

shoutrrr generate discord -p token=abc123

Services¶

Services like telegram and smtp (with oauth2) use specialized generators for a tailored experience, while others use the basic generator.

Example

shoutrrr generate -s discord

Show Sensitive¶

Use this flag to view the full URL, including sensitive fields like tokens or passwords, for debugging or verification.

Example

shoutrrr generate smtp oauth2 -x -p provider=gmail credentials.json

Examples¶

Generate a Telegram URL with the Telegram Generator¶

Example

shoutrrr generate telegram -g telegram

To start we need your bot token. If you haven't created a bot yet, you can use this link:
  https://t.me/botfather?start

Enter your bot token: 110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw
Fetching bot info...

Okay! @MyBot will listen for any messages in PMs and group chats it is invited to.
Waiting for messages to arrive...
Got Message 'Hello' from @User in private chat -100123456789
Added new chat User!
Got %0 chat ID(s) so far. Want to add some more? [Yes]: No

Cleaning up the bot session...
Selected chats:
  -100123456789 (private) User

URL: telegram://REDACTED@telegram?chats=REDACTED

Sensitive values are masked by default. Add -x to show the full URL.

Generate a Discord URL with the Basic Generator¶

Example

shoutrrr generate discord

Generating URL for discord using basic generator

Avatar:
Color[0x50D9ff]:
ColorDebug[0x7b00ab]:
ColorError[0xd60510]:
ColorInfo[0x2488ff]:
ColorWarn[0xffc441]:
JSON[No]:
SplitLines[Yes]:
ThreadID:
Title:
Token: abc123
Username:
WebhookID: 123456789

URL: discord://REDACTED@123456789?color=0x50d9ff

Generate an SMTP URL with the OAuth2 Generator for Gmail¶

Example

shoutrrr generate smtp oauth2 -p provider=gmail credentials.json

Generating URL for smtp using oauth2 generator

Visit the following URL to authenticate:
https://accounts.google.com/o/oauth2/auth?...
Enter verification code: 4/0AX4Xf...
Enter sender e-mail: [email protected]

URL: smtp://user%40example.com:[email protected]:587/?auth=OAuth2&[email protected]&[email protected]&fromname=Shoutrrr&usehtml=true&usestarttls=true