mirror of
https://github.com/openclaw/openclaw.git
synced 2026-02-09 05:19:32 +08:00
c18452598a
* docs: restructure Get Started tab and improve onboarding flow - Flatten nested Onboarding group into linear First Steps flow - Add 'What is OpenClaw?' narrative section to landing page - Split wizard.md into streamlined overview + full reference (reference/wizard.md) - Move Pairing to Channels > Configuration - Move Bootstrapping to Agents > Fundamentals - Move macOS app onboarding to Platforms > macOS companion app - Move Lore to Help > Community - Remove duplicate install instructions from openclaw.md - Mirror navigation changes in zh-CN tabs - No content deleted — all detail preserved or relocated * docs: move deployment pages to install/, fix Platforms tab routing, clarify onboarding paths - Move deployment guides (fly, hetzner, gcp, macos-vm, exe-dev, railway, render, northflank) from platforms/ and root to install/ - Add 'Hosting and deployment' group to Install tab - Slim Gateway & Ops 'Remote access and deployment' down to 'Remote access' - Swap Platforms tab before Gateway & Ops to fix path-prefix routing - Move macOS app onboarding into First steps (parallel to CLI wizard) - Rename sidebar titles to 'Onboarding: CLI' / 'Onboarding: macOS App' - Add redirects for all moved paths - Update all internal links (en + zh-CN) - Fix img tag syntax in onboarding.md
109 lines
3.7 KiB
Markdown
109 lines
3.7 KiB
Markdown
---
|
||
summary: "CLI onboarding wizard: guided setup for gateway, workspace, channels, and skills"
|
||
read_when:
|
||
- Running or configuring the onboarding wizard
|
||
- Setting up a new machine
|
||
title: "Onboarding Wizard (CLI)"
|
||
sidebarTitle: "Onboarding: CLI"
|
||
---
|
||
|
||
# Onboarding Wizard (CLI)
|
||
|
||
The onboarding wizard is the **recommended** way to set up OpenClaw on macOS,
|
||
Linux, or Windows (via WSL2; strongly recommended).
|
||
It configures a local Gateway or a remote Gateway connection, plus channels, skills,
|
||
and workspace defaults in one guided flow.
|
||
|
||
```bash
|
||
openclaw onboard
|
||
```
|
||
|
||
<Info>
|
||
Fastest first chat: open the Control UI (no channel setup needed). Run
|
||
`openclaw dashboard` and chat in the browser. Docs: [Dashboard](/web/dashboard).
|
||
</Info>
|
||
|
||
To reconfigure later:
|
||
|
||
```bash
|
||
openclaw configure
|
||
openclaw agents add <name>
|
||
```
|
||
|
||
<Note>
|
||
`--json` does not imply non-interactive mode. For scripts, use `--non-interactive`.
|
||
</Note>
|
||
|
||
<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>
|
||
|
||
## QuickStart vs Advanced
|
||
|
||
The wizard starts with **QuickStart** (defaults) vs **Advanced** (full control).
|
||
|
||
<Tabs>
|
||
<Tab title="QuickStart (defaults)">
|
||
- Local gateway (loopback)
|
||
- Workspace default (or existing workspace)
|
||
- Gateway port **18789**
|
||
- Gateway auth **Token** (auto‑generated, even on loopback)
|
||
- Tailscale exposure **Off**
|
||
- Telegram + WhatsApp DMs default to **allowlist** (you'll be prompted for your phone number)
|
||
</Tab>
|
||
<Tab title="Advanced (full control)">
|
||
- Exposes every step (mode, workspace, gateway, channels, daemon, skills).
|
||
</Tab>
|
||
</Tabs>
|
||
|
||
## What the wizard configures
|
||
|
||
**Local mode (default)** walks you through these steps:
|
||
|
||
1. **Model/Auth** — Anthropic API key (recommended), OAuth, OpenAI, or other providers. Pick a default model.
|
||
2. **Workspace** — Location for agent files (default `~/.openclaw/workspace`). Seeds bootstrap files.
|
||
3. **Gateway** — Port, bind address, auth mode, Tailscale exposure.
|
||
4. **Channels** — WhatsApp, Telegram, Discord, Google Chat, Mattermost, Signal, BlueBubbles, or iMessage.
|
||
5. **Daemon** — Installs a LaunchAgent (macOS) or systemd user unit (Linux/WSL2).
|
||
6. **Health check** — Starts the Gateway and verifies it's running.
|
||
7. **Skills** — Installs recommended skills and optional dependencies.
|
||
|
||
<Note>
|
||
Re-running the wizard does **not** wipe anything unless you explicitly choose **Reset** (or pass `--reset`).
|
||
If the config is invalid or contains legacy keys, the wizard asks you to run `openclaw doctor` first.
|
||
</Note>
|
||
|
||
**Remote mode** only configures the local client to connect to a Gateway elsewhere.
|
||
It does **not** install or change anything on the remote host.
|
||
|
||
## Add another agent
|
||
|
||
Use `openclaw agents add <name>` to create a separate agent with its own workspace,
|
||
sessions, and auth profiles. Running without `--workspace` launches the wizard.
|
||
|
||
What it sets:
|
||
|
||
- `agents.list[].name`
|
||
- `agents.list[].workspace`
|
||
- `agents.list[].agentDir`
|
||
|
||
Notes:
|
||
|
||
- Default workspaces follow `~/.openclaw/workspace-<agentId>`.
|
||
- Add `bindings` to route inbound messages (the wizard can do this).
|
||
- Non-interactive flags: `--model`, `--agent-dir`, `--bind`, `--non-interactive`.
|
||
|
||
## Full reference
|
||
|
||
For detailed step-by-step breakdowns, non-interactive scripting, Signal setup,
|
||
RPC API, and a full list of config fields the wizard writes, see the
|
||
[Wizard Reference](/reference/wizard).
|
||
|
||
## Related docs
|
||
|
||
- CLI command reference: [`openclaw onboard`](/cli/onboard)
|
||
- macOS app onboarding: [Onboarding](/start/onboarding)
|
||
- Agent first-run ritual: [Agent Bootstrapping](/start/bootstrapping)
|