openclaw-cli
Original:🇺🇸 English
Translated
Master the OpenClaw CLI - gateway, agents, channels, skills, hooks, and automation
3installs
Added on
NPX Install
npx skill4agent add irangareddy/openclaw-essentials openclaw-cliTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →OpenClaw CLI
Complete reference for openclaw command-line interface operations.
When to Use
Managing OpenClaw gateway, agents, channels, skills, hooks, and automation.
Core Commands
Setup & Onboarding
Initial setup:
bash
# Quick onboarding with daemon install
openclaw onboard --install-daemon
# Setup workspace and config
openclaw setup --workspace ~/.openclaw/workspace
# Interactive configuration
openclaw configureHealth check:
bash
openclaw doctorGateway Management
Run gateway:
bash
# Interactive mode
openclaw gateway
# With specific port
openclaw gateway --port 18789
# With tailscale
openclaw gateway --tailscale serveGateway service:
bash
# Install as system service
openclaw gateway install
# Control service
openclaw gateway start
openclaw gateway stop
openclaw gateway restart
openclaw gateway statusGateway health:
bash
openclaw status
openclaw status --deep # Probe channels
openclaw healthAgent Management
List agents:
bash
openclaw agents list
openclaw agents list --bindings # Show routingAdd agent:
bash
# Interactive wizard
openclaw agents add <name>
# Non-interactive
openclaw agents add dev \
--workspace ~/.openclaw/workspace-dev \
--model claude-sonnet-4.5 \
--non-interactiveDelete agent:
bash
openclaw agents delete <id>Set identity:
bash
# From IDENTITY.md
openclaw agents set-identity --agent main --from-identity
# Explicit values
openclaw agents set-identity --agent main \
--name "MyAgent" \
--emoji "🤖" \
--avatar avatars/bot.pngSkills Management
List skills:
bash
openclaw skills list
openclaw skills list --eligible # Only ready skills
openclaw skills list --json # JSON outputSkill info:
bash
openclaw skills info <skill-name>Check eligibility:
bash
openclaw skills checkHooks Management
List hooks:
bash
openclaw hooks list
openclaw hooks list --eligible
openclaw hooks list --verbose # Show missing requirementsHook info:
bash
openclaw hooks info <hook-name>Enable/disable:
bash
openclaw hooks enable session-memory
openclaw hooks disable command-loggerInstall hooks:
bash
# From npm
openclaw hooks install @openclaw/my-hooks
# Local directory
openclaw hooks install ./my-hooks
# Link (development)
openclaw hooks install -l ./my-hooksUpdate hooks:
bash
openclaw hooks update <id>
openclaw hooks update --allChannel Management
List channels:
bash
openclaw channels listChannel status:
bash
openclaw channels status
openclaw channels status --probeAdd channel:
bash
# Interactive
openclaw channels add
# Telegram bot
openclaw channels add --channel telegram \
--account alerts \
--name "Alerts Bot" \
--token $TELEGRAM_BOT_TOKEN
# Discord
openclaw channels add --channel discord \
--account work \
--token $DISCORD_BOT_TOKENRemove channel:
bash
openclaw channels remove --channel telegram --account alerts
openclaw channels remove --channel discord --account work --deleteWhatsApp login:
bash
openclaw channels login --channel whatsappChannel logs:
bash
openclaw channels logs
openclaw channels logs --channel whatsapp --lines 100Models & Authentication
Status:
bash
openclaw models status
openclaw models status --probe # Live check
openclaw models status --probe-provider anthropicList models:
bash
openclaw models list
openclaw models list --all
openclaw models list --provider anthropicSet default:
bash
openclaw models set claude-sonnet-4.5
openclaw models set-image claude-sonnet-4.5Auth setup:
bash
# Anthropic (recommended)
claude setup-token
openclaw models auth setup-token --provider anthropic
# Or paste token
openclaw models auth paste-token --provider anthropicFallbacks:
bash
openclaw models fallbacks list
openclaw models fallbacks add claude-opus-4.6
openclaw models fallbacks remove claude-haiku-4.5
openclaw models fallbacks clearScan for models:
bash
openclaw models scan
openclaw models scan --set-defaultMessaging
Send message:
bash
openclaw message send \
--target +15555550123 \
--message "Hello from OpenClaw"
# Discord channel
openclaw message send \
--channel discord \
--target channel:123456 \
--message "Deployment complete"Send poll:
bash
openclaw message poll \
--channel discord \
--target channel:123 \
--poll-question "Lunch?" \
--poll-option "Pizza" \
--poll-option "Sushi"Other message operations:
bash
openclaw message read --target +15555550123
openclaw message react --target <id> --emoji "👍"
openclaw message edit --target <id> --message "Updated"
openclaw message delete --target <id>Browser Control
Status & control:
bash
openclaw browser status
openclaw browser start
openclaw browser stop
openclaw browser tabsNavigate:
bash
openclaw browser open https://example.com
openclaw browser navigate https://example.com --target-id <id>Interact:
bash
openclaw browser click "#submit-button"
openclaw browser type "#email" "user@example.com"
openclaw browser press EnterCapture:
bash
openclaw browser screenshot
openclaw browser screenshot --full-page
openclaw browser snapshot --format aiProfiles:
bash
openclaw browser profiles
openclaw browser create-profile --name dev
openclaw browser delete-profile --name oldNodes & Devices
List nodes:
bash
openclaw nodes list
openclaw nodes status --connectedNode operations:
bash
# Describe node
openclaw nodes describe --node <id>
# Run command on node
openclaw nodes run --node <id> --cwd /path -- ls -la
# Notify (macOS)
openclaw nodes notify --node <id> \
--title "Build Complete" \
--body "Success" \
--sound defaultCamera:
bash
openclaw nodes camera list --node <id>
openclaw nodes camera snap --node <id> --facing front
openclaw nodes camera clip --node <id> --duration 10sCanvas:
bash
openclaw nodes canvas snapshot --node <id>
openclaw nodes canvas present --node <id> --target index.html
openclaw nodes canvas hide --node <id>Screen recording:
bash
openclaw nodes screen record --node <id> --duration 30sSystem Commands
System event:
bash
openclaw system event --text "Deployment complete" --mode nowHeartbeat:
bash
openclaw system heartbeat last
openclaw system heartbeat enable
openclaw system heartbeat disablePresence:
bash
openclaw system presenceCron Jobs
List jobs:
bash
openclaw cron list
openclaw cron list --all
openclaw cron statusAdd job:
bash
# System event every hour
openclaw cron add \
--name "hourly-check" \
--every "1h" \
--system-event "Hourly check"
# Message at specific time
openclaw cron add \
--name "morning-reminder" \
--at "09:00" \
--message "Good morning!"Manage jobs:
bash
openclaw cron enable <id>
openclaw cron disable <id>
openclaw cron rm <id>
openclaw cron run <id>Job runs:
bash
openclaw cron runs --id <id> --limit 10Configuration
Get/set config:
bash
# Get value
openclaw config get agents.defaults.model.primary
# Set value
openclaw config set agents.defaults.model.primary "claude-sonnet-4.5"
# Unset value
openclaw config unset some.config.pathMemory Operations
Memory status:
bash
openclaw memory statusIndex memory:
bash
openclaw memory indexSearch memory:
bash
openclaw memory search "GraphQL implementation patterns"Logs
Tail logs:
bash
openclaw logs
openclaw logs --follow
openclaw logs --limit 200
openclaw logs --jsonSandbox
List sandboxes:
bash
openclaw sandbox listRecreate sandbox:
bash
openclaw sandbox recreateSecurity
Security audit:
bash
openclaw security audit
openclaw security audit --deep
openclaw security audit --fixPlugins
List plugins:
bash
openclaw plugins list
openclaw plugins list --jsonPlugin info:
bash
openclaw plugins info <plugin-id>Install plugin:
bash
openclaw plugins install <path-or-spec>Enable/disable:
bash
openclaw plugins enable <id>
openclaw plugins disable <id>Plugin health:
bash
openclaw plugins doctorUpdate & Maintenance
Update OpenClaw:
bash
openclaw updateReset config:
bash
openclaw reset --scope config
openclaw reset --scope config+creds+sessions
openclaw reset --scope fullUninstall:
bash
openclaw uninstall --service
openclaw uninstall --state
openclaw uninstall --workspace
openclaw uninstall --allGlobal Flags
Available everywhere:
bash
--dev # Use ~/.openclaw-dev for isolation
--profile <name> # Use ~/.openclaw-<name>
--no-color # Disable ANSI colors
--json # Machine-readable output
-V, --version # Show versionCommon Workflows
First-Time Setup
bash
# 1. Onboard with daemon
openclaw onboard --install-daemon
# 2. Pair WhatsApp (or other channel)
openclaw channels login
# 3. Start gateway
openclaw gateway
# 4. Test with message
openclaw message send --target +1234567890 --message "Test"Multi-Agent Setup
bash
# 1. Add agent
openclaw agents add work --workspace ~/.openclaw/workspace-work
# 2. Set identity
openclaw agents set-identity --agent work --from-identity
# 3. Add binding (in openclaw.json)
# bindings: [{ agentId: "work", match: { channel: "discord" } }]
# 4. List to verify
openclaw agents list --bindingsHook Automation
bash
# 1. Enable session memory hook
openclaw hooks enable session-memory
# 2. Enable command logger
openclaw hooks enable command-logger
# 3. Verify
openclaw hooks check
# 4. Restart gateway
openclaw gateway restartChannel Setup
bash
# 1. Add Telegram bot
openclaw channels add --channel telegram \
--account alerts \
--token $TELEGRAM_BOT_TOKEN
# 2. Verify
openclaw channels status
# 3. Send test message
openclaw message send --channel telegram \
--target <chat-id> \
--message "Bot online"Model Configuration
bash
# 1. Setup auth
claude setup-token
# 2. Set default model
openclaw models set claude-sonnet-4.5
# 3. Add fallbacks
openclaw models fallbacks add claude-opus-4.6
openclaw models fallbacks add claude-haiku-4.5
# 4. Verify
openclaw models statusDebugging
Check gateway status:
bash
openclaw status --deep
openclaw doctor
openclaw healthView logs:
bash
openclaw logs --follow
openclaw channels logs --lines 200Test channel:
bash
openclaw channels status --probeCheck skills/hooks:
bash
openclaw skills check
openclaw hooks check
openclaw plugins doctorTips
- Use for scripting - All commands support JSON output
--json - Profile isolation - Use for testing without affecting main config
--profile - Doctor fixes - Run regularly to catch issues
openclaw doctor - Logs location - for file logs
~/.openclaw/logs/ - Config location -
~/.openclaw/openclaw.json - Workspace - (or custom path)
~/.openclaw/workspace