OpenClaw Maintenance Skill
OpenClaw is a self-hosted, open-source (MIT) gateway that routes AI agents across WhatsApp, Telegram, Discord, Slack, iMessage, Signal, and 15+ other channels simultaneously. It runs on macOS, Linux, or Windows.
Reference Files
| Reference |
Coverage |
| channels.md |
Per-channel setup (WhatsApp, Telegram, Discord, etc.) |
| channel_troubleshooting.md |
Per-channel failure signatures and walkthroughs |
| tools.md |
Tools inventory (profiles, groups, all built-in tools) |
| exec.md |
Exec tool: parameters, config, PATH, security, process tool |
| exec_approvals.md |
Exec approvals: allowlists, safe bins, approval flow |
| browser.md |
Browser tool: profiles, CDP, relay, SSRF, Control API |
| web_tools.md |
Web tools: Brave, Perplexity, Gemini search providers |
| pdf_tool.md |
PDF tool: native/fallback modes, config, page filtering |
| elevated.md |
Elevated mode: /elevated directives, sandbox breakout |
| lobster.md |
Lobster: typed workflow runtime with approvals |
| llm_task.md |
LLM Task: JSON-only LLM step for structured output |
| openprose.md |
OpenProse: multi-agent program runtime |
| plugins.md |
Plugins: official list, config, manifest, CLI, authoring |
| skills.md |
Skills: locations, config, ClawHub, watcher, token impact |
| providers.md |
Model provider setup |
| multi_agent.md |
Multi-agent routing |
| nodes.md |
Nodes (iOS/Android/macOS/headless) |
| security.md |
Security hardening |
| secrets.md |
Secrets management (SecretRef, vault) |
| sandboxing.md |
Sandboxing (Docker isolation) |
| config_reference.md |
Full config field reference |
| gateway_ops.md |
Gateway operations |
| remote_access.md |
Remote access, SSH, Tailscale, web dashboard |
| sessions.md |
Session management, DM isolation, lifecycle, compaction |
| hooks.md |
Hooks: internal event hooks, HTTP webhooks, authoring, CLI |
| automation.md |
Cron jobs, webhooks, Gmail Pub/Sub |
| acp_agents.md |
ACP agents: spawn external AI runtimes (Codex, Claude, etc.) |
| install.md |
Installation, updating, rollback, migration, uninstall |
| web_ui.md |
Web surfaces: Dashboard, Control UI, WebChat |
| slash_commands.md |
Chat slash commands (/new, /model, /acp, etc.) |
| platforms.md |
Platform-specific guides (macOS, iOS, Android, Linux, Windows) |
| diffs_firecrawl.md |
Diffs plugin + Firecrawl anti-bot fallback |
| subagents.md |
Sub-agents: nested spawning, thread binding, announce, tool policy |
| memory.md |
Memory system, vector search, hybrid BM25, compaction |
Quick Reference
Key Paths
| Path |
Purpose |
~/.openclaw/openclaw.json |
Main config (JSON5) |
~/.openclaw/.env |
Global env fallback |
~/.openclaw/workspace |
Default agent workspace |
~/.openclaw/agents/<id>/ |
Per-agent state + sessions |
OPENCLAW_CONFIG_PATH |
Override config location |
OPENCLAW_STATE_DIR |
Override state directory |
OPENCLAW_HOME |
Override home directory |
Essential Commands
openclaw status # Overall status
openclaw gateway status # Gateway daemon status
openclaw gateway status --deep # Deep scan including system services
openclaw doctor # Diagnose config/service issues
openclaw doctor --fix # Auto-fix safe issues
openclaw logs --follow # Tail gateway logs
openclaw channels status --probe # Channel health check
openclaw security audit # Security posture check
openclaw security audit --fix # Auto-fix security issues
openclaw update # Self-update
openclaw dashboard # Open Control UI in browser
openclaw tui # Terminal UI (interactive REPL)
openclaw agent # Direct agent interaction via CLI
openclaw health # Health check
openclaw usage # Usage tracking
openclaw config validate # Validate config file
openclaw config file # Print active config path
openclaw sessions cleanup # Session disk cleanup
openclaw agents bindings # Agent-channel bindings
openclaw agents bind # Bind agent to account
openclaw agents unbind # Unbind agent
openclaw update --dry-run # Preview update
Default Gateway
- Bind:
127.0.0.1:18789 (loopback)
- Dashboard:
http://127.0.0.1:18789/
- Protocol: WebSocket (JSON text frames)
Core Workflow
Diagnosing Issues
Always follow this command ladder:
openclaw status — quick overview
openclaw gateway status — daemon running? RPC probe ok?
openclaw logs --follow — watch for errors
openclaw doctor — config/service diagnostics
openclaw channels status --probe — per-channel health
Starting / Restarting Gateway
# Foreground with verbose logging
openclaw gateway --port 18789 --verbose
# Force-kill existing listener then start
openclaw gateway --force
# Service management (launchd on macOS, systemd on Linux)
openclaw gateway install
openclaw gateway start
openclaw gateway stop
openclaw gateway restart
Configuration
Edit config via any method:
# Interactive wizard
openclaw onboard # Full setup
openclaw configure # Config wizard
# CLI one-liners
openclaw config get <path> # Read value
openclaw config set <path> <value> # Set value (JSON5 or raw string)
openclaw config unset <path> # Remove value
# Direct edit
# Edit ~/.openclaw/openclaw.json (JSON5 format)
# Gateway hot-reloads on save (if gateway.reload.mode != "off")
Minimal config example:
{
agents: { defaults: { workspace: "~/.openclaw/workspace" } },
channels: { whatsapp: { allowFrom: ["+15555550123"] } },
}
Channel Setup
For detailed per-channel setup, see references/channels.md.
For per-channel troubleshooting (failure signatures, setup walkthroughs), see references/channel_troubleshooting.md.
For plugins adding new channels (Matrix, Nostr, MS Teams, etc.), see references/plugins.md.
Quick channel add:
# Interactive wizard
openclaw channels add
# Non-interactive
openclaw channels add --channel telegram --account default --name "My Bot" --token $BOT_TOKEN
openclaw channels login --channel whatsapp # QR pairing for WhatsApp
openclaw channels status --probe # Verify
Model Provider Setup
For detailed provider setup, see references/providers.md.
# Set default model
openclaw models set anthropic/claude-sonnet-4-5
# List available models
openclaw models list --all
# Check auth/token status
openclaw models status --probe
# Add auth interactively
openclaw models auth add
Config example:
{
agents: {
defaults: {
model: {
primary: "anthropic/claude-sonnet-4-5",
fallbacks: ["openai/gpt-5.2"],
},
},
},
}
Multi-Agent Routing
For detailed multi-agent config, see references/multi_agent.md.
openclaw agents add <id> # Create agent
openclaw agents list --bindings # Show agent-channel bindings
openclaw agents delete <id> # Remove agent
Nodes (iOS / Android / macOS / Headless)
For detailed node setup, see references/nodes.md.
openclaw nodes status # List connected nodes
openclaw nodes describe --node <id> # Node capabilities
openclaw devices list # Pending device approvals
openclaw devices approve <requestId> # Approve a device
openclaw node run --host <host> --port 18789 # Start headless node host
Security
For detailed security hardening, see references/security.md.
For secrets management (SecretRef, vault integration), see references/secrets.md.
For sandboxing (Docker isolation for tools), see references/sandboxing.md.
For full config field reference, see references/config_reference.md.
For remote access (SSH, Tailscale, VPN), see references/remote_access.md.
openclaw security audit # Check posture
openclaw security audit --deep # Live gateway probe
openclaw security audit --fix # Auto-fix safe issues
openclaw secrets reload # Re-resolve secret refs
openclaw secrets audit # Scan for plaintext leaks
Update / Uninstall
For detailed installation, updating, rollback, and migration guide, see references/install.md.
# Install (recommended)
curl -fsSL https://openclaw.ai/install.sh | bash
# Update
openclaw update # Self-update command
# Or: npm install -g openclaw@latest
openclaw doctor # Run after update to apply migrations
# Uninstall
openclaw uninstall
Tools Reference
For detailed per-tool documentation, see references/tools.md.
For specific tools, see:
- references/exec.md — Exec tool deep-dive
- references/exec_approvals.md — Exec approvals and allowlists
- references/browser.md — Browser automation deep-dive
- references/web_tools.md — Web search/fetch with multiple providers
- references/lobster.md — Lobster workflow runtime
- references/llm_task.md — LLM Task for structured JSON output
- references/openprose.md — OpenProse multi-agent programs
- references/plugins.md — Plugin system (install, author, distribute)
- references/skills.md — Skills system (load, config, ClawHub)
For ACP agents (Codex, Claude Code, Gemini CLI, etc.), see references/acp_agents.md.
For Diffs plugin and Firecrawl anti-bot fallback, see references/diffs_firecrawl.md.
For chat slash commands (/new, /model, /acp, etc.), see references/slash_commands.md.
Tool profiles: minimal, coding, messaging, full (default).
Tool groups (for allow/deny):
group:runtime — exec, bash, process
group:fs — read, write, edit, apply_patch
group:sessions — sessions_list/history/send/spawn, session_status
group:memory — memory_search, memory_get
group:web — web_search, web_fetch
group:ui — browser, canvas
group:automation — cron, gateway
group:messaging — message
group:nodes — nodes
group:openclaw — all built-in OpenClaw tools (excludes provider plugins)
Common Failure Signatures
| Error |
Cause |
Fix |
refusing to bind gateway ... without auth |
Non-loopback bind without token |
Set gateway.auth.token or gateway.auth.password |
another gateway instance is already listening / EADDRINUSE |
Port conflict |
openclaw gateway --force or change port |
Gateway start blocked: set gateway.mode=local |
Local mode not enabled |
Set gateway.mode="local" |
unauthorized / reconnect loop |
Token/password mismatch |
Check OPENCLAW_GATEWAY_TOKEN or config auth |
device identity required |
Missing device auth |
Ensure client completes connect.challenge flow |
| No replies from bot |
Pairing/allowlist/mention gating |
Check openclaw pairing list, DM policy, mention patterns |
Environment Variables
| Variable |
Purpose |
OPENCLAW_GATEWAY_TOKEN |
Gateway auth token |
OPENCLAW_GATEWAY_PASSWORD |
Gateway auth password |
OPENCLAW_GATEWAY_PORT |
Override gateway port |
OPENCLAW_CONFIG_PATH |
Override config file path |
OPENCLAW_STATE_DIR |
Override state directory |
OPENCLAW_HOME |
Override home directory |
OPENCLAW_LOAD_SHELL_ENV |
Import shell env (set to 1) |
OPENCLAW_VERBOSE |
Verbose logging |
OPENCLAW_LOG_FILE |
File logging path |
OPENCLAW_LOG_LEVEL |
Log level control |
OPENCLAW_SHELL |
Set by OpenClaw in exec/acp/tui runtimes |
BRAVE_API_KEY |
For web_search tool |
FIRECRAWL_API_KEY |
For Firecrawl anti-bot fallback |
1---2name: openclaw3description: Comprehensive guide for installing, configuring, operating, and troubleshooting OpenClaw — a self-hosted, multi-channel AI agent gateway. Use when the user asks about OpenClaw setup, configuration, channel management (WhatsApp/Telegram/Discord/Slack/iMessage/etc.), model provider setup, Gateway operations, multi-agent routing, security hardening, troubleshooting, or any maintenance task related to their local OpenClaw installation. Also use when encountering errors from `openclaw` CLI commands or the Gateway daemon.4---56# OpenClaw Maintenance Skill78OpenClaw is a self-hosted, open-source (MIT) gateway that routes AI agents across WhatsApp, Telegram, Discord, Slack, iMessage, Signal, and 15+ other channels simultaneously. It runs on macOS, Linux, or Windows.910## Reference Files1112| Reference | Coverage |13|---|---|14| [channels.md](references/channels.md) | Per-channel setup (WhatsApp, Telegram, Discord, etc.) |15| [channel_troubleshooting.md](references/channel_troubleshooting.md) | Per-channel failure signatures and walkthroughs |16| [tools.md](references/tools.md) | Tools inventory (profiles, groups, all built-in tools) |17| [exec.md](references/exec.md) | Exec tool: parameters, config, PATH, security, process tool |18| [exec_approvals.md](references/exec_approvals.md) | Exec approvals: allowlists, safe bins, approval flow |19| [browser.md](references/browser.md) | Browser tool: profiles, CDP, relay, SSRF, Control API |20| [web_tools.md](references/web_tools.md) | Web tools: Brave, Perplexity, Gemini search providers |21| [pdf_tool.md](references/pdf_tool.md) | PDF tool: native/fallback modes, config, page filtering |22| [elevated.md](references/elevated.md) | Elevated mode: /elevated directives, sandbox breakout |23| [lobster.md](references/lobster.md) | Lobster: typed workflow runtime with approvals |24| [llm_task.md](references/llm_task.md) | LLM Task: JSON-only LLM step for structured output |25| [openprose.md](references/openprose.md) | OpenProse: multi-agent program runtime |26| [plugins.md](references/plugins.md) | Plugins: official list, config, manifest, CLI, authoring |27| [skills.md](references/skills.md) | Skills: locations, config, ClawHub, watcher, token impact |28| [providers.md](references/providers.md) | Model provider setup |29| [multi_agent.md](references/multi_agent.md) | Multi-agent routing |30| [nodes.md](references/nodes.md) | Nodes (iOS/Android/macOS/headless) |31| [security.md](references/security.md) | Security hardening |32| [secrets.md](references/secrets.md) | Secrets management (SecretRef, vault) |33| [sandboxing.md](references/sandboxing.md) | Sandboxing (Docker isolation) |34| [config_reference.md](references/config_reference.md) | Full config field reference |35| [gateway_ops.md](references/gateway_ops.md) | Gateway operations |36| [remote_access.md](references/remote_access.md) | Remote access, SSH, Tailscale, web dashboard |37| [sessions.md](references/sessions.md) | Session management, DM isolation, lifecycle, compaction |38| [hooks.md](references/hooks.md) | Hooks: internal event hooks, HTTP webhooks, authoring, CLI |39| [automation.md](references/automation.md) | Cron jobs, webhooks, Gmail Pub/Sub |40| [acp_agents.md](references/acp_agents.md) | ACP agents: spawn external AI runtimes (Codex, Claude, etc.) |41| [install.md](references/install.md) | Installation, updating, rollback, migration, uninstall |42| [web_ui.md](references/web_ui.md) | Web surfaces: Dashboard, Control UI, WebChat |43| [slash_commands.md](references/slash_commands.md) | Chat slash commands (/new, /model, /acp, etc.) |44| [platforms.md](references/platforms.md) | Platform-specific guides (macOS, iOS, Android, Linux, Windows) |45| [diffs_firecrawl.md](references/diffs_firecrawl.md) | Diffs plugin + Firecrawl anti-bot fallback |46| [subagents.md](references/subagents.md) | Sub-agents: nested spawning, thread binding, announce, tool policy |47| [memory.md](references/memory.md) | Memory system, vector search, hybrid BM25, compaction |4849## Quick Reference5051### Key Paths5253| Path | Purpose |54|---|---|55| `~/.openclaw/openclaw.json` | Main config (JSON5) |56| `~/.openclaw/.env` | Global env fallback |57| `~/.openclaw/workspace` | Default agent workspace |58| `~/.openclaw/agents/<id>/` | Per-agent state + sessions |59| `OPENCLAW_CONFIG_PATH` | Override config location |60| `OPENCLAW_STATE_DIR` | Override state directory |61| `OPENCLAW_HOME` | Override home directory |6263### Essential Commands6465```66openclaw status # Overall status67openclaw gateway status # Gateway daemon status68openclaw gateway status --deep # Deep scan including system services69openclaw doctor # Diagnose config/service issues70openclaw doctor --fix # Auto-fix safe issues71openclaw logs --follow # Tail gateway logs72openclaw channels status --probe # Channel health check73openclaw security audit # Security posture check74openclaw security audit --fix # Auto-fix security issues75openclaw update # Self-update76openclaw dashboard # Open Control UI in browser77openclaw tui # Terminal UI (interactive REPL)78openclaw agent # Direct agent interaction via CLI79openclaw health # Health check80openclaw usage # Usage tracking81openclaw config validate # Validate config file82openclaw config file # Print active config path83openclaw sessions cleanup # Session disk cleanup84openclaw agents bindings # Agent-channel bindings85openclaw agents bind # Bind agent to account86openclaw agents unbind # Unbind agent87openclaw update --dry-run # Preview update88```8990### Default Gateway9192- Bind: `127.0.0.1:18789` (loopback)93- Dashboard: `http://127.0.0.1:18789/`94- Protocol: WebSocket (JSON text frames)9596## Core Workflow9798### Diagnosing Issues99100Always follow this command ladder:1011021. `openclaw status` — quick overview1032. `openclaw gateway status` — daemon running? RPC probe ok?1043. `openclaw logs --follow` — watch for errors1054. `openclaw doctor` — config/service diagnostics1065. `openclaw channels status --probe` — per-channel health107108### Starting / Restarting Gateway109110```bash111# Foreground with verbose logging112openclaw gateway --port 18789 --verbose113114# Force-kill existing listener then start115openclaw gateway --force116117# Service management (launchd on macOS, systemd on Linux)118openclaw gateway install119openclaw gateway start120openclaw gateway stop121openclaw gateway restart122```123124### Configuration125126Edit config via any method:127128```bash129# Interactive wizard130openclaw onboard # Full setup131openclaw configure # Config wizard132133# CLI one-liners134openclaw config get <path> # Read value135openclaw config set <path> <value> # Set value (JSON5 or raw string)136openclaw config unset <path> # Remove value137138# Direct edit139# Edit ~/.openclaw/openclaw.json (JSON5 format)140# Gateway hot-reloads on save (if gateway.reload.mode != "off")141```142143Minimal config example:144145```json5146{147 agents: { defaults: { workspace: "~/.openclaw/workspace" } },148 channels: { whatsapp: { allowFrom: ["+15555550123"] } },149}150```151152### Channel Setup153154For detailed per-channel setup, see [references/channels.md](references/channels.md).155For per-channel troubleshooting (failure signatures, setup walkthroughs), see [references/channel_troubleshooting.md](references/channel_troubleshooting.md).156For plugins adding new channels (Matrix, Nostr, MS Teams, etc.), see [references/plugins.md](references/plugins.md).157158Quick channel add:159160```bash161# Interactive wizard162openclaw channels add163164# Non-interactive165openclaw channels add --channel telegram --account default --name "My Bot" --token $BOT_TOKEN166openclaw channels login --channel whatsapp # QR pairing for WhatsApp167openclaw channels status --probe # Verify168```169170### Model Provider Setup171172For detailed provider setup, see [references/providers.md](references/providers.md).173174```bash175# Set default model176openclaw models set anthropic/claude-sonnet-4-5177178# List available models179openclaw models list --all180181# Check auth/token status182openclaw models status --probe183184# Add auth interactively185openclaw models auth add186```187188Config example:189190```json5191{192 agents: {193 defaults: {194 model: {195 primary: "anthropic/claude-sonnet-4-5",196 fallbacks: ["openai/gpt-5.2"],197 },198 },199 },200}201```202203### Multi-Agent Routing204205For detailed multi-agent config, see [references/multi_agent.md](references/multi_agent.md).206207```bash208openclaw agents add <id> # Create agent209openclaw agents list --bindings # Show agent-channel bindings210openclaw agents delete <id> # Remove agent211```212213### Nodes (iOS / Android / macOS / Headless)214215For detailed node setup, see [references/nodes.md](references/nodes.md).216217```bash218openclaw nodes status # List connected nodes219openclaw nodes describe --node <id> # Node capabilities220openclaw devices list # Pending device approvals221openclaw devices approve <requestId> # Approve a device222openclaw node run --host <host> --port 18789 # Start headless node host223```224225### Security226227For detailed security hardening, see [references/security.md](references/security.md).228For secrets management (SecretRef, vault integration), see [references/secrets.md](references/secrets.md).229For sandboxing (Docker isolation for tools), see [references/sandboxing.md](references/sandboxing.md).230For full config field reference, see [references/config_reference.md](references/config_reference.md).231For remote access (SSH, Tailscale, VPN), see [references/remote_access.md](references/remote_access.md).232233```bash234openclaw security audit # Check posture235openclaw security audit --deep # Live gateway probe236openclaw security audit --fix # Auto-fix safe issues237openclaw secrets reload # Re-resolve secret refs238openclaw secrets audit # Scan for plaintext leaks239```240241### Update / Uninstall242243For detailed installation, updating, rollback, and migration guide, see [references/install.md](references/install.md).244245```bash246# Install (recommended)247curl -fsSL https://openclaw.ai/install.sh | bash248249# Update250openclaw update # Self-update command251# Or: npm install -g openclaw@latest252openclaw doctor # Run after update to apply migrations253254# Uninstall255openclaw uninstall256```257258## Tools Reference259260For detailed per-tool documentation, see [references/tools.md](references/tools.md).261262For specific tools, see:263- [references/exec.md](references/exec.md) — Exec tool deep-dive264- [references/exec_approvals.md](references/exec_approvals.md) — Exec approvals and allowlists265- [references/browser.md](references/browser.md) — Browser automation deep-dive266- [references/web_tools.md](references/web_tools.md) — Web search/fetch with multiple providers267- [references/lobster.md](references/lobster.md) — Lobster workflow runtime268- [references/llm_task.md](references/llm_task.md) — LLM Task for structured JSON output269- [references/openprose.md](references/openprose.md) — OpenProse multi-agent programs270- [references/plugins.md](references/plugins.md) — Plugin system (install, author, distribute)271- [references/skills.md](references/skills.md) — Skills system (load, config, ClawHub)272273For ACP agents (Codex, Claude Code, Gemini CLI, etc.), see [references/acp_agents.md](references/acp_agents.md).274For Diffs plugin and Firecrawl anti-bot fallback, see [references/diffs_firecrawl.md](references/diffs_firecrawl.md).275For chat slash commands (/new, /model, /acp, etc.), see [references/slash_commands.md](references/slash_commands.md).276277**Tool profiles**: `minimal`, `coding`, `messaging`, `full` (default).278279**Tool groups** (for allow/deny):280- `group:runtime` — exec, bash, process281- `group:fs` — read, write, edit, apply_patch282- `group:sessions` — sessions_list/history/send/spawn, session_status283- `group:memory` — memory_search, memory_get284- `group:web` — web_search, web_fetch285- `group:ui` — browser, canvas286- `group:automation` — cron, gateway287- `group:messaging` — message288- `group:nodes` — nodes289- `group:openclaw` — all built-in OpenClaw tools (excludes provider plugins)290291## Common Failure Signatures292293| Error | Cause | Fix |294|---|---|---|295| `refusing to bind gateway ... without auth` | Non-loopback bind without token | Set `gateway.auth.token` or `gateway.auth.password` |296| `another gateway instance is already listening` / `EADDRINUSE` | Port conflict | `openclaw gateway --force` or change port |297| `Gateway start blocked: set gateway.mode=local` | Local mode not enabled | Set `gateway.mode="local"` |298| `unauthorized` / reconnect loop | Token/password mismatch | Check `OPENCLAW_GATEWAY_TOKEN` or config auth |299| `device identity required` | Missing device auth | Ensure client completes connect.challenge flow |300| No replies from bot | Pairing/allowlist/mention gating | Check `openclaw pairing list`, DM policy, mention patterns |301302## Environment Variables303304| Variable | Purpose |305|---|---|306| `OPENCLAW_GATEWAY_TOKEN` | Gateway auth token |307| `OPENCLAW_GATEWAY_PASSWORD` | Gateway auth password |308| `OPENCLAW_GATEWAY_PORT` | Override gateway port |309| `OPENCLAW_CONFIG_PATH` | Override config file path |310| `OPENCLAW_STATE_DIR` | Override state directory |311| `OPENCLAW_HOME` | Override home directory |312| `OPENCLAW_LOAD_SHELL_ENV` | Import shell env (set to `1`) |313| `OPENCLAW_VERBOSE` | Verbose logging |314| `OPENCLAW_LOG_FILE` | File logging path |315| `OPENCLAW_LOG_LEVEL` | Log level control |316| `OPENCLAW_SHELL` | Set by OpenClaw in exec/acp/tui runtimes |317| `BRAVE_API_KEY` | For web_search tool |318| `FIRECRAWL_API_KEY` | For Firecrawl anti-bot fallback |