Clawdbot CLI Reference
Complete command reference for Clawdbot AI assistant CLI. Learn all available commands, options, and usage examples.
Clawdbot CLI Overview
The Clawdbot CLI provides commands for managing your AI assistant, gateway, agents, and providers from the terminal.
Installation
# npm
npm install -g @clawdbot/cli
# pnpm
pnpm add -g @clawdbot/cliCore Commands
Gateway Commands
# Start gateway
clawdbot gateway start
# Stop gateway
clawdbot gateway stop
# Restart gateway
clawdbot gateway restart
# Check gateway status
clawdbot gateway status
# View gateway logs
clawdbot gateway logsAgent Commands
# List agents
clawdbot agents list
# Add new agent
clawdbot agents add <name>
# Remove agent
clawdbot agents remove <name>
# Check agent status
clawdbot agents status
# Reset agent
clawdbot agents reset <name>Provider Commands
# List providers
clawdbot providers list
# Setup provider
clawdbot providers setup <name>
# Check provider status
clawdbot providers status
# Disconnect provider
clawdbot providers disconnect <name>Session Commands
# List sessions
clawdbot sessions list
# Get session details
clawdbot sessions get <key>
# Clear session
clawdbot sessions clear <key>
# Export session
clawdbot sessions export <key>Config Commands
# Get config value
clawdbot config get <path>
# Set config value
clawdbot config set <path> <value>
# Validate config
clawdbot config validate
# Reset config
clawdbot config resetGlobal Options
| Option | Description |
|---|---|
--config | Config file path |
--log-level | Log verbosity |
--json | Output as JSON |
--help | Show help |
--version | Show version |
Command Examples
Start with Custom Port
clawdbot gateway start --port 3011Debug Mode
clawdbot gateway start --log-level debugJSON Output
clawdbot agents list --jsonNon-Interactive Setup
clawdbot providers setup telegram --token $BOT_TOKENEnvironment Variables
| Variable | Description |
|---|---|
CLAWDBOT_CONFIG | Config file path |
CLAWDBOT_LOG_LEVEL | Default log level |
CLAWDBOT_HOME | Data directory |
Next Steps
- Clawdbot Slash Commands - Slash commands
- Clawdbot Gateway - Gateway guide
- Clawdbot Configuration - Config reference