Goal: go from a clean machine to a working OpenClaw workspace with one agent that you can send a test message to.
Run everything in a non-production environment first. If you already have OpenClaw installed, you can still use this page as a smoke-test checklist.
Execute each command, capture output, then note issues and fixes.
Run:
openclaw setup
openclaw setup --workspace ~/.openclaw/workspace
Expected:
~/.openclaw/openclaw.json is created or updated.~/.openclaw/workspace (or the path you specified).openclaw setupopenclaw setup --workspace ~/.openclaw/workspace~/.openclaw/openclaw.json~/.openclaw/workspaceRun the interactive wizard:
openclaw onboard --flow quickstart
If you already know you want a remote gateway, use:
openclaw onboard --flow manual --mode remote --remote-url wss://gateway-host:18789
During the wizard:
If you need a fully non-interactive run (for CI or automation), adapt one of the examples in the official docs, e.g.:
openclaw onboard --non-interactive --auth-choice custom-api-key \
--custom-base-url "https://llm.example.com/v1" \
--custom-model-id "foo-large" \
--custom-api-key "$CUSTOM_API_KEY" \
--secret-input-mode plaintext --custom-compatibility openai
openclaw onboard --flow quickstartopenclaw onboard --flow manual --mode remote --remote-url wss://gateway-host:18789openclaw onboard --non-interactive --auth-choice custom-api-key \
--custom-base-url "https://llm.example.com/v1" \
--custom-model-id "foo-large" \
--custom-api-key "$CUSTOM_API_KEY" \
--secret-input-mode plaintext --custom-compatibility openaiRun:
openclaw doctor
If issues are reported, let the CLI apply safe fixes:
openclaw doctor --repair
When you want a deeper scan (sandbox, channels, cron, secrets):
openclaw doctor --deep
You should continue only when doctor reports healthy status or warns only about items you understand and accept.
openclaw doctoropenclaw doctor --repairopenclaw doctor --deepList existing agents:
openclaw agents list
Create a new agent workspace:
openclaw agents add work --workspace ~/.openclaw/workspace-work
Inspect bindings (how channels map to agents):
openclaw agents bindings
If you already have a main workspace and just want to set identity:
openclaw agents set-identity --workspace ~/.openclaw/workspace --from-identity
openclaw agents listopenclaw agents add work --workspace ~/.openclaw/workspace-workopenclaw agents bindingsopenclaw agents set-identity --workspace ~/.openclaw/workspace --from-identityTurn the commands on this page into your team runbook.