Files
openclaw/docs/start/wizard.md

76 lines
2.3 KiB
Markdown
Raw Normal View History

2026-01-01 17:34:46 +01:00
---
summary: "CLI onboarding wizard: guided setup for gateway, workspace, channels, and skills"
2026-01-01 17:34:46 +01:00
read_when:
2026-01-01 21:09:24 +01:00
- Running or configuring the onboarding wizard
- Setting up a new machine
title: "Onboarding Wizard (CLI)"
sidebarTitle: "Wizard (CLI)"
2026-01-01 17:34:46 +01:00
---
# Onboarding Wizard (CLI)
The CLI onboarding wizard is the recommended setup path for OpenClaw on macOS,
Linux, and Windows (via WSL2). It configures a local gateway or a remote
gateway connection, plus workspace defaults, channels, and skills.
2026-01-01 17:34:46 +01:00
2026-01-01 21:09:24 +01:00
```bash
2026-01-30 03:15:10 +01:00
openclaw onboard
2026-01-01 21:09:24 +01:00
```
2026-01-01 17:34:46 +01:00
<Info>
2026-01-26 20:26:03 +00:00
Fastest first chat: open the Control UI (no channel setup needed). Run
2026-01-30 03:15:10 +01:00
`openclaw dashboard` and chat in the browser. Docs: [Dashboard](/web/dashboard).
</Info>
2026-01-26 20:26:03 +00:00
## QuickStart vs Advanced
The wizard starts with **QuickStart** (defaults) vs **Advanced** (full control).
<Tabs>
<Tab title="QuickStart (defaults)">
- Local gateway on loopback
- Existing workspace or default workspace
- Gateway port `18789`
- Gateway auth token auto-generated (even on loopback)
- Tailscale exposure off
- Telegram and WhatsApp DMs default to allowlist (you may be prompted for your phone number)
</Tab>
<Tab title="Advanced (full control)">
- Exposes full prompt flow for mode, workspace, gateway, channels, daemon, and skills
</Tab>
</Tabs>
## CLI onboarding details
2026-01-01 21:09:24 +01:00
<Columns>
<Card title="CLI reference" href="/start/wizard-cli-reference">
Full local and remote flow, auth and model matrix, config outputs, wizard RPC, and signal-cli behavior.
</Card>
<Card title="Automation and scripts" href="/start/wizard-cli-automation">
Non-interactive onboarding recipes and automated `agents add` examples.
</Card>
</Columns>
2026-01-31 21:13:13 +09:00
## Common follow-up commands
2026-01-07 09:58:54 +01:00
```bash
openclaw configure
2026-01-30 03:15:10 +01:00
openclaw agents add <name>
2026-01-07 09:58:54 +01:00
```
<Note>
`--json` does not imply non-interactive mode. For scripts, use `--non-interactive`.
</Note>
2026-01-01 21:09:24 +01:00
<Tip>
Recommended: set up a Brave Search API key so the agent can use `web_search`
(`web_fetch` works without a key). Easiest path: `openclaw configure --section web`
which stores `tools.web.search.apiKey`. Docs: [Web tools](/tools/web).
</Tip>
2026-01-01 21:09:24 +01:00
## Related docs
- CLI command reference: [`openclaw onboard`](/cli/onboard)
2026-01-10 14:51:21 -06:00
- macOS app onboarding: [Onboarding](/start/onboarding)
- Agent first-run ritual: [Agent Bootstrapping](/start/bootstrapping)