First 60 seconds if something is broken
Quick status
Daemon + port state
Deep probes
Tail the latest log
Run the doctor (repairs)
Gateway snapshot (WS-only)
Quick start and first-run setup
First-run Q&A - install, onboard, auth routes, subscriptions, initial failures - lives on the First-run FAQ.What is OpenClaw?
What is OpenClaw, in one paragraph?
What is OpenClaw, in one paragraph?
Value proposition
Value proposition
- Your devices, your data: run the Gateway wherever you want (Mac, Linux, VPS) and keep the workspace and session history local.
- Real channels, not a web sandbox: Discord/iMessage/Signal/Slack/Telegram/WhatsApp/etc, plus mobile voice and Canvas on supported platforms.
- Model-agnostic: use Anthropic, MiniMax, OpenAI, OpenRouter, etc., with per-agent routing and failover.
- Local-only option: run local models so all data can stay on your device.
- Multi-agent routing: separate agents per channel, account, or task, each with its own workspace and defaults.
- Open source and hackable: inspect, extend, and self-host without vendor lock-in.
I just set it up - what should I do first?
I just set it up - what should I do first?
What are the top five everyday use cases for OpenClaw?
What are the top five everyday use cases for OpenClaw?
- Personal briefings: summaries of inbox, calendar, and news you care about.
- Research and drafting: quick research, summaries, and first drafts for emails or docs.
- Reminders and follow-ups: cron- or heartbeat-driven nudges and checklists.
- Browser automation: filling forms, collecting data, repeating web tasks.
- Cross-device coordination: send a task from your phone, let the Gateway run it on a server, get the result back in chat.
Can OpenClaw help with lead gen, outreach, ads, and blogs for a SaaS?
Can OpenClaw help with lead gen, outreach, ads, and blogs for a SaaS?
What are the advantages vs Claude Code for web development?
What are the advantages vs Claude Code for web development?
- Persistent memory and workspace across sessions.
- Multi-platform access (Telegram, WhatsApp, TUI, WebChat).
- Tool orchestration (browser, files, scheduling, hooks).
- Always-on Gateway (run on a VPS, interact from anywhere).
- Nodes for local browser/screen/camera/exec.
Skills and automation
How do I customize skills without keeping the repo dirty?
How do I customize skills without keeping the repo dirty?
~/.openclaw/skills/<name>/SKILL.md (or add a folder via skills.load.extraDirs in ~/.openclaw/openclaw.json). Precedence: <workspace>/skills -> <workspace>/.agents/skills -> ~/.agents/skills -> ~/.openclaw/skills -> bundled -> skills.load.extraDirs, so managed overrides win over bundled skills without touching git. To install globally but limit visibility to some agents, keep the shared copy in ~/.openclaw/skills and control visibility with agents.defaults.skills / agents.list[].skills. Only upstream-worthy edits should go out as PRs against the repo copy.Can I load skills from a custom folder?
Can I load skills from a custom folder?
skills.load.extraDirs in ~/.openclaw/openclaw.json (lowest precedence in the order above). clawhub installs into ./skills by default, which OpenClaw treats as <workspace>/skills on the next session. To limit visibility to certain agents, pair with agents.defaults.skills or agents.list[].skills.How can I use different models or settings for different tasks?
How can I use different models or settings for different tasks?
- Cron jobs: isolated jobs can set a
modeloverride per job. - Agents: route tasks to separate agents with different default models, thinking levels, and stream params.
- On-demand switch:
/modelswitches the current session model at any time.
agents.defaults.models["provider/model"].params, then agent-specific overrides in flat agents.list[].params. Do not duplicate the same model under nested agents.list[].models["provider/model"].params; that path is for per-agent model catalog and runtime overrides.See Cron jobs, Multi-Agent Routing, Configuration, Slash commands.The bot freezes while doing heavy work. How do I offload that?
The bot freezes while doing heavy work. How do I offload that?
/subagents. Use /status to see whether the Gateway is currently busy.Long tasks and sub-agents both consume tokens; set a cheaper model for sub-agents via agents.defaults.subagents.model if cost matters.Docs: Sub-agents, Background Tasks.How do thread-bound subagent sessions work on Discord?
How do thread-bound subagent sessions work on Discord?
- Spawn with
sessions_spawnusingthread: true(optionallymode: "session"for persistent follow-up). - Or bind manually with
/focus <target>. /agentsinspects binding state./session idle <duration|off>and/session max-age <duration|off>control auto-unfocus./unfocusdetaches the thread.
session.threadBindings.enabled (global switch), session.threadBindings.idleHours (default 24, 0 disables), session.threadBindings.maxAgeHours (default 0 = no hard cap), and per-channel overrides channels.discord.threadBindings.{enabled,idleHours,maxAgeHours}. channels.discord.threadBindings.spawnSessions gates auto-bind on spawn (default true).Docs: Sub-agents, Discord, Configuration Reference, Slash commands.A subagent finished, but the completion update went to the wrong place or never posted. What should I check?
A subagent finished, but the completion update went to the wrong place or never posted. What should I check?
- Completion-mode subagent delivery prefers a bound thread or conversation route when one exists.
- If the completion origin only carries a channel, OpenClaw falls back to the requester session’s stored route (
lastChannel/lastTo/lastAccountId) so direct delivery can still succeed. - No bound route and no usable stored route: direct delivery can fail and the result falls back to queued session delivery instead of posting immediately.
- Invalid or stale targets can also force queue fallback or final delivery failure.
- If the child’s last visible assistant reply is exactly
NO_REPLY/no_replyorANNOUNCE_SKIP, OpenClaw intentionally suppresses the announce instead of posting stale earlier progress.
openclaw tasks show <lookup> where <lookup> is a task id, run id, or session key.Docs: Sub-agents, Background Tasks, Session Tools.Cron or reminders do not fire. What should I check?
Cron or reminders do not fire. What should I check?
- Confirm cron is enabled (
cron.enabled) andOPENCLAW_SKIP_CRONis not set. - Confirm the Gateway is running 24/7 (no sleep/restarts).
- Verify job timezone (
--tzvs host timezone).
Cron fired, but nothing was sent to the channel. Why?
Cron fired, but nothing was sent to the channel. Why?
--no-deliver/delivery.mode: "none": no runner fallback send is expected.- Missing or invalid announce target (
channel/to): the runner skipped outbound delivery. - Channel auth failures (
unauthorized,Forbidden): the runner tried to deliver but credentials blocked it. - A silent isolated result (
NO_REPLY/no_replyonly) is treated as intentionally non-deliverable, so queued fallback delivery is also suppressed.
message tool when a chat route is available. --announce only controls runner fallback delivery for final text the agent did not already send itself.Debug:Why did an isolated cron run switch models or retry once?
Why did an isolated cron run switch models or retry once?
LiveSessionModelSwitchError, keeping the switched provider/model (and any switched auth-profile override) before retrying.Model-selection precedence: Gmail hook model override (hooks.gmail.model) first, then per-job model, then any stored cron-session model override, then normal agent/default model selection.The retry loop is bounded to the initial attempt plus 2 switch retries; cron then aborts instead of looping forever.Debug:How do I install skills on Linux?
How do I install skills on Linux?
openclaw skills commands or drop skills into your workspace; the macOS Skills UI is not available on Linux. Browse skills at https://clawhub.ai.openclaw skills install writes into the active workspace skills/ directory by default. Add --global to install into the shared managed skills directory for all local agents. Install the separate clawhub CLI only to publish or sync your own skills. Use agents.defaults.skills or agents.list[].skills to narrow which agents see shared skills.Can OpenClaw run tasks on a schedule or continuously in the background?
Can OpenClaw run tasks on a schedule or continuously in the background?
- Cron jobs for scheduled or recurring tasks (persist across restarts).
- Heartbeat for main-session periodic checks.
- Isolated jobs for autonomous agents that post summaries or deliver to chats.
Can I run Apple macOS-only skills from Linux?
Can I run Apple macOS-only skills from Linux?
metadata.openclaw.os plus required binaries, and only load when eligible on the Gateway host. On Linux, darwin-only skills (apple-notes, apple-reminders, things-mac) will not load unless you override the gating.Three supported patterns:Option A - run the Gateway on a Mac (simplest). Run the Gateway where the macOS binaries exist, then connect from Linux in remote mode or over Tailscale. Skills load normally because the Gateway host is macOS.Option B - use a macOS node (no SSH). Run the Gateway on Linux, pair a macOS node (menubar app), and set Node Run Commands to “Always Ask” or “Always Allow” on the Mac. OpenClaw treats macOS-only skills as eligible when required binaries exist on the node; the agent runs them via the nodes tool. With “Always Ask,” approving “Always Allow” in the prompt adds that command to the allowlist.Option C - proxy macOS binaries over SSH (advanced). Keep the Gateway on Linux, but make the required CLI binaries resolve to SSH wrappers that run on a Mac, then override the skill to allow Linux so it stays eligible.- Create an SSH wrapper for the binary (example:
memofor Apple Notes): - Put the wrapper on
PATHon the Linux host (for example~/bin/memo). - Override the skill metadata (workspace or
~/.openclaw/skills) to allow Linux: - Start a new session so the skills snapshot refreshes.
Do you have a Notion or HeyGen integration?
Do you have a Notion or HeyGen integration?
- Custom skill / plugin: best for reliable API access (both have APIs).
- Browser automation: works without code but is slower and more fragile.
skills/ directory; use --global for all local agents, or configure agents.defaults.skills / agents.list[].skills to limit visibility. Some skills expect Homebrew-installed binaries; on Linux that means Linuxbrew.See Skills, Skills config, ClawHub.How do I use my existing signed-in Chrome with OpenClaw?
How do I use my existing signed-in Chrome with OpenClaw?
user browser profile, which attaches through Chrome DevTools MCP:existing-session / user profiles versus the managed openclaw profile:click,type,hover,scrollIntoView,drag, andselectrequire snapshot refs, not CSS selectors.- Upload hooks require
reforinputRef, one file at a time, no CSSelement. responsebody, PDF export, download interception, and batch actions still require the managed browser path.
Sandboxing and memory
Is there a dedicated sandboxing doc?
Is there a dedicated sandboxing doc?
Docker feels limited - how do I enable full features?
Docker feels limited - how do I enable full features?
node user, so it excludes system packages, Homebrew, and bundled browsers. For a fuller setup:- Persist
/home/nodewithOPENCLAW_HOME_VOLUMEso caches survive. - Bake system deps into the image with
OPENCLAW_IMAGE_APT_PACKAGES. - Install Playwright browsers via the bundled CLI:
node /app/node_modules/playwright-core/cli.js install chromium. - Set
PLAYWRIGHT_BROWSERS_PATHand persist that path.
Can I keep DMs personal but make groups public/sandboxed with one agent?
Can I keep DMs personal but make groups public/sandboxed with one agent?
agents.defaults.sandbox.mode: "non-main" so group/channel sessions (non-main keys) run in the configured sandbox backend while the main DM session stays on-host. Docker is the default backend once sandboxing is enabled. Restrict tools available in sandboxed sessions via tools.sandbox.tools.Setup walkthrough: Groups: personal DMs + public groups. Key reference: Gateway configuration.How do I bind a host folder into the sandbox?
How do I bind a host folder into the sandbox?
agents.defaults.sandbox.docker.binds to ["host:container:mode"] (for example "/home/user/src:/src:ro"). Global and per-agent binds merge; per-agent binds are ignored when scope: "shared". Use :ro for anything sensitive; binds bypass the sandbox filesystem walls.OpenClaw validates bind sources against both the normalized path and the canonical path resolved through the deepest existing ancestor, so symlink-parent escapes fail closed even when the final path segment does not exist yet.See Sandboxing and Sandbox vs Tool Policy vs Elevated.How does memory work?
How does memory work?
memory/YYYY-MM-DD.md, curated long-term notes in MEMORY.md (main/private sessions only).OpenClaw also runs a silent pre-compaction memory flush before compaction summarizes the conversation, reminding the model to write durable notes first. It only runs when the workspace is writable (read-only sandboxes skip it); disable with agents.defaults.compaction.memoryFlush.enabled: false. See Memory.Memory keeps forgetting things. How do I make it stick?
Memory keeps forgetting things. How do I make it stick?
MEMORY.md, short-term context in memory/YYYY-MM-DD.md. Reminding the model to store memories usually resolves it. If it keeps forgetting, verify the Gateway uses the same workspace on every run.Docs: Memory, Agent workspace.Does memory persist forever? What are the limits?
Does memory persist forever? What are the limits?
Does semantic memory search require an OpenAI API key?
Does semantic memory search require an OpenAI API key?
OPENAI_API_KEY or models.providers.openai.apiKey).To stay local, set agents.defaults.memorySearch.provider: "local" (GGUF/llama.cpp). Other supported providers: Bedrock, DeepInfra, Gemini (GEMINI_API_KEY or memorySearch.remote.apiKey), GitHub Copilot, LM Studio, Mistral, Ollama, OpenAI-compatible, and Voyage. See Memory and Memory search for setup details.Where things live on disk
Is all data used with OpenClaw saved locally?
Is all data used with OpenClaw saved locally?
- Local by default: sessions, memory files, config, and workspace live on the Gateway host (
~/.openclawplus your workspace directory). - Remote by necessity: messages sent to model providers (Anthropic/OpenAI/etc.) go to their APIs, and chat platforms (Slack/Telegram/WhatsApp/etc.) store message data on their servers.
- You control the footprint: local models keep prompts on your machine, but channel traffic still goes through the channel’s servers.
Where does OpenClaw store its data?
Where does OpenClaw store its data?
$OPENCLAW_STATE_DIR (default: ~/.openclaw):| Path | Purpose |
|---|---|
$OPENCLAW_STATE_DIR/openclaw.json | Main config (JSON5) |
$OPENCLAW_STATE_DIR/credentials/oauth.json | Legacy OAuth import (copied into auth profiles on first use) |
$OPENCLAW_STATE_DIR/agents/<agentId>/agent/auth-profiles.json | Auth profiles (OAuth, API keys, optional keyRef/tokenRef) |
$OPENCLAW_STATE_DIR/secrets.json | Optional file-backed secret payload for file SecretRef providers |
$OPENCLAW_STATE_DIR/agents/<agentId>/agent/auth.json | Legacy compatibility file (static api_key entries scrubbed) |
$OPENCLAW_STATE_DIR/credentials/ | Provider state (for example whatsapp/<accountId>/creds.json) |
$OPENCLAW_STATE_DIR/agents/ | Per-agent state (agentDir + sessions) |
$OPENCLAW_STATE_DIR/agents/<agentId>/sessions/ | Conversation history and state (per agent) |
$OPENCLAW_STATE_DIR/agents/<agentId>/sessions/sessions.json | Session metadata (per agent) |
~/.openclaw/agent/* is migrated by openclaw doctor.Your workspace (AGENTS.md, memory files, skills, etc.) is separate, configured via agents.defaults.workspace (default: ~/.openclaw/workspace).Where should AGENTS.md / SOUL.md / USER.md / MEMORY.md live?
Where should AGENTS.md / SOUL.md / USER.md / MEMORY.md live?
~/.openclaw.- Workspace (per agent):
AGENTS.md,SOUL.md,IDENTITY.md,USER.md,MEMORY.md,memory/YYYY-MM-DD.md, optionalHEARTBEAT.md. Lowercase rootmemory.mdis legacy repair input only;openclaw doctor --fixcan merge it intoMEMORY.mdwhen both exist. - State dir (
~/.openclaw): config, channel/provider state, auth profiles, sessions, logs, shared skills (~/.openclaw/skills).
~/.openclaw/workspace, configurable:Can I make SOUL.md bigger?
Can I make SOUL.md bigger?
SOUL.md is one of the workspace bootstrap files injected into agent context. Default per-file injection limit is 20000 characters; total bootstrap budget across files is 60000 characters.Change shared defaults:agents.list[].bootstrapMaxChars / bootstrapTotalMaxChars.Use /context to check raw vs injected sizes and whether truncation happened. Keep SOUL.md focused on voice, stance, and personality; put operating rules in AGENTS.md and durable facts in memory.See Context and Agent config.Recommended backup strategy
Recommended backup strategy
~/.openclaw (credentials, sessions, tokens, encrypted secrets payloads). For a full restore, back up the workspace and state directory separately.Docs: Agent workspace.How do I completely uninstall OpenClaw?
How do I completely uninstall OpenClaw?
Can agents work outside the workspace?
Can agents work outside the workspace?
agents.defaults.sandbox or per-agent sandbox settings. To make a repo the default working directory, point that agent’s workspace at the repo root - the OpenClaw repo itself is just source code, so keep the workspace separate unless you intentionally want the agent to work inside it.Remote mode: where is the session store?
Remote mode: where is the session store?
Config basics
What format is the config? Where is it?
What format is the config? Where is it?
$OPENCLAW_CONFIG_PATH (default: ~/.openclaw/openclaw.json). If the file is missing, it uses safe-ish defaults, including a default workspace of ~/.openclaw/workspace.Why do I need a token on localhost now?
Why do I need a token on localhost now?
gateway.auth.token, gateway.auth.password, OPENCLAW_GATEWAY_TOKEN, or OPENCLAW_GATEWAY_PASSWORD explicitly when clients need a stable secret across restarts. You can also choose password mode, or trusted-proxy for identity-aware reverse proxies. For open loopback, set gateway.auth.mode: "none" explicitly. openclaw doctor --generate-gateway-token generates a token any time.Do I have to restart after changing config?
Do I have to restart after changing config?
gateway.reload.mode: "hybrid" (default) hot-applies safe changes and restarts for critical ones. hot, restart, and off are also supported. Most tools.*, agents.* policy, session.*, and messages.* changes apply immediately with no reload action at all; gateway.* binding/port changes require a restart.How do I disable funny CLI taglines?
How do I disable funny CLI taglines?
cli.banner.taglineMode:off: hides tagline text but keeps the banner title/version line.default: always usesAll your chats, one OpenClaw..random: rotating funny/seasonal taglines (default behavior).- For no banner at all, set env
OPENCLAW_HIDE_BANNER=1.
How do I enable web search (and web fetch)?
How do I enable web search (and web fetch)?
web_fetch works without an API key. web_search depends on your selected provider:| Provider | Key-free | Env var(s) |
|---|---|---|
| Brave | No | BRAVE_API_KEY |
| DuckDuckGo | Yes (unofficial HTML-based) | - |
| Exa | No | EXA_API_KEY |
| Firecrawl | No | FIRECRAWL_API_KEY |
| Gemini | No | GEMINI_API_KEY |
| Grok | No (xAI OAuth or key) | XAI_API_KEY |
| Kimi | No | KIMI_API_KEY or MOONSHOT_API_KEY |
| MiniMax Search | No | MINIMAX_CODE_PLAN_KEY, MINIMAX_CODING_API_KEY, or MINIMAX_API_KEY |
| Ollama Web Search | Yes (needs ollama signin) | - |
| Perplexity | No | PERPLEXITY_API_KEY or OPENROUTER_API_KEY |
| SearXNG | Yes (self-hosted) | SEARXNG_BASE_URL |
| Tavily | No | TAVILY_API_KEY |
openclaw onboard --auth-choice xai-oauth).Recommended: openclaw configure --section web and pick a provider.plugins.entries.<plugin>.config.webSearch.*. Legacy tools.web.search.* provider paths still load for compatibility but should not be used in new configs. Firecrawl web-fetch fallback config lives under plugins.entries.firecrawl.config.webFetch.*.- Allowlists: add
web_search/web_fetch/x_search, orgroup:webfor all three. web_fetchis enabled by default.- If
tools.web.fetch.provideris omitted, OpenClaw auto-detects the first ready fetch fallback provider from available credentials; the official Firecrawl plugin provides that fallback. - Daemons read env vars from
~/.openclaw/.env(or the service environment).
config.apply wiped my config. How do I recover and avoid this?
config.apply wiped my config. How do I recover and avoid this?
config.apply replaces the entire config; a partial object removes everything else.Current OpenClaw protects most accidental clobbers:- OpenClaw-owned config writes validate the full post-change config before writing.
- Invalid or destructive OpenClaw-owned writes are rejected and saved as
openclaw.json.rejected.*. - A direct edit that breaks startup or hot reload makes the Gateway fail closed or skip the reload; it does not rewrite
openclaw.json. openclaw doctor --fixowns repair, can restore last-known-good, and saves the rejected file asopenclaw.json.clobbered.*.
- Check
openclaw logs --followforInvalid config at,Config write rejected:, orconfig reload skipped (invalid config). - Inspect the newest
openclaw.json.clobbered.*oropenclaw.json.rejected.*beside the active config. - Run
openclaw config validateandopenclaw doctor --fix. - Copy only the intended keys back with
openclaw config setorconfig.patch. - No last-known-good or rejected payload: restore from backup, or re-run
openclaw doctorand reconfigure channels/models. - Unexpected loss: file a bug with your last known config or a backup. A local coding agent can often reconstruct a working config from logs or history.
openclaw config set for small changes, openclaw configure for interactive edits, config.schema.lookup to inspect an unfamiliar path (returns a shallow schema node plus immediate child summaries), and config.patch for partial RPC edits - reserve config.apply for full-config replacement. The agent-facing gateway runtime tool refuses to rewrite tools.exec.ask / tools.exec.security even via legacy tools.bash.* aliases.Docs: Config, Configure, Gateway troubleshooting, Doctor.How do I run a central Gateway with specialized workers across devices?
How do I run a central Gateway with specialized workers across devices?
- Gateway (central): owns channels (Signal/WhatsApp), routing, sessions.
- Nodes (devices): Macs/iOS/Android connect as peripherals and expose local tools (
system.run,canvas,camera). - Agents (workers): separate brains/workspaces for special roles (for example ops vs personal data).
- Sub-agents: spawn background work from a main agent for parallelism.
- TUI: connect to the Gateway and switch agents/sessions.
Can the OpenClaw browser run headless?
Can the OpenClaw browser run headless?
false (headful). Headless is more likely to trigger anti-bot checks on some sites (X/Twitter often blocks headless sessions). It uses the same Chromium engine and works for most automation; the main difference is no visible browser window (use screenshots for visuals). See Browser.How do I use Brave for browser control?
How do I use Brave for browser control?
browser.executablePath to your Brave binary (or any Chromium-based browser) and restart the Gateway. See Browser.Remote gateways and nodes
How do commands propagate between Telegram, the gateway, and nodes?
How do commands propagate between Telegram, the gateway, and nodes?
node.* -> Node -> Gateway -> TelegramNodes do not see inbound provider traffic; they only receive node RPC calls.How can my agent access my computer if the Gateway is hosted remotely?
How can my agent access my computer if the Gateway is hosted remotely?
node.* tools (screen, camera, system) on your local machine over the Gateway WebSocket.- Run the Gateway on the always-on host (VPS/home server).
- Put the Gateway host and your computer on the same tailnet.
- Ensure the Gateway WS is reachable (tailnet bind or SSH tunnel).
- Open the macOS app locally and connect in Remote over SSH mode (or direct tailnet) so it registers as a node.
- Approve the node:
system.run on that machine. Only pair devices you trust; review Security.Docs: Nodes, Gateway protocol, macOS remote mode, Security.Tailscale is connected but I get no replies. What now?
Tailscale is connected but I get no replies. What now?
gateway.auth.allowTailscale is set correctly; if you connect via SSH tunnel, confirm the tunnel is up and points at the right port; confirm your DM/group allowlists include your account.Docs: Tailscale, Remote access, Channels.Can two OpenClaw instances talk to each other (local + VPS)?
Can two OpenClaw instances talk to each other (local + VPS)?
openclaw agent --message ... --deliver, targeting a chat where the other bot listens. If one bot is on a remote VPS, point your CLI at that remote Gateway via SSH/Tailscale (see Remote access):Do I need separate VPSes for multiple agents?
Do I need separate VPSes for multiple agents?
Is there a benefit to using a node on my personal laptop instead of SSH from a VPS?
Is there a benefit to using a node on my personal laptop instead of SSH from a VPS?
- No inbound SSH required - nodes connect out to the Gateway WebSocket via device pairing.
- Safer execution controls -
system.runis gated by node allowlists/approvals on that laptop. - More device tools - nodes expose
canvas,camera, andscreenin addition tosystem.run. - Local browser automation - keep the Gateway on a VPS but run Chrome locally through a node host, or attach to local Chrome via Chrome MCP.
Do nodes run a gateway service?
Do nodes run a gateway service?
gateway, discovery, and hosted plugin surface changes.Is there an API / RPC way to apply config?
Is there an API / RPC way to apply config?
config.schema.lookup: inspect one config subtree with its shallow schema node, matched UI hint, and immediate child summaries before writing.config.get: fetch the current snapshot plus hash.config.patch: safe partial update (preferred for most RPC edits); hot-reloads when possible, restarts when required.config.apply: validate and replace the full config; hot-reloads when possible, restarts when required.- The agent-facing
gatewayruntime tool still refuses to rewritetools.exec.ask/tools.exec.security; legacytools.bash.*aliases normalize to the same protected paths.
Minimal sane config for a first install
Minimal sane config for a first install
How do I set up Tailscale on a VPS and connect from my Mac?
How do I set up Tailscale on a VPS and connect from my Mac?
- Install + login on the VPS:
- Install + login on your Mac using the Tailscale app, same tailnet.
- Enable MagicDNS in the Tailscale admin console so the VPS has a stable name.
- Use the tailnet hostname: SSH
ssh user@your-vps.tailnet-xxxx.ts.net; Gateway WSws://your-vps.tailnet-xxxx.ts.net:18789.
How do I connect a Mac node to a remote Gateway (Tailscale Serve)?
How do I connect a Mac node to a remote Gateway (Tailscale Serve)?
- Make sure the VPS and Mac are on the same tailnet.
- Use the macOS app in Remote mode (SSH target can be the tailnet hostname) - it tunnels the Gateway port and connects as a node.
- Approve the node:
Should I install on a second laptop or just add a node?
Should I install on a second laptop or just add a node?
Env vars and .env loading
How does OpenClaw load environment variables?
How does OpenClaw load environment variables?
.envfrom the current working directory.- a global fallback
.envfrom~/.openclaw/.env($OPENCLAW_STATE_DIR/.env).
.env file overrides existing env vars. Provider credential keys are an exception for workspace .env: keys such as GEMINI_API_KEY, XAI_API_KEY, or MISTRAL_API_KEY (and other bundled-provider auth env vars) are ignored from workspace .env and should live in the process environment, ~/.openclaw/.env, or config env.Inline env vars in config apply only if missing from the process env:I started the Gateway via the service and my env vars disappeared. What now?
I started the Gateway via the service and my env vars disappeared. What now?
- Put the missing keys in
~/.openclaw/.envso they load even when the service does not inherit your shell env. - Enable shell import (opt-in convenience):
This runs your login shell and imports only missing expected keys (never overrides). Env var equivalents:
OPENCLAW_LOAD_SHELL_ENV=1,OPENCLAW_SHELL_ENV_TIMEOUT_MS=15000.
I set COPILOT_GITHUB_TOKEN, but models status shows "Shell env: off." Why?
I set COPILOT_GITHUB_TOKEN, but models status shows "Shell env: off." Why?
openclaw models status reports whether shell env import is enabled. “Shell env: off” does not mean your env vars are missing - it just means OpenClaw will not load your login shell automatically.If the Gateway runs as a service (launchd/systemd), it will not inherit your shell environment. Fix by putting the token in ~/.openclaw/.env, enabling env.shellEnv.enabled: true, or adding it to config env (applies only if missing), then restarting the gateway and rechecking:OPENCLAW_GITHUB_TOKEN, then COPILOT_GITHUB_TOKEN, then GH_TOKEN, then GITHUB_TOKEN.See /concepts/model-providers and /environment.Sessions and multiple chats
How do I start a fresh conversation?
How do I start a fresh conversation?
/new or /reset as a standalone message. See Session management.Do sessions reset automatically if I never send /new?
Do sessions reset automatically if I never send /new?
session.reset.atHour, default 4, 0-23), based on when the current session started. Switch to idle-based reset instead with mode: "idle" and session.reset.idleMinutes, which expires a session after a period of inactivity (based on the last real interaction, not heartbeat/cron/exec system events).resetByType supports direct (legacy alias dm), group, and thread. Legacy top-level session.idleMinutes still works as a compatibility alias for an idle-mode default when no session.reset/resetByType block is set. Sessions with an active provider-owned CLI session are not cut by the implicit daily default. See Session management for the full lifecycle.Is there a way to make a team of OpenClaw instances (one CEO and many agents)?
Is there a way to make a team of OpenClaw instances (one CEO and many agents)?
Why did context get truncated mid-task? How do I prevent it?
Why did context get truncated mid-task? How do I prevent it?
- Ask the bot to summarize current state and write it to a file.
- Use
/compactbefore long tasks,/newwhen switching topics. - Keep important context in the workspace and ask the bot to read it back.
- Use sub-agents for long or parallel work so the main chat stays smaller.
- Pick a model with a larger context window if this happens often.
How do I completely reset OpenClaw but keep it installed?
How do I completely reset OpenClaw but keep it installed?
--profile / OPENCLAW_PROFILE), reset each state dir (default ~/.openclaw-<profile>). Dev-only reset: openclaw gateway --dev --reset wipes dev config, credentials, sessions, and workspace.I am getting "context too large" errors - how do I reset or compact?
I am getting "context too large" errors - how do I reset or compact?
- Compact (keeps the conversation, summarizes older turns):
/compactor/compact <instructions>to guide the summary. - Reset (fresh session ID for the same chat key):
/newor/reset.
agents.defaults.contextPruning) to trim old tool output, or use a model with a larger context window.Docs: Compaction, Session pruning, Session management.Why am I seeing "LLM request rejected: messages.content.tool_use.input field required"?
Why am I seeing "LLM request rejected: messages.content.tool_use.input field required"?
tool_use block without the required input. Usually means the session history is stale or corrupted (often after long threads or a tool/schema change).Fix: start a fresh session with /new (standalone message).Why am I getting heartbeat messages every 30 minutes?
Why am I getting heartbeat messages every 30 minutes?
heartbeat.every is unset. Tune or disable:HEARTBEAT.md exists but is effectively empty (only blank lines, Markdown/HTML comments, ATX headings, fence markers, or empty list-item stubs), OpenClaw skips the heartbeat run to save API calls. If the file is missing, the heartbeat still runs and the model decides what to do.Per-agent overrides use agents.list[].heartbeat. Docs: Heartbeat.Do I need to add a "bot account" to a WhatsApp group?
Do I need to add a "bot account" to a WhatsApp group?
groupPolicy: "allowlist").To restrict group replies to only you:How do I get the JID of a WhatsApp group?
How do I get the JID of a WhatsApp group?
Why does OpenClaw not reply in a group?
Why does OpenClaw not reply in a group?
mentionPatterns), or you configured channels.whatsapp.groups without "*" and the group is not allowlisted.See Groups and Group messages.How many workspaces and agents can I create?
How many workspaces and agents can I create?
- Disk growth: sessions and transcripts live under
~/.openclaw/agents/<agentId>/sessions/. - Token cost: more agents means more concurrent model usage.
- Ops overhead: per-agent auth profiles, workspaces, and channel routing.
agents.defaults.workspace), prune old sessions if disk grows, and use openclaw doctor to spot stray workspaces and profile mismatches.Can I run multiple bots or chats at the same time (Slack), and how should I set that up?
Can I run multiple bots or chats at the same time (Slack), and how should I set that up?
Models, failover, and auth profiles
Model Q&A - defaults, selection, aliases, switching, failover, auth profiles - lives on the Models FAQ.Gateway: ports, “already running”, and remote mode
What port does the Gateway use?
What port does the Gateway use?
gateway.port controls the single multiplexed port for WebSocket + HTTP (Control UI, hooks, etc.). Precedence:Why does openclaw gateway status say "Runtime: running" but "Connectivity probe: failed"?
Why does openclaw gateway status say "Runtime: running" but "Connectivity probe: failed"?
openclaw gateway status: Probe target: (the URL the probe used), Listening: (what is actually bound on the port), Last gateway error: (common root cause when the process is alive but the port is not listening).Why does openclaw gateway status show "Config (cli)" and "Config (service)" different?
Why does openclaw gateway status show "Config (cli)" and "Config (service)" different?
--profile / OPENCLAW_STATE_DIR mismatch).Fix, run from the same --profile / environment you want the service to use:What does "another gateway instance is already listening" mean?
What does "another gateway instance is already listening" mean?
ws://127.0.0.1:18789). If the bind fails with EADDRINUSE, it throws GatewayLockError (“another gateway instance is already listening”).Fix: stop the other instance, free the port, or run with openclaw gateway --port <port>.How do I run OpenClaw in remote mode (client connects to a Gateway elsewhere)?
How do I run OpenClaw in remote mode (client connects to a Gateway elsewhere)?
gateway.mode: "remote" and point to a remote WebSocket URL, optionally with shared-secret remote credentials:openclaw gatewayonly starts whengateway.modeislocal(or you pass an override flag).- The macOS app watches the config file and switches modes live when these values change.
gateway.remote.token/.passwordare client-side remote credentials only; they do not enable local gateway auth by themselves.
I set gateway.bind tailnet but it cannot bind and nothing listens
I set gateway.bind tailnet but it cannot bind and nothing listens
tailnet bind picks a Tailscale IP from your network interfaces (100.64.0.0/10). If the machine is not on Tailscale (or the interface is down), there is nothing to bind to.Fix: start Tailscale on that host, or switch to gateway.bind: "loopback" / "lan".tailnet is explicit; auto prefers loopback. Use gateway.bind: "tailnet" for a tailnet-only bind.Can I run multiple Gateways on the same host?
Can I run multiple Gateways on the same host?
OPENCLAW_CONFIG_PATH, OPENCLAW_STATE_DIR, agents.defaults.workspace, and unique gateway.port.Recommended: openclaw --profile <name> ... per instance (auto-creates ~/.openclaw-<name>), a unique gateway.port per profile config (or --port for manual runs), and a per-profile service with openclaw --profile <name> gateway install.Profiles also suffix service names: launchd ai.openclaw.<profile>, systemd openclaw-gateway-<profile>.service, Windows OpenClaw Gateway (<profile>). The unqualified openclaw-gateway systemd unit only exists for the default profile; the legacy pre-rename systemd unit name clawdbot-gateway is migrated automatically.Full guide: Multiple gateways.What does "invalid handshake" / code 1008 mean?
What does "invalid handshake" / code 1008 mean?
connect frame. Anything else closes the connection with code 1008 (policy violation).Common causes: you opened the HTTP URL in a browser instead of a WS client, used the wrong port/path, or a proxy/tunnel stripped auth headers or sent a non-Gateway request.Fix: use the WS URL (ws://<host>:18789, or wss://... over HTTPS), do not open the WS port in a normal browser tab, and include the token/password in the connect frame when auth is on. CLI/TUI example:Logging and debugging
Where are logs?
Where are logs?
/tmp/openclaw/openclaw-YYYY-MM-DD.log. Set a stable path via logging.file; file log level via logging.level; console verbosity via --verbose and logging.consoleLevel.Fastest tail:- macOS launchd stdout:
~/Library/Logs/openclaw/gateway.log(profiles usegateway-<profile>.log; stderr is suppressed). - Linux:
journalctl --user -u openclaw-gateway[-<profile>].service -n 200 --no-pager. - Windows:
schtasks /Query /TN "OpenClaw Gateway (<profile>)" /V /FO LIST.
How do I start/stop/restart the Gateway service?
How do I start/stop/restart the Gateway service?
openclaw gateway --force can reclaim the port. See Gateway.I closed my terminal on Windows - how do I restart OpenClaw?
I closed my terminal on Windows - how do I restart OpenClaw?
openclaw gateway run.3) Native Windows CLI/Gateway: runs directly in Windows.openclaw gateway run.Docs: Windows, Gateway service runbook.The Gateway is up but replies never arrive. What should I check?
The Gateway is up but replies never arrive. What should I check?
models status), channel pairing/allowlist blocking replies (check channel config and logs), or WebChat/Dashboard open without the right token. If remote, confirm the tunnel/Tailscale connection is up and the Gateway WebSocket is reachable.Docs: Channels, Troubleshooting, Remote access."Disconnected from gateway: no reason" - what now?
"Disconnected from gateway: no reason" - what now?
openclaw gateway status)? Is it healthy (openclaw status)? Does the UI have the right token (openclaw dashboard)? If remote, is the tunnel/Tailscale link up?Then tail logs:Telegram setMyCommands fails. What should I check?
Telegram setMyCommands fails. What should I check?
BOT_COMMANDS_TOO_MUCH: the Telegram menu has too many entries. OpenClaw already trims to the Telegram limit and retries with fewer commands, but some menu entries may still be dropped. Reduce plugin/skill/custom commands, or disablechannels.telegram.commands.nativeif you do not need the menu.TypeError: fetch failed,Network request for 'setMyCommands' failed!, or similar network errors: on a VPS or behind a proxy, confirm outbound HTTPS is allowed and DNS works forapi.telegram.org.
TUI shows no output. What should I check?
TUI shows no output. What should I check?
/status to see the current state. If you expect replies in a chat channel, confirm delivery is enabled (/deliver on).Docs: TUI, Slash commands.How do I completely stop then start the Gateway?
How do I completely stop then start the Gateway?
openclaw gateway run.Docs: Gateway service runbook.ELI5: openclaw gateway restart vs openclaw gateway
ELI5: openclaw gateway restart vs openclaw gateway
openclaw gateway restart restarts the background service (launchd/systemd). openclaw gateway runs the gateway in the foreground for this terminal session. Use the gateway subcommands if you installed the service; use the bare foreground run for a one-off.Fastest way to get more details when something fails
Fastest way to get more details when something fails
--verbose for more console detail, then inspect the log file for channel auth, model routing, and RPC errors.Media and attachments
My skill generated an image/PDF, but nothing was sent
My skill generated an image/PDF, but nothing was sent
media, mediaUrl, path, or filePath. See OpenClaw assistant setup and Agent send.tools.fs.workspaceOnly=true limits local-path sends to workspace, temp/media-store, and sandbox-validated files; tools.fs.workspaceOnly=false (default) lets structured local media sends use host-local files the agent can already read, for media plus safe document types (images, audio, video, PDF, Office docs, and validated text documents such as Markdown/MD, TXT, JSON, YAML/YML). This is not a secret scanner - an agent-readable secret.txt or config.json can be attached when the extension and content validation match. Keep sensitive files outside agent-readable paths, or keep tools.fs.workspaceOnly=true for stricter local-path sends.See Images.Security and access control
Is it safe to expose OpenClaw to inbound DMs?
Is it safe to expose OpenClaw to inbound DMs?
- Default behavior on DM-capable channels is pairing: unknown senders receive a pairing code and their message is not processed. Approve with
openclaw pairing approve --channel <channel> [--account <id>] <code>. Pending requests are capped at 3 per channel; checkopenclaw pairing list --channel <channel> [--account <id>]if a code did not arrive. - Opening DMs publicly requires explicit opt-in (
dmPolicy: "open"and allowlist"*").
openclaw doctor to surface risky DM policies.Is prompt injection only a concern for public bots?
Is prompt injection only a concern for public bots?
- use a read-only or tool-disabled “reader” agent to summarize untrusted content
- keep
web_search/web_fetch/browseroff for tool-enabled agents - treat decoded file/document text as untrusted too: OpenResponses
input_fileand media-attachment extraction both wrap extracted text in explicit external-content boundary markers instead of passing raw file text - sandbox and use strict tool allowlists
Is OpenClaw less safe because it uses TypeScript/Node instead of Rust/WASM?
Is OpenClaw less safe because it uses TypeScript/Node instead of Rust/WASM?
openclaw security audit --deep after config changes.Details: Security, Sandboxing.I saw reports about exposed OpenClaw instances. What should I check?
I saw reports about exposed OpenClaw instances. What should I check?
loopback, or exposed only through authenticated private access (tailnet, SSH tunnel, token/password auth, or a correctly configured trusted proxy); DMs in pairing or allowlist mode; groups allowlisted and mention-gated unless every member is trusted; high-risk tools (exec, browser, gateway, cron) denied or tightly scoped for agents that read untrusted content; sandboxing enabled where tool execution needs a smaller blast radius.Public binds without auth, open DMs/groups with tools, and exposed browser control are the findings to fix first. Details: openclaw security audit.Are ClawHub skills and third-party plugins safe to install?
Are ClawHub skills and third-party plugins safe to install?
security.installPolicy for local allow/block decisions.Safer pattern: prefer trusted authors and pinned versions, read the skill/plugin before enabling it, keep plugin/skill allowlists narrow, run untrusted-input workflows in a sandbox with minimal tools, and avoid giving third-party code broad filesystem, exec, browser, or secret access.Details: Skills, Plugins, Security.Should my bot have its own email, GitHub account, or phone number?
Should my bot have its own email, GitHub account, or phone number?
Can I give it autonomy over my text messages and is that safe?
Can I give it autonomy over my text messages and is that safe?
Can I use cheaper models for personal assistant tasks?
Can I use cheaper models for personal assistant tasks?
I ran /start in Telegram but did not get a pairing code
I ran /start in Telegram but did not get a pairing code
dmPolicy: "pairing" is enabled; /start by itself does not generate a code.Check pending requests:dmPolicy: "open" for that account.WhatsApp: will it message my contacts? How does pairing work?
WhatsApp: will it message my contacts? How does pairing work?
channels.whatsapp.selfChatMode.Chat commands, aborting tasks, and “it will not stop”
How do I stop internal system messages from showing in chat?
How do I stop internal system messages from showing in chat?
verboseDefault: "on" in config.Docs: Thinking and verbose, Security.How do I stop/cancel a running task?
How do I stop/cancel a running task?
stop, stop action, stop current action, stop run, stop current run, stop agent, stop the agent, stop openclaw, openclaw stop, stop don't do anything, stop do not do anything, stop doing anything, do not do that, please stop, stop please, abort, esc, exit, interrupt, halt. Common non-English triggers (French, German, Spanish, Chinese, Japanese, Hindi, Arabic, Russian) also work.For background processes started by the exec tool, ask the agent to run:/, but a few shortcuts (like /status) also work inline for allowlisted senders. See Slash commands.How do I send a Discord message from Telegram? ("Cross-context messaging denied")
How do I send a Discord message from Telegram? ("Cross-context messaging denied")
Why does it feel like the bot "ignores" rapid-fire messages?
Why does it feel like the bot "ignores" rapid-fire messages?
/queue to choose active-run behavior:steer(default) - guide the active run at the next model boundary.followup- queue messages and run them one at a time after the current run ends.collect- queue compatible messages and reply once after the current run ends.interrupt- abort the current run and start fresh.
debounce:0.5s cap:25 drop:summarize. See Command queue and Steering queue.Miscellaneous
What is the default model for Anthropic with an API key?
What is the default model for Anthropic with an API key?
ANTHROPIC_API_KEY (or storing an Anthropic API key in auth profiles) enables authentication, but the actual default model is whatever you configure in agents.defaults.model.primary (for example anthropic/claude-sonnet-4-6 or anthropic/claude-opus-4-6). No credentials found for profile "anthropic:default" means the Gateway could not find Anthropic credentials in the expected auth-profiles.json for the running agent.Still stuck? Ask in Discord or open a GitHub discussion.
Related
- First-run FAQ - install, onboard, auth, subscriptions, early failures
- Models FAQ - model selection, failover, auth profiles
- Troubleshooting - symptom-first triage