docs(onboarding): streamline CLI onboarding docs (#9830)
This commit is contained in:
Seb Slight
@@ -9,9 +9,12 @@ title: "onboard"
|
|||||||
|
|
||||||
Interactive onboarding wizard (local or remote Gateway setup).
|
Interactive onboarding wizard (local or remote Gateway setup).
|
||||||
|
|
||||||
Related:
|
## Related guides
|
||||||
|
|
||||||
- Wizard guide: [Onboarding](/start/onboarding)
|
- CLI onboarding hub: [Onboarding Wizard (CLI)](/start/wizard)
|
||||||
|
- CLI onboarding reference: [CLI Onboarding Reference](/start/wizard-cli-reference)
|
||||||
|
- CLI automation: [CLI Automation](/start/wizard-cli-automation)
|
||||||
|
- macOS onboarding: [Onboarding (macOS App)](/start/onboarding)
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -27,3 +30,14 @@ Flow notes:
|
|||||||
- `quickstart`: minimal prompts, auto-generates a gateway token.
|
- `quickstart`: minimal prompts, auto-generates a gateway token.
|
||||||
- `manual`: full prompts for port/bind/auth (alias of `advanced`).
|
- `manual`: full prompts for port/bind/auth (alias of `advanced`).
|
||||||
- Fastest first chat: `openclaw dashboard` (Control UI, no channel setup).
|
- Fastest first chat: `openclaw dashboard` (Control UI, no channel setup).
|
||||||
|
|
||||||
|
## Common follow-up commands
|
||||||
|
|
||||||
|
```bash
|
||||||
|
openclaw configure
|
||||||
|
openclaw agents add <name>
|
||||||
|
```
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
`--json` does not imply non-interactive mode. Use `--non-interactive` for scripts.
|
||||||
|
</Note>
|
||||||
|
|||||||
@@ -698,6 +698,18 @@
|
|||||||
"source": "/wizard",
|
"source": "/wizard",
|
||||||
"destination": "/start/wizard"
|
"destination": "/start/wizard"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"source": "/start/wizard-cli-flow",
|
||||||
|
"destination": "/start/wizard-cli-reference"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"source": "/start/wizard-cli-auth",
|
||||||
|
"destination": "/start/wizard-cli-reference"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"source": "/start/wizard-cli-outputs",
|
||||||
|
"destination": "/start/wizard-cli-reference"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"source": "/start/faq",
|
"source": "/start/faq",
|
||||||
"destination": "/help/faq"
|
"destination": "/help/faq"
|
||||||
@@ -745,8 +757,22 @@
|
|||||||
"start/getting-started",
|
"start/getting-started",
|
||||||
{
|
{
|
||||||
"group": "Onboarding",
|
"group": "Onboarding",
|
||||||
"pages": ["start/wizard", "start/onboarding", "start/bootstrapping"]
|
"pages": [
|
||||||
|
{
|
||||||
|
"group": "CLI onboarding",
|
||||||
|
"pages": [
|
||||||
|
"start/wizard",
|
||||||
|
"start/wizard-cli-reference",
|
||||||
|
"start/wizard-cli-automation"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"group": "macOS onboarding",
|
||||||
|
"pages": ["start/onboarding"]
|
||||||
|
}
|
||||||
|
]
|
||||||
},
|
},
|
||||||
|
"start/bootstrapping",
|
||||||
"start/pairing"
|
"start/pairing"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|||||||
141
docs/start/wizard-cli-automation.md
Normal file
141
docs/start/wizard-cli-automation.md
Normal file
@@ -0,0 +1,141 @@
|
|||||||
|
---
|
||||||
|
summary: "Scripted onboarding and agent setup for the OpenClaw CLI"
|
||||||
|
read_when:
|
||||||
|
- You are automating onboarding in scripts or CI
|
||||||
|
- You need non-interactive examples for specific providers
|
||||||
|
title: "CLI Automation"
|
||||||
|
sidebarTitle: "CLI automation"
|
||||||
|
---
|
||||||
|
|
||||||
|
# CLI Automation
|
||||||
|
|
||||||
|
Use `--non-interactive` to automate `openclaw onboard`.
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
`--json` does not imply non-interactive mode. Use `--non-interactive` (and `--workspace`) for scripts.
|
||||||
|
</Note>
|
||||||
|
|
||||||
|
## Baseline non-interactive example
|
||||||
|
|
||||||
|
```bash
|
||||||
|
openclaw onboard --non-interactive \
|
||||||
|
--mode local \
|
||||||
|
--auth-choice apiKey \
|
||||||
|
--anthropic-api-key "$ANTHROPIC_API_KEY" \
|
||||||
|
--gateway-port 18789 \
|
||||||
|
--gateway-bind loopback \
|
||||||
|
--install-daemon \
|
||||||
|
--daemon-runtime node \
|
||||||
|
--skip-skills
|
||||||
|
```
|
||||||
|
|
||||||
|
Add `--json` for a machine-readable summary.
|
||||||
|
|
||||||
|
## Provider-specific examples
|
||||||
|
|
||||||
|
<AccordionGroup>
|
||||||
|
<Accordion title="Gemini example">
|
||||||
|
```bash
|
||||||
|
openclaw onboard --non-interactive \
|
||||||
|
--mode local \
|
||||||
|
--auth-choice gemini-api-key \
|
||||||
|
--gemini-api-key "$GEMINI_API_KEY" \
|
||||||
|
--gateway-port 18789 \
|
||||||
|
--gateway-bind loopback
|
||||||
|
```
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="Z.AI example">
|
||||||
|
```bash
|
||||||
|
openclaw onboard --non-interactive \
|
||||||
|
--mode local \
|
||||||
|
--auth-choice zai-api-key \
|
||||||
|
--zai-api-key "$ZAI_API_KEY" \
|
||||||
|
--gateway-port 18789 \
|
||||||
|
--gateway-bind loopback
|
||||||
|
```
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="Vercel AI Gateway example">
|
||||||
|
```bash
|
||||||
|
openclaw onboard --non-interactive \
|
||||||
|
--mode local \
|
||||||
|
--auth-choice ai-gateway-api-key \
|
||||||
|
--ai-gateway-api-key "$AI_GATEWAY_API_KEY" \
|
||||||
|
--gateway-port 18789 \
|
||||||
|
--gateway-bind loopback
|
||||||
|
```
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="Cloudflare AI Gateway example">
|
||||||
|
```bash
|
||||||
|
openclaw onboard --non-interactive \
|
||||||
|
--mode local \
|
||||||
|
--auth-choice cloudflare-ai-gateway-api-key \
|
||||||
|
--cloudflare-ai-gateway-account-id "your-account-id" \
|
||||||
|
--cloudflare-ai-gateway-gateway-id "your-gateway-id" \
|
||||||
|
--cloudflare-ai-gateway-api-key "$CLOUDFLARE_AI_GATEWAY_API_KEY" \
|
||||||
|
--gateway-port 18789 \
|
||||||
|
--gateway-bind loopback
|
||||||
|
```
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="Moonshot example">
|
||||||
|
```bash
|
||||||
|
openclaw onboard --non-interactive \
|
||||||
|
--mode local \
|
||||||
|
--auth-choice moonshot-api-key \
|
||||||
|
--moonshot-api-key "$MOONSHOT_API_KEY" \
|
||||||
|
--gateway-port 18789 \
|
||||||
|
--gateway-bind loopback
|
||||||
|
```
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="Synthetic example">
|
||||||
|
```bash
|
||||||
|
openclaw onboard --non-interactive \
|
||||||
|
--mode local \
|
||||||
|
--auth-choice synthetic-api-key \
|
||||||
|
--synthetic-api-key "$SYNTHETIC_API_KEY" \
|
||||||
|
--gateway-port 18789 \
|
||||||
|
--gateway-bind loopback
|
||||||
|
```
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="OpenCode Zen example">
|
||||||
|
```bash
|
||||||
|
openclaw onboard --non-interactive \
|
||||||
|
--mode local \
|
||||||
|
--auth-choice opencode-zen \
|
||||||
|
--opencode-zen-api-key "$OPENCODE_API_KEY" \
|
||||||
|
--gateway-port 18789 \
|
||||||
|
--gateway-bind loopback
|
||||||
|
```
|
||||||
|
</Accordion>
|
||||||
|
</AccordionGroup>
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
openclaw agents add work \
|
||||||
|
--workspace ~/.openclaw/workspace-work \
|
||||||
|
--model openai/gpt-5.2 \
|
||||||
|
--bind whatsapp:biz \
|
||||||
|
--non-interactive \
|
||||||
|
--json
|
||||||
|
```
|
||||||
|
|
||||||
|
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`.
|
||||||
|
|
||||||
|
## Related docs
|
||||||
|
|
||||||
|
- Onboarding hub: [Onboarding Wizard (CLI)](/start/wizard)
|
||||||
|
- Full reference: [CLI Onboarding Reference](/start/wizard-cli-reference)
|
||||||
|
- Command reference: [`openclaw onboard`](/cli/onboard)
|
||||||
241
docs/start/wizard-cli-reference.md
Normal file
241
docs/start/wizard-cli-reference.md
Normal file
@@ -0,0 +1,241 @@
|
|||||||
|
---
|
||||||
|
summary: "Complete reference for CLI onboarding flow, auth/model setup, outputs, and internals"
|
||||||
|
read_when:
|
||||||
|
- You need detailed behavior for openclaw onboard
|
||||||
|
- You are debugging onboarding results or integrating onboarding clients
|
||||||
|
title: "CLI Onboarding Reference"
|
||||||
|
sidebarTitle: "CLI reference"
|
||||||
|
---
|
||||||
|
|
||||||
|
# CLI Onboarding Reference
|
||||||
|
|
||||||
|
This page is the full reference for `openclaw onboard`.
|
||||||
|
For the short guide, see [Onboarding Wizard (CLI)](/start/wizard).
|
||||||
|
|
||||||
|
## What the wizard does
|
||||||
|
|
||||||
|
Local mode (default) walks you through:
|
||||||
|
|
||||||
|
- Model and auth setup (OpenAI Code subscription OAuth, Anthropic API key or setup token, plus MiniMax, GLM, Moonshot, and AI Gateway options)
|
||||||
|
- Workspace location and bootstrap files
|
||||||
|
- Gateway settings (port, bind, auth, tailscale)
|
||||||
|
- Channels and providers (Telegram, WhatsApp, Discord, Google Chat, Mattermost plugin, Signal)
|
||||||
|
- Daemon install (LaunchAgent or systemd user unit)
|
||||||
|
- Health check
|
||||||
|
- Skills setup
|
||||||
|
|
||||||
|
Remote mode configures this machine to connect to a gateway elsewhere.
|
||||||
|
It does not install or modify anything on the remote host.
|
||||||
|
|
||||||
|
## Local flow details
|
||||||
|
|
||||||
|
<Steps>
|
||||||
|
<Step title="Existing config detection">
|
||||||
|
- If `~/.openclaw/openclaw.json` exists, choose Keep, Modify, or Reset.
|
||||||
|
- Re-running the wizard does not wipe anything unless you explicitly choose Reset (or pass `--reset`).
|
||||||
|
- If config is invalid or contains legacy keys, the wizard stops and asks you to run `openclaw doctor` before continuing.
|
||||||
|
- Reset uses `trash` and offers scopes:
|
||||||
|
- Config only
|
||||||
|
- Config + credentials + sessions
|
||||||
|
- Full reset (also removes workspace)
|
||||||
|
</Step>
|
||||||
|
<Step title="Model and auth">
|
||||||
|
- Full option matrix is in [Auth and model options](#auth-and-model-options).
|
||||||
|
</Step>
|
||||||
|
<Step title="Workspace">
|
||||||
|
- Default `~/.openclaw/workspace` (configurable).
|
||||||
|
- Seeds workspace files needed for first-run bootstrap ritual.
|
||||||
|
- Workspace layout: [Agent workspace](/concepts/agent-workspace).
|
||||||
|
</Step>
|
||||||
|
<Step title="Gateway">
|
||||||
|
- Prompts for port, bind, auth mode, and tailscale exposure.
|
||||||
|
- Recommended: keep token auth enabled even for loopback so local WS clients must authenticate.
|
||||||
|
- Disable auth only if you fully trust every local process.
|
||||||
|
- Non-loopback binds still require auth.
|
||||||
|
</Step>
|
||||||
|
<Step title="Channels">
|
||||||
|
- [WhatsApp](/channels/whatsapp): optional QR login
|
||||||
|
- [Telegram](/channels/telegram): bot token
|
||||||
|
- [Discord](/channels/discord): bot token
|
||||||
|
- [Google Chat](/channels/googlechat): service account JSON + webhook audience
|
||||||
|
- [Mattermost](/channels/mattermost) plugin: bot token + base URL
|
||||||
|
- [Signal](/channels/signal): optional `signal-cli` install + account config
|
||||||
|
- [BlueBubbles](/channels/bluebubbles): recommended for iMessage; server URL + password + webhook
|
||||||
|
- [iMessage](/channels/imessage): legacy `imsg` CLI path + DB access
|
||||||
|
- DM security: default is pairing. First DM sends a code; approve via
|
||||||
|
`openclaw pairing approve <channel> <code>` or use allowlists.
|
||||||
|
</Step>
|
||||||
|
<Step title="Daemon install">
|
||||||
|
- macOS: LaunchAgent
|
||||||
|
- Requires logged-in user session; for headless, use a custom LaunchDaemon (not shipped).
|
||||||
|
- Linux and Windows via WSL2: systemd user unit
|
||||||
|
- Wizard attempts `loginctl enable-linger <user>` so gateway stays up after logout.
|
||||||
|
- May prompt for sudo (writes `/var/lib/systemd/linger`); it tries without sudo first.
|
||||||
|
- Runtime selection: Node (recommended; required for WhatsApp and Telegram). Bun is not recommended.
|
||||||
|
</Step>
|
||||||
|
<Step title="Health check">
|
||||||
|
- Starts gateway (if needed) and runs `openclaw health`.
|
||||||
|
- `openclaw status --deep` adds gateway health probes to status output.
|
||||||
|
</Step>
|
||||||
|
<Step title="Skills">
|
||||||
|
- Reads available skills and checks requirements.
|
||||||
|
- Lets you choose node manager: npm or pnpm (bun not recommended).
|
||||||
|
- Installs optional dependencies (some use Homebrew on macOS).
|
||||||
|
</Step>
|
||||||
|
<Step title="Finish">
|
||||||
|
- Summary and next steps, including iOS, Android, and macOS app options.
|
||||||
|
</Step>
|
||||||
|
</Steps>
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
If no GUI is detected, the wizard prints SSH port-forward instructions for the Control UI instead of opening a browser.
|
||||||
|
If Control UI assets are missing, the wizard attempts to build them; fallback is `pnpm ui:build` (auto-installs UI deps).
|
||||||
|
</Note>
|
||||||
|
|
||||||
|
## Remote mode details
|
||||||
|
|
||||||
|
Remote mode configures this machine to connect to a gateway elsewhere.
|
||||||
|
|
||||||
|
<Info>
|
||||||
|
Remote mode does not install or modify anything on the remote host.
|
||||||
|
</Info>
|
||||||
|
|
||||||
|
What you set:
|
||||||
|
|
||||||
|
- Remote gateway URL (`ws://...`)
|
||||||
|
- Token if remote gateway auth is required (recommended)
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
- If gateway is loopback-only, use SSH tunneling or a tailnet.
|
||||||
|
- Discovery hints:
|
||||||
|
- macOS: Bonjour (`dns-sd`)
|
||||||
|
- Linux: Avahi (`avahi-browse`)
|
||||||
|
</Note>
|
||||||
|
|
||||||
|
## Auth and model options
|
||||||
|
|
||||||
|
<AccordionGroup>
|
||||||
|
<Accordion title="Anthropic API key (recommended)">
|
||||||
|
Uses `ANTHROPIC_API_KEY` if present or prompts for a key, then saves it for daemon use.
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="Anthropic OAuth (Claude Code CLI)">
|
||||||
|
- macOS: checks Keychain item "Claude Code-credentials"
|
||||||
|
- Linux and Windows: reuses `~/.claude/.credentials.json` if present
|
||||||
|
|
||||||
|
On macOS, choose "Always Allow" so launchd starts do not block.
|
||||||
|
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="Anthropic token (setup-token paste)">
|
||||||
|
Run `claude setup-token` on any machine, then paste the token.
|
||||||
|
You can name it; blank uses default.
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="OpenAI Code subscription (Codex CLI reuse)">
|
||||||
|
If `~/.codex/auth.json` exists, the wizard can reuse it.
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="OpenAI Code subscription (OAuth)">
|
||||||
|
Browser flow; paste `code#state`.
|
||||||
|
|
||||||
|
Sets `agents.defaults.model` to `openai-codex/gpt-5.2` when model is unset or `openai/*`.
|
||||||
|
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="OpenAI API key">
|
||||||
|
Uses `OPENAI_API_KEY` if present or prompts for a key, then saves it to
|
||||||
|
`~/.openclaw/.env` so launchd can read it.
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="OpenCode Zen">
|
||||||
|
Prompts for `OPENCODE_API_KEY` (or `OPENCODE_ZEN_API_KEY`).
|
||||||
|
Setup URL: [opencode.ai/auth](https://opencode.ai/auth).
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="API key (generic)">
|
||||||
|
Stores the key for you.
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="Vercel AI Gateway">
|
||||||
|
Prompts for `AI_GATEWAY_API_KEY`.
|
||||||
|
More detail: [Vercel AI Gateway](/providers/vercel-ai-gateway).
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="Cloudflare AI Gateway">
|
||||||
|
Prompts for account ID, gateway ID, and `CLOUDFLARE_AI_GATEWAY_API_KEY`.
|
||||||
|
More detail: [Cloudflare AI Gateway](/providers/cloudflare-ai-gateway).
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="MiniMax M2.1">
|
||||||
|
Config is auto-written.
|
||||||
|
More detail: [MiniMax](/providers/minimax).
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="Synthetic (Anthropic-compatible)">
|
||||||
|
Prompts for `SYNTHETIC_API_KEY`.
|
||||||
|
More detail: [Synthetic](/providers/synthetic).
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="Moonshot and Kimi Coding">
|
||||||
|
Moonshot (Kimi K2) and Kimi Coding configs are auto-written.
|
||||||
|
More detail: [Moonshot AI (Kimi + Kimi Coding)](/providers/moonshot).
|
||||||
|
</Accordion>
|
||||||
|
<Accordion title="Skip">
|
||||||
|
Leaves auth unconfigured.
|
||||||
|
</Accordion>
|
||||||
|
</AccordionGroup>
|
||||||
|
|
||||||
|
Model behavior:
|
||||||
|
|
||||||
|
- Pick default model from detected options, or enter provider and model manually.
|
||||||
|
- Wizard runs a model check and warns if the configured model is unknown or missing auth.
|
||||||
|
|
||||||
|
Credential and profile paths:
|
||||||
|
|
||||||
|
- OAuth credentials: `~/.openclaw/credentials/oauth.json`
|
||||||
|
- Auth profiles (API keys + OAuth): `~/.openclaw/agents/<agentId>/agent/auth-profiles.json`
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
Headless and server tip: complete OAuth on a machine with a browser, then copy
|
||||||
|
`~/.openclaw/credentials/oauth.json` (or `$OPENCLAW_STATE_DIR/credentials/oauth.json`)
|
||||||
|
to the gateway host.
|
||||||
|
</Note>
|
||||||
|
|
||||||
|
## Outputs and internals
|
||||||
|
|
||||||
|
Typical fields in `~/.openclaw/openclaw.json`:
|
||||||
|
|
||||||
|
- `agents.defaults.workspace`
|
||||||
|
- `agents.defaults.model` / `models.providers` (if Minimax chosen)
|
||||||
|
- `gateway.*` (mode, bind, auth, tailscale)
|
||||||
|
- `channels.telegram.botToken`, `channels.discord.token`, `channels.signal.*`, `channels.imessage.*`
|
||||||
|
- Channel allowlists (Slack, Discord, Matrix, Microsoft Teams) when you opt in during prompts (names resolve to IDs when possible)
|
||||||
|
- `skills.install.nodeManager`
|
||||||
|
- `wizard.lastRunAt`
|
||||||
|
- `wizard.lastRunVersion`
|
||||||
|
- `wizard.lastRunCommit`
|
||||||
|
- `wizard.lastRunCommand`
|
||||||
|
- `wizard.lastRunMode`
|
||||||
|
|
||||||
|
`openclaw agents add` writes `agents.list[]` and optional `bindings`.
|
||||||
|
|
||||||
|
WhatsApp credentials go under `~/.openclaw/credentials/whatsapp/<accountId>/`.
|
||||||
|
Sessions are stored under `~/.openclaw/agents/<agentId>/sessions/`.
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
Some channels are delivered as plugins. When selected during onboarding, the wizard
|
||||||
|
prompts to install the plugin (npm or local path) before channel configuration.
|
||||||
|
</Note>
|
||||||
|
|
||||||
|
Gateway wizard RPC:
|
||||||
|
|
||||||
|
- `wizard.start`
|
||||||
|
- `wizard.next`
|
||||||
|
- `wizard.cancel`
|
||||||
|
- `wizard.status`
|
||||||
|
|
||||||
|
Clients (macOS app and Control UI) can render steps without re-implementing onboarding logic.
|
||||||
|
|
||||||
|
Signal setup behavior:
|
||||||
|
|
||||||
|
- Downloads the appropriate release asset
|
||||||
|
- Stores it under `~/.openclaw/tools/signal-cli/<version>/`
|
||||||
|
- Writes `channels.signal.cliPath` in config
|
||||||
|
- JVM builds require Java 21
|
||||||
|
- Native builds are used when available
|
||||||
|
- Windows uses WSL2 and follows Linux signal-cli flow inside WSL
|
||||||
|
|
||||||
|
## Related docs
|
||||||
|
|
||||||
|
- Onboarding hub: [Onboarding Wizard (CLI)](/start/wizard)
|
||||||
|
- Automation and scripts: [CLI Automation](/start/wizard-cli-automation)
|
||||||
|
- Command reference: [`openclaw onboard`](/cli/onboard)
|
||||||
@@ -9,12 +9,9 @@ sidebarTitle: "Wizard (CLI)"
|
|||||||
|
|
||||||
# Onboarding Wizard (CLI)
|
# Onboarding Wizard (CLI)
|
||||||
|
|
||||||
The onboarding wizard is the **recommended** way to set up OpenClaw on macOS,
|
The CLI onboarding wizard is the recommended setup path for OpenClaw on macOS,
|
||||||
Linux, or Windows (via WSL2; strongly recommended).
|
Linux, and Windows (via WSL2). It configures a local gateway or a remote
|
||||||
It configures a local Gateway or a remote Gateway connection, plus channels, skills,
|
gateway connection, plus workspace defaults, channels, and skills.
|
||||||
and workspace defaults in one guided flow.
|
|
||||||
|
|
||||||
Primary entrypoint:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
openclaw onboard
|
openclaw onboard
|
||||||
@@ -25,343 +22,54 @@ Fastest first chat: open the Control UI (no channel setup needed). Run
|
|||||||
`openclaw dashboard` and chat in the browser. Docs: [Dashboard](/web/dashboard).
|
`openclaw dashboard` and chat in the browser. Docs: [Dashboard](/web/dashboard).
|
||||||
</Info>
|
</Info>
|
||||||
|
|
||||||
Follow‑up reconfiguration:
|
## 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
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
||||||
|
## Common follow-up commands
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
openclaw configure
|
openclaw configure
|
||||||
|
openclaw agents add <name>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
`--json` does not imply non-interactive mode. For scripts, use `--non-interactive`.
|
||||||
|
</Note>
|
||||||
|
|
||||||
<Tip>
|
<Tip>
|
||||||
Recommended: set up a Brave Search API key so the agent can use `web_search`
|
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`
|
(`web_fetch` works without a key). Easiest path: `openclaw configure --section web`
|
||||||
which stores `tools.web.search.apiKey`. Docs: [Web tools](/tools/web).
|
which stores `tools.web.search.apiKey`. Docs: [Web tools](/tools/web).
|
||||||
</Tip>
|
</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 does
|
|
||||||
|
|
||||||
**Local mode (default)** walks you through:
|
|
||||||
|
|
||||||
- Model/auth (OpenAI Code (Codex) subscription OAuth, Anthropic API key (recommended) or setup-token (paste), plus MiniMax/GLM/Moonshot/AI Gateway options)
|
|
||||||
- Workspace location + bootstrap files
|
|
||||||
- Gateway settings (port/bind/auth/tailscale)
|
|
||||||
- Providers (Telegram, WhatsApp, Discord, Google Chat, Mattermost (plugin), Signal)
|
|
||||||
- Daemon install (LaunchAgent / systemd user unit)
|
|
||||||
- Health check
|
|
||||||
- Skills (recommended)
|
|
||||||
|
|
||||||
**Remote mode** only configures the local client to connect to a Gateway elsewhere.
|
|
||||||
It does **not** install or change anything on the remote host.
|
|
||||||
|
|
||||||
To add more isolated agents (separate workspace + sessions + auth), use:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
openclaw agents add <name>
|
|
||||||
```
|
|
||||||
|
|
||||||
<Note>
|
|
||||||
`--json` does **not** imply non-interactive mode. Use `--non-interactive` (and `--workspace`) for scripts.
|
|
||||||
</Note>
|
|
||||||
|
|
||||||
## Flow details (local)
|
|
||||||
|
|
||||||
<Steps>
|
|
||||||
<Step title="Existing config detection">
|
|
||||||
- If `~/.openclaw/openclaw.json` exists, choose **Keep / Modify / Reset**.
|
|
||||||
- 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 stops and asks
|
|
||||||
you to run `openclaw doctor` before continuing.
|
|
||||||
- Reset uses `trash` (never `rm`) and offers scopes:
|
|
||||||
- Config only
|
|
||||||
- Config + credentials + sessions
|
|
||||||
- Full reset (also removes workspace)
|
|
||||||
</Step>
|
|
||||||
<Step title="Model/Auth">
|
|
||||||
- **Anthropic API key (recommended)**: uses `ANTHROPIC_API_KEY` if present or prompts for a key, then saves it for daemon use.
|
|
||||||
- **Anthropic OAuth (Claude Code CLI)**: on macOS the wizard checks Keychain item "Claude Code-credentials" (choose "Always Allow" so launchd starts don't block); on Linux/Windows it reuses `~/.claude/.credentials.json` if present.
|
|
||||||
- **Anthropic token (paste setup-token)**: run `claude setup-token` on any machine, then paste the token (you can name it; blank = default).
|
|
||||||
- **OpenAI Code (Codex) subscription (Codex CLI)**: if `~/.codex/auth.json` exists, the wizard can reuse it.
|
|
||||||
- **OpenAI Code (Codex) subscription (OAuth)**: browser flow; paste the `code#state`.
|
|
||||||
- Sets `agents.defaults.model` to `openai-codex/gpt-5.2` when model is unset or `openai/*`.
|
|
||||||
- **OpenAI API key**: uses `OPENAI_API_KEY` if present or prompts for a key, then saves it to `~/.openclaw/.env` so launchd can read it.
|
|
||||||
- **OpenCode Zen (multi-model proxy)**: prompts for `OPENCODE_API_KEY` (or `OPENCODE_ZEN_API_KEY`, get it at https://opencode.ai/auth).
|
|
||||||
- **API key**: stores the key for you.
|
|
||||||
- **Vercel AI Gateway (multi-model proxy)**: prompts for `AI_GATEWAY_API_KEY`.
|
|
||||||
- More detail: [Vercel AI Gateway](/providers/vercel-ai-gateway)
|
|
||||||
- **Cloudflare AI Gateway**: prompts for Account ID, Gateway ID, and `CLOUDFLARE_AI_GATEWAY_API_KEY`.
|
|
||||||
- More detail: [Cloudflare AI Gateway](/providers/cloudflare-ai-gateway)
|
|
||||||
- **MiniMax M2.1**: config is auto-written.
|
|
||||||
- More detail: [MiniMax](/providers/minimax)
|
|
||||||
- **Synthetic (Anthropic-compatible)**: prompts for `SYNTHETIC_API_KEY`.
|
|
||||||
- More detail: [Synthetic](/providers/synthetic)
|
|
||||||
- **Moonshot (Kimi K2)**: config is auto-written.
|
|
||||||
- **Kimi Coding**: config is auto-written.
|
|
||||||
- More detail: [Moonshot AI (Kimi + Kimi Coding)](/providers/moonshot)
|
|
||||||
- **Skip**: no auth configured yet.
|
|
||||||
- Pick a default model from detected options (or enter provider/model manually).
|
|
||||||
- Wizard runs a model check and warns if the configured model is unknown or missing auth.
|
|
||||||
- OAuth credentials live in `~/.openclaw/credentials/oauth.json`; auth profiles live in `~/.openclaw/agents/<agentId>/agent/auth-profiles.json` (API keys + OAuth).
|
|
||||||
- More detail: [/concepts/oauth](/concepts/oauth)
|
|
||||||
<Note>
|
|
||||||
Headless/server tip: complete OAuth on a machine with a browser, then copy
|
|
||||||
`~/.openclaw/credentials/oauth.json` (or `$OPENCLAW_STATE_DIR/credentials/oauth.json`) to the
|
|
||||||
gateway host.
|
|
||||||
</Note>
|
|
||||||
</Step>
|
|
||||||
<Step title="Workspace">
|
|
||||||
- Default `~/.openclaw/workspace` (configurable).
|
|
||||||
- Seeds the workspace files needed for the agent bootstrap ritual.
|
|
||||||
- Full workspace layout + backup guide: [Agent workspace](/concepts/agent-workspace)
|
|
||||||
</Step>
|
|
||||||
<Step title="Gateway">
|
|
||||||
- Port, bind, auth mode, tailscale exposure.
|
|
||||||
- Auth recommendation: keep **Token** even for loopback so local WS clients must authenticate.
|
|
||||||
- Disable auth only if you fully trust every local process.
|
|
||||||
- Non‑loopback binds still require auth.
|
|
||||||
</Step>
|
|
||||||
<Step title="Channels">
|
|
||||||
- [WhatsApp](/channels/whatsapp): optional QR login.
|
|
||||||
- [Telegram](/channels/telegram): bot token.
|
|
||||||
- [Discord](/channels/discord): bot token.
|
|
||||||
- [Google Chat](/channels/googlechat): service account JSON + webhook audience.
|
|
||||||
- [Mattermost](/channels/mattermost) (plugin): bot token + base URL.
|
|
||||||
- [Signal](/channels/signal): optional `signal-cli` install + account config.
|
|
||||||
- [BlueBubbles](/channels/bluebubbles): **recommended for iMessage**; server URL + password + webhook.
|
|
||||||
- [iMessage](/channels/imessage): legacy `imsg` CLI path + DB access.
|
|
||||||
- DM security: default is pairing. First DM sends a code; approve via `openclaw pairing approve <channel> <code>` or use allowlists.
|
|
||||||
</Step>
|
|
||||||
<Step title="Daemon install">
|
|
||||||
- macOS: LaunchAgent
|
|
||||||
- Requires a logged-in user session; for headless, use a custom LaunchDaemon (not shipped).
|
|
||||||
- Linux (and Windows via WSL2): systemd user unit
|
|
||||||
- Wizard attempts to enable lingering via `loginctl enable-linger <user>` so the Gateway stays up after logout.
|
|
||||||
- May prompt for sudo (writes `/var/lib/systemd/linger`); it tries without sudo first.
|
|
||||||
- **Runtime selection:** Node (recommended; required for WhatsApp/Telegram). Bun is **not recommended**.
|
|
||||||
</Step>
|
|
||||||
<Step title="Health check">
|
|
||||||
- Starts the Gateway (if needed) and runs `openclaw health`.
|
|
||||||
- Tip: `openclaw status --deep` adds gateway health probes to status output (requires a reachable gateway).
|
|
||||||
</Step>
|
|
||||||
<Step title="Skills (recommended)">
|
|
||||||
- Reads the available skills and checks requirements.
|
|
||||||
- Lets you choose a node manager: **npm / pnpm** (bun not recommended).
|
|
||||||
- Installs optional dependencies (some use Homebrew on macOS).
|
|
||||||
</Step>
|
|
||||||
<Step title="Finish">
|
|
||||||
- Summary + next steps, including iOS/Android/macOS apps for extra features.
|
|
||||||
</Step>
|
|
||||||
</Steps>
|
|
||||||
|
|
||||||
<Note>
|
|
||||||
If no GUI is detected, the wizard prints SSH port-forward instructions for the Control UI instead of opening a browser.
|
|
||||||
If the Control UI assets are missing, the wizard attempts to build them; fallback is `pnpm ui:build` (auto-installs UI deps).
|
|
||||||
</Note>
|
|
||||||
|
|
||||||
## Remote mode
|
|
||||||
|
|
||||||
Remote mode configures a local client to connect to a Gateway elsewhere.
|
|
||||||
|
|
||||||
<Info>
|
|
||||||
Remote mode does **not** install or change anything on the remote host.
|
|
||||||
</Info>
|
|
||||||
|
|
||||||
What you’ll set:
|
|
||||||
|
|
||||||
- Remote Gateway URL (`ws://...`)
|
|
||||||
- Token if the remote Gateway requires auth (recommended)
|
|
||||||
|
|
||||||
<Note>
|
|
||||||
- If the Gateway is loopback‑only, use SSH tunneling or a tailnet.
|
|
||||||
- Discovery hints:
|
|
||||||
- macOS: Bonjour (`dns-sd`)
|
|
||||||
- Linux: Avahi (`avahi-browse`)
|
|
||||||
</Note>
|
|
||||||
|
|
||||||
## 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`.
|
|
||||||
|
|
||||||
## Non‑interactive mode
|
|
||||||
|
|
||||||
Use `--non-interactive` to automate or script onboarding:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
openclaw onboard --non-interactive \
|
|
||||||
--mode local \
|
|
||||||
--auth-choice apiKey \
|
|
||||||
--anthropic-api-key "$ANTHROPIC_API_KEY" \
|
|
||||||
--gateway-port 18789 \
|
|
||||||
--gateway-bind loopback \
|
|
||||||
--install-daemon \
|
|
||||||
--daemon-runtime node \
|
|
||||||
--skip-skills
|
|
||||||
```
|
|
||||||
|
|
||||||
Add `--json` for a machine‑readable summary.
|
|
||||||
|
|
||||||
<AccordionGroup>
|
|
||||||
<Accordion title="Gemini example">
|
|
||||||
```bash
|
|
||||||
openclaw onboard --non-interactive \
|
|
||||||
--mode local \
|
|
||||||
--auth-choice gemini-api-key \
|
|
||||||
--gemini-api-key "$GEMINI_API_KEY" \
|
|
||||||
--gateway-port 18789 \
|
|
||||||
--gateway-bind loopback
|
|
||||||
```
|
|
||||||
</Accordion>
|
|
||||||
<Accordion title="Z.AI example">
|
|
||||||
```bash
|
|
||||||
openclaw onboard --non-interactive \
|
|
||||||
--mode local \
|
|
||||||
--auth-choice zai-api-key \
|
|
||||||
--zai-api-key "$ZAI_API_KEY" \
|
|
||||||
--gateway-port 18789 \
|
|
||||||
--gateway-bind loopback
|
|
||||||
```
|
|
||||||
</Accordion>
|
|
||||||
<Accordion title="Vercel AI Gateway example">
|
|
||||||
```bash
|
|
||||||
openclaw onboard --non-interactive \
|
|
||||||
--mode local \
|
|
||||||
--auth-choice ai-gateway-api-key \
|
|
||||||
--ai-gateway-api-key "$AI_GATEWAY_API_KEY" \
|
|
||||||
--gateway-port 18789 \
|
|
||||||
--gateway-bind loopback
|
|
||||||
```
|
|
||||||
</Accordion>
|
|
||||||
<Accordion title="Cloudflare AI Gateway example">
|
|
||||||
```bash
|
|
||||||
openclaw onboard --non-interactive \
|
|
||||||
--mode local \
|
|
||||||
--auth-choice cloudflare-ai-gateway-api-key \
|
|
||||||
--cloudflare-ai-gateway-account-id "your-account-id" \
|
|
||||||
--cloudflare-ai-gateway-gateway-id "your-gateway-id" \
|
|
||||||
--cloudflare-ai-gateway-api-key "$CLOUDFLARE_AI_GATEWAY_API_KEY" \
|
|
||||||
--gateway-port 18789 \
|
|
||||||
--gateway-bind loopback
|
|
||||||
```
|
|
||||||
</Accordion>
|
|
||||||
<Accordion title="Moonshot example">
|
|
||||||
```bash
|
|
||||||
openclaw onboard --non-interactive \
|
|
||||||
--mode local \
|
|
||||||
--auth-choice moonshot-api-key \
|
|
||||||
--moonshot-api-key "$MOONSHOT_API_KEY" \
|
|
||||||
--gateway-port 18789 \
|
|
||||||
--gateway-bind loopback
|
|
||||||
```
|
|
||||||
</Accordion>
|
|
||||||
<Accordion title="Synthetic example">
|
|
||||||
```bash
|
|
||||||
openclaw onboard --non-interactive \
|
|
||||||
--mode local \
|
|
||||||
--auth-choice synthetic-api-key \
|
|
||||||
--synthetic-api-key "$SYNTHETIC_API_KEY" \
|
|
||||||
--gateway-port 18789 \
|
|
||||||
--gateway-bind loopback
|
|
||||||
```
|
|
||||||
</Accordion>
|
|
||||||
<Accordion title="OpenCode Zen example">
|
|
||||||
```bash
|
|
||||||
openclaw onboard --non-interactive \
|
|
||||||
--mode local \
|
|
||||||
--auth-choice opencode-zen \
|
|
||||||
--opencode-zen-api-key "$OPENCODE_API_KEY" \
|
|
||||||
--gateway-port 18789 \
|
|
||||||
--gateway-bind loopback
|
|
||||||
```
|
|
||||||
</Accordion>
|
|
||||||
</AccordionGroup>
|
|
||||||
|
|
||||||
Add agent (non‑interactive) example:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
openclaw agents add work \
|
|
||||||
--workspace ~/.openclaw/workspace-work \
|
|
||||||
--model openai/gpt-5.2 \
|
|
||||||
--bind whatsapp:biz \
|
|
||||||
--non-interactive \
|
|
||||||
--json
|
|
||||||
```
|
|
||||||
|
|
||||||
## Gateway wizard RPC
|
|
||||||
|
|
||||||
The Gateway exposes the wizard flow over RPC (`wizard.start`, `wizard.next`, `wizard.cancel`, `wizard.status`).
|
|
||||||
Clients (macOS app, Control UI) can render steps without re‑implementing onboarding logic.
|
|
||||||
|
|
||||||
## Signal setup (signal-cli)
|
|
||||||
|
|
||||||
The wizard can install `signal-cli` from GitHub releases:
|
|
||||||
|
|
||||||
- Downloads the appropriate release asset.
|
|
||||||
- Stores it under `~/.openclaw/tools/signal-cli/<version>/`.
|
|
||||||
- Writes `channels.signal.cliPath` to your config.
|
|
||||||
|
|
||||||
Notes:
|
|
||||||
|
|
||||||
- JVM builds require **Java 21**.
|
|
||||||
- Native builds are used when available.
|
|
||||||
- Windows uses WSL2; signal-cli install follows the Linux flow inside WSL.
|
|
||||||
|
|
||||||
## What the wizard writes
|
|
||||||
|
|
||||||
Typical fields in `~/.openclaw/openclaw.json`:
|
|
||||||
|
|
||||||
- `agents.defaults.workspace`
|
|
||||||
- `agents.defaults.model` / `models.providers` (if Minimax chosen)
|
|
||||||
- `gateway.*` (mode, bind, auth, tailscale)
|
|
||||||
- `channels.telegram.botToken`, `channels.discord.token`, `channels.signal.*`, `channels.imessage.*`
|
|
||||||
- Channel allowlists (Slack/Discord/Matrix/Microsoft Teams) when you opt in during the prompts (names resolve to IDs when possible).
|
|
||||||
- `skills.install.nodeManager`
|
|
||||||
- `wizard.lastRunAt`
|
|
||||||
- `wizard.lastRunVersion`
|
|
||||||
- `wizard.lastRunCommit`
|
|
||||||
- `wizard.lastRunCommand`
|
|
||||||
- `wizard.lastRunMode`
|
|
||||||
|
|
||||||
`openclaw agents add` writes `agents.list[]` and optional `bindings`.
|
|
||||||
|
|
||||||
WhatsApp credentials go under `~/.openclaw/credentials/whatsapp/<accountId>/`.
|
|
||||||
Sessions are stored under `~/.openclaw/agents/<agentId>/sessions/`.
|
|
||||||
|
|
||||||
Some channels are delivered as plugins. When you pick one during onboarding, the wizard
|
|
||||||
will prompt to install it (npm or a local path) before it can be configured.
|
|
||||||
|
|
||||||
## Related docs
|
## Related docs
|
||||||
|
|
||||||
|
- CLI command reference: [`openclaw onboard`](/cli/onboard)
|
||||||
- macOS app onboarding: [Onboarding](/start/onboarding)
|
- macOS app onboarding: [Onboarding](/start/onboarding)
|
||||||
- Config reference: [Gateway configuration](/gateway/configuration)
|
- Agent first-run ritual: [Agent Bootstrapping](/start/bootstrapping)
|
||||||
- Providers: [WhatsApp](/channels/whatsapp), [Telegram](/channels/telegram), [Discord](/channels/discord), [Google Chat](/channels/googlechat), [Signal](/channels/signal), [BlueBubbles](/channels/bluebubbles) (iMessage), [iMessage](/channels/imessage) (legacy)
|
|
||||||
- Skills: [Skills](/tools/skills), [Skills config](/tools/skills-config)
|
|
||||||
|
|||||||
Reference in New Issue
Block a user