Quick start and first-run setup
I am stuck, fastest way to get unstuck
I am stuck, fastest way to get unstuck
- Claude Code: https://www.anthropic.com/claude-code/
- OpenAI Codex: https://openai.com/codex/
| Command | Shows |
|---|---|
openclaw status | Gateway/agent health + basic config snapshot |
openclaw status --all | Full read-only diagnosis, pasteable |
openclaw models status | Provider auth + model availability |
openclaw doctor | Validates and repairs common config/state issues |
openclaw logs --follow | Live log tail |
openclaw gateway status --deep | Deep gateway/config/plugin health check |
openclaw health --verbose | Detailed health report |
Heartbeat keeps skipping. What do the skip reasons mean?
Heartbeat keeps skipping. What do the skip reasons mean?
| Skip reason | Meaning |
|---|---|
quiet-hours | Outside the configured active-hours window |
empty-heartbeat-file | HEARTBEAT.md exists but only has blank, comment, header, fence, or empty-checklist scaffolding |
no-tasks-due | Task mode is active but no task interval is due yet |
alerts-disabled | All heartbeat visibility is off (showOk, showAlerts, and useIndicator all disabled) |
Recommended way to install and set up OpenClaw
Recommended way to install and set up OpenClaw
pnpm openclaw onboard instead. If Control UI assets are
missing, onboarding tries to build them itself, falling back to pnpm ui:build.How do I open the dashboard after onboarding?
How do I open the dashboard after onboarding?
How do I authenticate the dashboard on localhost vs remote?
How do I authenticate the dashboard on localhost vs remote?
- Open
http://127.0.0.1:18789/. - If it asks for shared-secret auth, paste the configured token or password into Control UI settings.
- Token source:
gateway.auth.token(orOPENCLAW_GATEWAY_TOKEN). - Password source:
gateway.auth.password(orOPENCLAW_GATEWAY_PASSWORD). - No shared secret configured yet? Run
openclaw doctor --generate-gateway-token(oropenclaw doctor --fix --generate-gateway-token).
- Tailscale Serve (recommended): keep bind loopback, run
openclaw gateway --tailscale serve, openhttps://<magicdns>/. Withgateway.auth.allowTailscale: true, identity headers satisfy Control UI/WebSocket auth (no pasted shared secret, assumes a trusted gateway host); HTTP APIs still need shared-secret auth unless you deliberately use private-ingressnoneor trusted-proxy HTTP auth. Concurrent bad-auth Serve attempts from the same client are serialized before the failed-auth limiter records them, so a second bad retry can already showretry later. - Tailnet bind: run
openclaw gateway --bind tailnet --token "<token>"(or configure password auth), openhttp://<tailscale-ip>:18789/, paste the matching shared secret in dashboard settings. - Identity-aware reverse proxy: keep the Gateway behind a trusted proxy, set
gateway.auth.mode: "trusted-proxy", open the proxy URL. Same-host loopback proxies need explicitgateway.auth.trustedProxy.allowLoopback: true. - SSH tunnel:
ssh -N -L 18789:127.0.0.1:18789 user@gateway-host, then openhttp://127.0.0.1:18789/. Shared-secret auth still applies over the tunnel; paste the configured token or password if prompted.
Why are there two exec approval configs for chat approvals?
Why are there two exec approval configs for chat approvals?
approvals.exec- forwards approval prompts to chat destinations.channels.<channel>.execApprovals- makes that channel a native approval client for exec approvals.
- If the chat already supports commands and replies, same-chat
/approveworks through the shared path. - When a supported native channel can infer approvers safely, OpenClaw auto-enables DM-first native approvals if
channels.<channel>.execApprovals.enabledis unset or"auto". - When native approval cards/buttons are available, that UI is primary; only mention a manual
/approvecommand if the tool result says chat approvals are unavailable. - Use
approvals.execonly when prompts must also reach other chats or explicit ops rooms. - Use
channels.<channel>.execApprovals.target: "channel"or"both"only when you want approval prompts posted back into the originating room/topic. - Plugin approvals are separate: same-chat
/approveby default, optionalapprovals.pluginforwarding, and only some native channels keep native handling for those too.
What runtime do I need?
What runtime do I need?
pnpm is the repo package manager.
Bun is not recommended for the Gateway.Does it run on Raspberry Pi?
Does it run on Raspberry Pi?
| Model | RAM | Fit |
|---|---|---|
| Pi 5 | 4/8 GB | Best |
| Pi 4 | 4 GB | Good |
| Pi 4 | 2 GB | OK, add swap |
| Pi 4 | 1 GB | Tight |
| Pi 3B+ | 1 GB | Slow |
| Pi Zero 2 W | 512 MB | Not recommended |
Any tips for Raspberry Pi installs?
Any tips for Raspberry Pi installs?
- Use a 64-bit OS; do not use 32-bit Raspberry Pi OS.
- Add swap on 2 GB or smaller boards.
- Prefer a USB SSD over an SD card for performance and longevity.
- Prefer the hackable (git) install so you can see logs and update fast.
- Start without channels/skills, add them one by one.
- Weird binary failures (“exec format error”) are usually a missing ARM64 build for an optional skill tool.
It is stuck on wake up my friend / onboarding will not hatch. What now?
It is stuck on wake up my friend / onboarding will not hatch. What now?
openclaw configure --section model.
If you see the wake-up line with no reply and tokens stay at 0, the agent never ran.- Restart the Gateway:
- Check status + auth:
- Still hanging? Run:
Can I migrate my setup to a new machine without redoing onboarding?
Can I migrate my setup to a new machine without redoing onboarding?
- Install OpenClaw on the new machine.
- Copy
$OPENCLAW_STATE_DIR(default:~/.openclaw) from the old machine. - Copy your workspace (default:
~/.openclaw/workspace). - Run
openclaw doctorand restart the Gateway service.
~/.openclaw/ (for example ~/.openclaw/agents/<agentId>/sessions/).Related: Migrating, Where things live on disk,
Agent workspace, Doctor,
Remote mode.Where do I see what is new in the latest version?
Where do I see what is new in the latest version?
Cannot access docs.openclaw.ai (SSL error)
Cannot access docs.openclaw.ai (SSL error)
docs.openclaw.ai via Xfinity
Advanced Security. Disable it or allowlist docs.openclaw.ai, then retry. Help us
get it unblocked: https://spa.xfinity.com/check_url_status.Still blocked? Docs are mirrored on GitHub:
https://github.com/openclaw/openclaw/tree/main/docsDifference between stable and beta
Difference between stable and beta
latest= stablebeta= early build for testing (falls back tolatestwhen beta is missing or older than the current stable release)
latest without changing the version number. Maintainers
can also publish straight to latest. That is why beta and stable can point at the
same version after promotion.See what changed: CHANGELOG.md.For install one-liners and the difference between beta and dev, see the next accordion.How do I install the beta version and what is the difference between beta and dev?
How do I install the beta version and what is the difference between beta and dev?
beta (may match latest after promotion).
Dev is the moving head of main (git); when published to npm it uses dist-tag dev.One-liners (macOS/Linux):iwr -useb https://openclaw.ai/install.ps1 | iexMore detail: Development channels and Installer flags.How do I try the latest bits?
How do I try the latest bits?
- Dev channel (existing install):
main, rebases on upstream, builds, and installs
the CLI from that checkout.- Hackable (git) install (fresh machine):
How long does install and onboarding usually take?
How long does install and onboarding usually take?
- Install: 2-5 minutes.
- QuickStart onboarding: a few minutes (loopback gateway, auto token, default workspace).
- Advanced/full onboarding: longer when provider sign-in, channel pairing, daemon install, network downloads, or skills need extra setup.
openclaw configure.Hanging? See I am stuck above.Installer stuck? How do I get more feedback?
Installer stuck? How do I get more feedback?
--verbose:install.ps1 has no dedicated verbose switch; wrap it in Set-PSDebug -Trace 1 /
-Trace 0 instead. Full flag reference: Installer flags.Windows install says git not found or openclaw not recognized
Windows install says git not found or openclaw not recognized
- Install Git for Windows, make sure
gitis on PATH. - Close and reopen PowerShell, then re-run the installer.
- Your npm global bin folder is not on PATH.
- Check it:
npm config get prefix. - Add that directory to your user PATH (no
\binsuffix needed; on most systems it is%AppData%\npm). - Close and reopen PowerShell.
Windows exec output shows garbled Chinese text - what should I do?
Windows exec output shows garbled Chinese text - what should I do?
system.run/exec output renders Chinese as mojibake; the same command
looks fine in another terminal profile.Workaround in PowerShell:The docs did not answer my question - how do I get a better answer?
The docs did not answer my question - how do I get a better answer?
How do I install OpenClaw on Linux?
How do I install OpenClaw on Linux?
- Linux quick path + service install: Linux.
- Full walkthrough: Getting Started.
- Installer + updates: Install & updates.
How do I install OpenClaw on a VPS?
How do I install OpenClaw on a VPS?
Where are the cloud/VPS install guides?
Where are the cloud/VPS install guides?
- VPS hosting (all providers in one place)
- Fly.io
- Hetzner
- exe.dev
Can I ask OpenClaw to update itself?
Can I ask OpenClaw to update itself?
What does onboarding actually do?
What does onboarding actually do?
openclaw onboard is the recommended setup path. In local mode it walks through:- Model/Auth - provider OAuth, API keys, or manual auth (including local options like LM Studio); pick a default model.
- Workspace - location + bootstrap files.
- Gateway - port, bind address, auth mode, Tailscale exposure.
- Channels - built-in and official plugin chat channels: iMessage, Discord, Feishu, Google Chat, Mattermost, Microsoft Teams, QQ Bot, Signal, Slack, Telegram, WhatsApp, and more.
- Daemon - LaunchAgent (macOS), systemd user unit (Linux/WSL2), or native Windows Scheduled Task.
- Health check - starts the Gateway and verifies it is running.
- Skills - installs recommended skills and optional dependencies.
Do I need a Claude or OpenAI subscription to run this?
Do I need a Claude or OpenAI subscription to run this?
claude -p path as Agent SDK/programmatic usage that
still draws from your subscription’s plan limits - check current Anthropic billing
docs before relying on subscription behavior. For long-lived gateway hosts and shared
automation, an Anthropic API key is the more predictable choice.OpenAI Codex OAuth (ChatGPT/Codex subscription) is fully supported for agent models.
OpenClaw also supports hosted subscription-style options including Qwen Cloud
Coding Plan, MiniMax Coding Plan, and Z.AI / GLM Coding Plan.Docs: Anthropic, OpenAI,
Qwen Cloud, MiniMax, Z.AI (GLM),
Local models, Models.Can I use Claude Max subscription without an API key?
Can I use Claude Max subscription without an API key?
claude -p path OpenClaw uses as subscription-plan usage subject
to your plan’s limits, not a separate free allowance - see
Anthropic for the current billing detail and links to
Anthropic’s own support articles. For the most predictable server-side setup, use an
Anthropic API key instead.Do you support Claude subscription auth (Claude Pro or Max)?
Do you support Claude subscription auth (Claude Pro or Max)?
claude -p/Agent SDK usage
has changed over time; see Anthropic for the current state and
dated links to Anthropic’s support articles before relying on specific billing
behavior.Anthropic setup-token auth is also still a supported token path, but OpenClaw prefers
Claude CLI reuse and claude -p when available. For production or multi-user
workloads, an Anthropic API key remains the safer, more predictable choice. Other
subscription-style hosted options: OpenAI, Qwen Cloud,
MiniMax, Z.AI (GLM).Why am I seeing HTTP 429 rate_limit_error from Anthropic?
Why am I seeing HTTP 429 rate_limit_error from Anthropic?
Extra usage is required for long context requests,
the request is trying to use Anthropic’s 1M context window (a GA-capable 1M Claude 4.x
model, or legacy params.context1m: true config), and your current credential is not
eligible for long-context billing.Set a fallback model so OpenClaw keeps replying while a provider is rate-limited.
See Models, OAuth, and
Anthropic 429 extra usage required for long context.Is AWS Bedrock supported?
Is AWS Bedrock supported?
AWS_ACCESS_KEY_ID, AWS_PROFILE, AWS_BEARER_TOKEN_BEDROCK),
OpenClaw auto-enables the implicit Bedrock provider for model discovery; otherwise
set plugins.entries.amazon-bedrock.config.discovery.enabled: true or add a manual
provider entry. See Amazon Bedrock and Model providers.
An OpenAI-compatible proxy in front of Bedrock is still a valid option if you prefer a managed key flow.How does Codex auth work?
How does Codex auth work?
openai/gpt-5.5
for the default setup: ChatGPT/Codex subscription auth plus native Codex app-server
execution. Legacy Codex-prefixed model refs are legacy config repaired by
openclaw doctor --fix. Direct OpenAI API-key access remains available for non-agent
OpenAI API surfaces and, through an ordered openai API-key profile, for agent models
too. See Model providers and Onboarding (CLI).Why does OpenClaw still mention legacy OpenAI Codex prefix?
Why does OpenClaw still mention legacy OpenAI Codex prefix?
openai is the current provider and auth-profile id for both OpenAI API keys and
ChatGPT/Codex OAuth - OpenAI Codex is folded into it. You may still see a legacy
openai-codex prefix in older config and migration warnings:openai/gpt-5.5= ChatGPT/Codex subscription auth with native Codex runtime for agent turns.- Legacy
openai-codex/*model refs = legacy route repaired byopenclaw doctor --fix. openai/gpt-5.5plus an orderedopenaiAPI-key profile = API-key auth for an OpenAI agent model.- Legacy
openai-codexauth profile ids = legacy ids migrated byopenclaw doctor --fix.
OPENAI_API_KEY. Want ChatGPT/Codex
subscription auth? Run openclaw models auth login --provider openai. Keep the model
ref as openai/gpt-5.5; legacy Codex-prefixed refs are what openclaw doctor --fix rewrites.Why can Codex OAuth limits differ from ChatGPT web?
Why can Codex OAuth limits differ from ChatGPT web?
openclaw models status shows the currently visible provider usage/quota windows, but
does not invent or normalize ChatGPT-web entitlements into direct API access. For the
direct OpenAI Platform billing/limit path, use openai/* with an API key.Do you support OpenAI subscription auth (Codex OAuth)?
Do you support OpenAI subscription auth (Codex OAuth)?
How do I set up Gemini CLI OAuth?
How do I set up Gemini CLI OAuth?
openclaw.json.- Install Gemini CLI locally so
geminiis onPATH:- Homebrew:
brew install gemini-cli - npm:
npm install -g @google/gemini-cli
- Homebrew:
- Enable the plugin:
openclaw plugins enable google - Login:
openclaw models auth login --provider google-gemini-cli --set-default - Default model after login:
google/gemini-3.1-pro-preview(runtimegoogle-gemini-cli) - Requests failing after login? Set
GOOGLE_CLOUD_PROJECTorGOOGLE_CLOUD_PROJECT_IDon the gateway host and retry.
Is a local model OK for casual chats?
Is a local model OK for casual chats?
How do I keep hosted model traffic in a specific region?
How do I keep hosted model traffic in a specific region?
models.mode: "merge" so fallbacks stay
available while respecting the regioned provider you select.Do I have to buy a Mac Mini to install this?
Do I have to buy a Mac Mini to install this?
imsg on any Mac signed into Messages - if the Gateway runs on Linux or elsewhere,
set channels.imessage.cliPath to an SSH wrapper that runs imsg on that Mac. For other
macOS-only tools, run the Gateway on a Mac or pair a macOS node.Docs: iMessage, Nodes, Mac remote mode.Do I need a Mac mini for iMessage support?
Do I need a Mac mini for iMessage support?
imsg; the Gateway can run on that
Mac, or elsewhere with an SSH wrapper cliPath.Common setups:- Gateway on Linux/VPS,
channels.imessage.cliPathset to an SSH wrapper that runsimsgon a Mac signed into Messages. - Everything on one Mac for the simplest single-machine setup.
If I buy a Mac mini to run OpenClaw, can I connect it to my MacBook Pro?
If I buy a Mac mini to run OpenClaw, can I connect it to my MacBook Pro?
system.run on that device.Common pattern: Gateway on the always-on Mac mini; MacBook Pro runs the macOS app or a
node host and pairs to the Gateway. Check with openclaw nodes status / openclaw nodes list.Docs: Nodes, Nodes CLI.Can I use Bun?
Can I use Bun?
Telegram: what goes in allowFrom?
Telegram: what goes in allowFrom?
channels.telegram.allowFrom is the human sender’s Telegram user ID (numeric),
not the bot username. Setup asks for numeric user IDs only; openclaw doctor --fix
can try to resolve legacy @username entries.Safer (no third-party bot): DM your bot, run openclaw logs --follow, read from.id.Official Bot API: DM your bot, call https://api.telegram.org/bot<bot_token>/getUpdates, read message.from.id.Third-party (less private): DM @userinfobot or @getidsbot.See Telegram access control.Can multiple people use one WhatsApp number with different OpenClaw instances?
Can multiple people use one WhatsApp number with different OpenClaw instances?
peer: { kind: "direct", id: "+15551234567" }) to a different agentId, giving each person their own workspace and session store. Replies still come from the same WhatsApp account; DM access control (channels.whatsapp.dmPolicy / channels.whatsapp.allowFrom) is global per account. See Multi-Agent Routing and WhatsApp.Can I run a "fast chat" agent and an "Opus for coding" agent?
Can I run a "fast chat" agent and an "Opus for coding" agent?
Does Homebrew work on Linux?
Does Homebrew work on Linux?
/home/linuxbrew/.linuxbrew/bin (or your brew prefix) so brew-installed tools
resolve in non-login shells. Recent builds also prepend common user bin dirs on Linux
systemd services (for example ~/.local/bin, ~/.npm-global/bin,
~/.local/share/pnpm, ~/.bun/bin) and honor PNPM_HOME, NPM_CONFIG_PREFIX,
BUN_INSTALL, VOLTA_HOME, ASDF_DATA_DIR, NVM_DIR, and FNM_DIR when set.Difference between the hackable git install and npm install
Difference between the hackable git install and npm install
- Hackable (git) install: full source checkout, editable, best for contributors. You build locally and can patch code/docs.
- npm install: global CLI install, no repo, best for “just run it.” Updates come from npm dist-tags.
Can I switch between npm and git installs later?
Can I switch between npm and git installs later?
openclaw update --channel ... on an existing install. This does not
delete your data - only the OpenClaw code install changes. State (~/.openclaw) and
workspace (~/.openclaw/workspace) stay untouched.npm to git:--dry-run to preview the planned mode switch first. The updater runs Doctor
follow-ups, refreshes plugin sources for the target channel, and restarts the gateway
unless you pass --no-restart.The installer can force either mode too:Should I run the Gateway on my laptop or a VPS?
Should I run the Gateway on my laptop or a VPS?
- Pros: no server cost, direct access to local files, a live browser window.
- Cons: sleep/network drops disconnect it, OS updates/reboots interrupt it, must stay awake.
- Pros: always-on, stable network, no laptop sleep issues, easier to keep running.
- Cons: often headless (use screenshots), remote file access only, SSH needed for updates.
How important is it to run OpenClaw on a dedicated machine?
How important is it to run OpenClaw on a dedicated machine?
- Dedicated host (VPS/Mac mini/Raspberry Pi): always-on, fewer sleep/reboot interruptions, cleaner permissions, easier to keep running.
- Shared laptop/desktop: fine for testing and active use, but expect pauses when the machine sleeps or updates.
What are the minimum VPS requirements and recommended OS?
What are the minimum VPS requirements and recommended OS?
- Absolute minimum: 1 vCPU, 1 GB RAM, ~500 MB disk.
- Recommended: 1-2 vCPU, 2 GB+ RAM for headroom (logs, media, multiple channels). Node tools and browser automation can be resource hungry.
Can I run OpenClaw in a VM and what are the requirements?
Can I run OpenClaw in a VM and what are the requirements?
- Absolute minimum: 1 vCPU, 1 GB RAM.
- Recommended: 2 GB+ RAM for multiple channels, browser automation, or media tools.
- OS: Ubuntu LTS or another modern Debian/Ubuntu.
Related
- FAQ - the main FAQ (models, sessions, gateway, security, more)
- Install overview
- Getting started
- Troubleshooting