CLI Reference
OpenClaw CLI Commands
Complete reference for the OpenClaw command-line interface. Manage channels, agents, automation, and more directly from your terminal.
Getting Started
Install the OpenClaw CLI to get started with these commands:
$ curl -fsSL https://get.openclaw.ai | bashAfter installation, run openclaw onboard to complete the setup wizard.
Core Commands
openclaw statusCheck the current status of your OpenClaw installation, including running services, connected channels, and active agents.
Usage
openclaw status [options]Options
| --json | Output status in JSON format |
| --verbose, -v | Show detailed status information |
| --watch, -w | Continuously monitor status |
Examples
$ openclaw status$ openclaw status --json$ openclaw status -v --watchopenclaw healthPerform a comprehensive health check of all OpenClaw components, including connectivity, dependencies, and service health.
Usage
openclaw health [options]Options
| --fix | Attempt to fix detected issues automatically |
| --component <name> | Check specific component only |
| --timeout <seconds> | Set health check timeout (default: 30) |
Examples
$ openclaw health$ openclaw health --fix$ openclaw health --component gatewayopenclaw gatewayManage the OpenClaw gateway service that handles routing between channels and agents.
Usage
openclaw gateway <action> [options]Options
| start | Start the gateway service |
| stop | Stop the gateway service |
| restart | Restart the gateway service |
| status | Show gateway status |
| --port <port> | Specify gateway port (default: 3000) |
| --host <host> | Specify gateway host (default: localhost) |
Examples
$ openclaw gateway start$ openclaw gateway restart --port 8080$ openclaw gateway statusopenclaw dashboardOpen the OpenClaw web dashboard in your default browser for visual management of your installation.
Usage
openclaw dashboard [options]Options
| --no-open | Print URL without opening browser |
| --port <port> | Dashboard port (default: 3001) |
| --external | Allow external network access |
Examples
$ openclaw dashboard$ openclaw dashboard --no-open$ openclaw dashboard --port 8081 --externalopenclaw onboardLaunch the interactive setup wizard to configure OpenClaw for first-time use, including channel connections and agent setup.
Usage
openclaw onboard [options]Options
| --skip-channels | Skip channel configuration |
| --skip-agents | Skip agent configuration |
| --template <name> | Use a predefined configuration template |
| --non-interactive | Run with default options (no prompts) |
Examples
$ openclaw onboard$ openclaw onboard --template personal$ openclaw onboard --skip-channelsopenclaw configureOpen or edit the OpenClaw configuration file. Supports direct editing or interactive configuration mode.
Usage
openclaw configure [options]Options
| --editor <editor> | Specify editor to use (default: $EDITOR) |
| --interactive, -i | Use interactive configuration mode |
| --validate | Validate configuration without editing |
| --reset | Reset configuration to defaults |
| --show | Display current configuration |
Examples
$ openclaw configure$ openclaw configure --interactive$ openclaw configure --validate$ openclaw configure --showopenclaw updateUpdate OpenClaw to the latest version, including all components and dependencies.
Usage
openclaw update [options]Options
| --check | Check for updates without installing |
| --version <version> | Update to specific version |
| --force | Force update even if already up to date |
| --channel <channel> | Update channel: stable, beta, canary |
| --components <list> | Update specific components only |
Examples
$ openclaw update$ openclaw update --check$ openclaw update --version 2.1.0$ openclaw update --channel betaopenclaw uninstallRemove OpenClaw from your system, including all components, configurations, and data.
Usage
openclaw uninstall [options]Options
| --keep-config | Preserve configuration files |
| --keep-data | Preserve data and logs |
| --purge | Remove all files including configs and data |
| --force | Skip confirmation prompts |
Examples
$ openclaw uninstall$ openclaw uninstall --keep-config$ openclaw uninstall --purge --forceopenclaw doctorDiagnose common issues with your OpenClaw installation and provide recommendations for fixes.
Usage
openclaw doctor [options]Options
| --auto-fix | Automatically fix detected issues |
| --verbose | Show detailed diagnostic information |
| --category <cat> | Diagnose specific category: network, auth, config |
| --report | Generate a diagnostic report file |
Examples
$ openclaw doctor$ openclaw doctor --auto-fix$ openclaw doctor --category network$ openclaw doctor --reportChannel Commands
openclaw channelsList and manage connected messaging channels (WhatsApp, Telegram, Discord, Slack, etc.).
Usage
openclaw channels [action] [options]Options
| list | List all configured channels |
| add <type> | Add a new channel |
| remove <id> | Remove a channel |
| enable <id> | Enable a channel |
| disable <id> | Disable a channel |
| --status | Show connection status for each channel |
Examples
$ openclaw channels$ openclaw channels list --status$ openclaw channels add whatsapp$ openclaw channels remove telegram-mainopenclaw channels loginAuthenticate and connect to a messaging channel. Displays QR codes for WhatsApp, OAuth flows for others.
Usage
openclaw channels login <channel> [options]Options
| <channel> | Channel ID or type to login |
| --qr-terminal | Display QR code in terminal (WhatsApp) |
| --qr-image | Save QR code as image file |
| --headless | Run login in headless mode |
| --timeout <seconds> | Login timeout (default: 120) |
Examples
$ openclaw channels login whatsapp$ openclaw channels login whatsapp --qr-terminal$ openclaw channels login telegram --timeout 300$ openclaw channels login discordopenclaw message sendSend a message through a connected channel to a specific recipient or group.
Usage
openclaw message send [options]Options
| --channel <id> | Channel to send through |
| --to <recipient> | Recipient ID, phone, or username |
| --text <message> | Message text to send |
| --file <path> | Attach a file to the message |
| --reply-to <id> | Reply to a specific message |
| --schedule <time> | Schedule message for later |
Examples
$ openclaw message send --channel whatsapp --to +15551234567 --text "Hello!"$ openclaw message send --channel telegram --to @username --file ./report.pdf$ openclaw message send --channel slack --to #general --text "Team update"Agent Commands
openclaw agentManage a single agent configuration, including creating, editing, and running agents.
Usage
openclaw agent <action> [name] [options]Options
| create <name> | Create a new agent |
| edit <name> | Edit an existing agent |
| delete <name> | Delete an agent |
| run <name> | Start an agent interactively |
| info <name> | Show agent details |
| --template <template> | Use template when creating |
| --model <model> | Set the LLM model to use |
Examples
$ openclaw agent create my-assistant$ openclaw agent create support-bot --template customer-service$ openclaw agent run my-assistant --model opus$ openclaw agent info my-assistantopenclaw agentsList all configured agents with their status and basic information.
Usage
openclaw agents [options]Options
| --status | Include runtime status |
| --json | Output in JSON format |
| --filter <query> | Filter agents by name or tag |
| --sort <field> | Sort by: name, created, updated, status |
Examples
$ openclaw agents$ openclaw agents --status$ openclaw agents --filter support --jsonopenclaw sessionsManage active and historical conversation sessions across all agents.
Usage
openclaw sessions [action] [options]Options
| list | List all sessions |
| show <id> | Show session details and history |
| export <id> | Export session to file |
| delete <id> | Delete a session |
| clear | Clear all sessions |
| --agent <name> | Filter by agent |
| --since <date> | Filter by start date |
| --active | Show only active sessions |
Examples
$ openclaw sessions list --active$ openclaw sessions show abc123$ openclaw sessions export abc123 --format json$ openclaw sessions list --agent my-assistant --since 2024-01-01openclaw memoryManage agent memory systems including vector stores, context, and persistent knowledge.
Usage
openclaw memory <action> [options]Options
| list | List memory stores |
| create <name> | Create a new memory store |
| delete <name> | Delete a memory store |
| import <file> | Import data into memory |
| export <name> | Export memory store |
| query <query> | Search memory |
| --agent <name> | Target specific agent |
| --type <type> | Memory type: vector, context, knowledge |
Examples
$ openclaw memory list$ openclaw memory create project-docs --type vector$ openclaw memory import ./docs/ --agent my-assistant$ openclaw memory query "API authentication" --agent my-assistantAutomation Commands
openclaw cronManage scheduled tasks and recurring jobs for automated agent actions.
Usage
openclaw cron <action> [options]Options
| list | List all scheduled jobs |
| add | Add a new cron job |
| remove <id> | Remove a cron job |
| enable <id> | Enable a cron job |
| disable <id> | Disable a cron job |
| run <id> | Manually trigger a cron job |
| --schedule <cron> | Cron schedule expression |
| --agent <name> | Agent to execute the job |
| --command <cmd> | Command or prompt to run |
Examples
$ openclaw cron list$ openclaw cron add --schedule "0 9 * * *" --agent daily-summary --command "Generate daily report"$ openclaw cron run job-123$ openclaw cron disable job-123openclaw hooksConfigure webhooks to trigger agents based on external events and API calls.
Usage
openclaw hooks <action> [options]Options
| list | List all webhooks |
| create | Create a new webhook |
| delete <id> | Delete a webhook |
| test <id> | Test a webhook with sample payload |
| logs <id> | View webhook invocation logs |
| --name <name> | Webhook name |
| --agent <agent> | Target agent |
| --secret <secret> | Webhook secret for validation |
| --events <events> | Comma-separated event types |
Examples
$ openclaw hooks list$ openclaw hooks create --name github-pr --agent code-reviewer --events pull_request$ openclaw hooks test hook-abc123$ openclaw hooks logs hook-abc123 --since 1hTools Commands
openclaw browserControl browser automation capabilities for web scraping, testing, and interaction.
Usage
openclaw browser <action> [options]Options
| start | Start browser automation service |
| stop | Stop browser automation service |
| status | Check browser service status |
| open <url> | Open a URL in managed browser |
| screenshot <url> | Take screenshot of a URL |
| --headless | Run in headless mode |
| --profile <name> | Use specific browser profile |
| --proxy <url> | Use proxy server |
Examples
$ openclaw browser start --headless$ openclaw browser open https://example.com$ openclaw browser screenshot https://example.com --output ./screenshot.png$ openclaw browser statusopenclaw skillsManage agent skills - reusable capabilities and tools that extend agent functionality.
Usage
openclaw skills <action> [options]Options
| list | List all available skills |
| install <name> | Install a skill from registry |
| uninstall <name> | Uninstall a skill |
| create <name> | Create a new custom skill |
| publish <name> | Publish skill to registry |
| info <name> | Show skill details |
| --agent <name> | Filter by agent |
| --category <cat> | Filter by category |
Examples
$ openclaw skills list$ openclaw skills install web-search$ openclaw skills create my-custom-skill$ openclaw skills info web-searchopenclaw pluginsManage plugins that extend OpenClaw functionality with integrations and features.
Usage
openclaw plugins <action> [options]Options
| list | List installed plugins |
| search <query> | Search plugin registry |
| install <name> | Install a plugin |
| uninstall <name> | Uninstall a plugin |
| update <name> | Update a plugin |
| enable <name> | Enable a plugin |
| disable <name> | Disable a plugin |
| --global | Install/manage globally |
Examples
$ openclaw plugins list$ openclaw plugins search calendar$ openclaw plugins install @openclaw/google-calendar$ openclaw plugins update --allOther Commands
openclaw logsView and manage OpenClaw logs for debugging and monitoring.
Usage
openclaw logs [options]Options
| --follow, -f | Follow log output in real-time |
| --tail <n> | Show last n lines (default: 100) |
| --level <level> | Filter by level: debug, info, warn, error |
| --component <name> | Filter by component |
| --since <time> | Show logs since time (e.g., 1h, 2d) |
| --until <time> | Show logs until time |
| --json | Output in JSON format |
| --export <file> | Export logs to file |
Examples
$ openclaw logs -f$ openclaw logs --tail 500 --level error$ openclaw logs --component gateway --since 1h$ openclaw logs --export ./debug-logs.json --jsonopenclaw nodesManage distributed OpenClaw nodes for scaling and high availability deployments.
Usage
openclaw nodes <action> [options]Options
| list | List all nodes in cluster |
| add <address> | Add a node to cluster |
| remove <id> | Remove a node from cluster |
| status <id> | Check specific node status |
| drain <id> | Drain node before maintenance |
| promote <id> | Promote node to primary |
| --sync | Synchronize node configurations |
Examples
$ openclaw nodes list$ openclaw nodes add 192.168.1.100:3000$ openclaw nodes status node-abc123$ openclaw nodes drain node-abc123openclaw pairingPair and manage connected devices for multi-device setups and mobile access.
Usage
openclaw pairing <action> [options]Options
| list | List paired devices |
| new | Generate new pairing code |
| revoke <id> | Revoke device pairing |
| rename <id> <name> | Rename a paired device |
| --qr | Show pairing QR code |
| --expiry <minutes> | Set code expiry time |
Examples
$ openclaw pairing list$ openclaw pairing new --qr$ openclaw pairing revoke device-abc123$ openclaw pairing rename device-abc123 "My Phone"openclaw tuiLaunch the interactive terminal user interface for visual management in the terminal.
Usage
openclaw tui [options]Options
| --theme <theme> | UI theme: dark, light, system |
| --compact | Use compact layout |
| --mouse | Enable mouse support |
| --focus <panel> | Start with focus on: agents, channels, logs |
Examples
$ openclaw tui$ openclaw tui --theme dark --mouse$ openclaw tui --compact --focus logsopenclaw voicecallManage voice call capabilities for phone-based AI interactions.
Usage
openclaw voicecall <action> [options]Options
| start | Start voice call service |
| stop | Stop voice call service |
| call <number> | Initiate an outbound call |
| hangup <id> | End an active call |
| list | List active calls |
| --agent <name> | Agent to handle calls |
| --voice <voice> | Voice profile to use |
| --record | Record the call |
| --transcribe | Enable real-time transcription |
Examples
$ openclaw voicecall start$ openclaw voicecall call +15551234567 --agent voice-assistant$ openclaw voicecall list$ openclaw voicecall call +15551234567 --record --transcribeGlobal Options
These options are available for all commands:
| --help, -h | Show help for command |
| --version, -V | Show version number |
| --config <path> | Path to config file |
| --quiet, -q | Suppress non-error output |
| --verbose, -v | Enable verbose output |
| --debug | Enable debug mode |
| --no-color | Disable colored output |
Need help? Run openclaw <command> --help for detailed information about any command.