Skip to main content
The channels command manages connected messaging platforms including Telegram, Discord, Slack, Signal, WhatsApp, and more.

channels list

List configured channels and auth profiles.
simpleclaw channels list
--no-usage
boolean
Skip model provider usage/quota snapshots
--json
boolean
Output JSON

channels status

Show gateway channel status (use status --deep for local status).
simpleclaw channels status
--probe
boolean
Probe channel credentials
--timeout
number
Timeout in milliseconds (default: 10000)
--json
boolean
Output JSON
Example:
simpleclaw channels status --probe

channels capabilities

Show provider capabilities (intents/scopes and supported features).
simpleclaw channels capabilities
--channel
string
Channel name (or all)
--account
string
Account id (only with --channel)
--target
string
Channel target for permission audit (e.g., Discord channel:<id>)
--timeout
number
Timeout in milliseconds (default: 10000)
--json
boolean
Output JSON

channels resolve

Resolve channel/user names to IDs.
simpleclaw channels resolve <entries...>
entries
string[]
required
Entries to resolve (names or ids)
--channel
string
Channel name
--account
string
Account id
--kind
string
Target kind: auto, user, or group (default: auto)
--json
boolean
Output JSON

channels logs

Show recent channel logs from the gateway log file.
simpleclaw channels logs
--channel
string
Channel name or all (default: all)
--lines
number
Number of lines (default: 200)
--json
boolean
Output JSON

channels add

Add or update a channel account.
simpleclaw channels add
--channel
string
Channel name (e.g., telegram, discord, slack, signal, whatsapp)
--account
string
Account id (default when omitted)
--name
string
Display name for this account
--token
string
Bot token (Telegram/Discord)
--token-file
string
Bot token file (Telegram)
--bot-token
string
Slack bot token (xoxb-…)
--app-token
string
Slack app token (xapp-…)
--signal-number
string
Signal account number (E.164)
--cli-path
string
CLI path (signal-cli or imsg)
--db-path
string
iMessage database path
--service
string
iMessage service: imessage, sms, or auto
--region
string
iMessage region (for SMS)
--auth-dir
string
WhatsApp auth directory override
--http-url
string
Signal HTTP daemon base URL
--http-host
string
Signal HTTP host
--http-port
string
Signal HTTP port
--webhook-path
string
Webhook path (Google Chat/BlueBubbles)
--webhook-url
string
Google Chat webhook URL
--audience-type
string
Google Chat audience type: app-url or project-number
--audience
string
Google Chat audience value (app URL or project number)
--homeserver
string
Matrix homeserver URL
--user-id
string
Matrix user ID
--access-token
string
Matrix access token
--password
string
Matrix password
--device-name
string
Matrix device name
--initial-sync-limit
number
Matrix initial sync limit
--ship
string
Tlon ship name (e.g., ~sampel-palnet)
--url
string
Tlon ship URL
--code
string
Tlon login code
--group-channels
string
Tlon group channels (comma-separated)
--dm-allowlist
string
Tlon DM allowlist (comma-separated ships)
--auto-discover-channels
boolean
Tlon auto-discover group channels
--use-env
boolean
Use env token (default account only)
Example:
simpleclaw channels add --channel telegram --token <token>

channels remove

Disable or delete a channel account.
simpleclaw channels remove
--channel
string
Channel name
--account
string
Account id (default when omitted)
--delete
boolean
Delete config entries (no prompt)

channels login

Link a channel account (if supported).
simpleclaw channels login
--channel
string
Channel alias (auto when only one is configured)
--account
string
Account id
--verbose
boolean
Verbose connection logs
Example:
simpleclaw channels login --channel whatsapp

channels logout

Log out of a channel session (if supported).
simpleclaw channels logout
--channel
string
Channel alias (auto when only one is configured)
--account
string
Account id

Examples

# List configured channels and auth profiles
simpleclaw channels list

# Run channel status checks and probes
simpleclaw channels status --probe

# Add or update a channel account non-interactively
simpleclaw channels add --channel telegram --token <token>

# Link a WhatsApp Web account
simpleclaw channels login --channel whatsapp

Build docs developers (and LLMs) love