telegram

Configure the Telegram bot integration from the CLI.

Manage the Telegram bot configuration. This sets up the credentials that the Telegram bot uses to connect.

circle-info

This command configures the bot credentials. To learn about setting up and running the bot itself, see the Telegram Setup Guide.


Subcommands

telegram setup

Interactive setup for the Telegram bot credentials:

locus telegram setup

Or non-interactively:

locus telegram setup --token "123456:ABC..." --chat-id 987654321
Flag
Description

--token <TOKEN>

--chat-id <ID>

Numeric Telegram chat ID


telegram config

Display the current Telegram configuration (secrets masked):

locus telegram config

telegram set

Update a specific Telegram setting:

Key
Description

botToken

Telegram bot token

chatId

Telegram chat ID

testMode

Enable test mode (true / false)


telegram remove

Remove all Telegram configuration:


Configuration Storage

Telegram settings are stored in .locus/settings.json under the telegram key:

Last updated