ESC
Start typing to search...

CLI Reference

Command-line interface for setting up, starting, and managing your Teleton Agent.

Main Commands

CommandDescription
teleton setupInteractive setup wizard for LLM provider, Telegram credentials, TON wallet, and workspace files
teleton start [-c config] [--webui] [--webui-port port]Start the agent
teleton doctorRun health checks (config validation, session, wallet, database)

teleton setup

Interactive wizard that walks you through first-time configuration. It creates your config file and sets up all required credentials.

OptionDescription
--workspace <dir>Workspace directory
--uiLaunch the web-based setup wizard instead of the interactive CLI wizard (opens browser at http://localhost:7777/setup)
--ui-port <port>Port for the web wizard (default: 7777)
--non-interactiveNon-interactive mode (requires all options below)
--api-id <id>Telegram API ID
--api-hash <hash>Telegram API Hash
--phone <number>Phone number
--api-key <key>LLM provider API key
--base-url <url>Base URL for local LLM provider (e.g. http://localhost:11434 for Ollama)
--user-id <id>Telegram User ID
--tavily-api-key <key>Tavily API key for web search
# Interactive setup
teleton setup

# Non-interactive setup
teleton setup --non-interactive \
  --api-id 12345 \
  --api-hash abc123 \
  --phone +1234567890 \
  --api-key sk-ant-... \
  --user-id 67890

teleton start

Start the Teleton agent. Requires a valid configuration (run teleton setup first).

OptionDescription
-c, --config <path>Config file path (defaults to ~/.teleton/config.yaml)
--webuiEnable WebUI server (overrides config)
--webui-port <port>WebUI server port (default: 7777)
# Start with default config
teleton start

# Start with custom config and WebUI
teleton start -c /path/to/config.yaml --webui --webui-port 8080

teleton doctor

Run system health checks to verify your configuration, Telegram session, TON wallet, and database are working correctly.

teleton doctor

MCP Server Management

Manage Model Context Protocol (MCP) servers that extend the agent's capabilities.

CommandDescription
teleton mcp add <package> [args] [-n name] [-s scope] [-e KEY=VAL] [--url]Add an MCP server
teleton mcp remove <name>Remove an MCP server by name
teleton mcp listList configured MCP servers

teleton mcp add

OptionDescription
-n, --name <name>Server name (auto-derived from package if omitted)
-s, --scope <scope>Tool scope: always | dm-only | group-only | admin-only (default: always)
-e, --env <KEY=VALUE>Environment variables (repeatable)
--urlTreat package as an SSE/HTTP URL instead of an npx package
-c, --config <path>Config file path
# Add an npx-based MCP server
teleton mcp add @modelcontextprotocol/server-filesystem /tmp

# Add with custom name and scope
teleton mcp add @modelcontextprotocol/server-github -n github -s admin-only \
  -e GITHUB_TOKEN=ghp_xxx

# Add a remote SSE server
teleton mcp add https://mcp.example.com/sse --url -n my-server

Configuration Management

Read and write individual configuration keys without editing the config file directly.

CommandDescription
teleton config listList all configurable keys
teleton config set <key> [value]Set a config value (prompts interactively if value omitted)
teleton config get <key>Get current value for a key
teleton config unset <key>Remove a config override
# List all keys
teleton config list

# Set a value
teleton config set tavily_api_key tvly-xxx

# Get a value
teleton config get telegram.bot_token

# Remove an override
teleton config unset tavily_api_key
Dot notation

Config keys use dot notation for nested values, e.g. telegram.bot_token or agent.model.