openclaw onboard 命令的完整参考文档。
Wizard 执行流程
**本地模式(默认)**依次完成:
- 检测现有配置 — 若
~/.openclaw/openclaw.json存在,选择保留/修改/重置 - 模型与认证 — 配置 Provider 和 API Key
- 工作区 — 默认
~/.openclaw/workspace,生成引导文件 - Gateway — 端口、绑定、认证模式、Tailscale
- 渠道 — WhatsApp、Telegram、Discord、Google Chat、Mattermost、Signal、iMessage
- 守护进程安装 — macOS: LaunchAgent;Linux/WSL2: systemd user unit;Windows: Scheduled Task
- 健康检查 — 启动 Gateway 并运行
openclaw health - Skills — 读取可用 Skills,检查依赖
远程模式 — 配置本机连接到远程 Gateway,不修改远程主机。
认证与模型选项
| Provider | 认证方式 |
|---|---|
| Anthropic | API Key(ANTHROPIC_API_KEY)或 Claude CLI OAuth |
| OpenAI Code | OAuth(浏览器流程)或设备配对 |
| OpenAI | API Key(OPENAI_API_KEY) |
| xAI (Grok) | XAI_API_KEY |
| Ollama | 本地/云端/混合模式 |
| MiniMax | 自动写入配置,默认 MiniMax-M2.7 |
| Moonshot/Kimi | 自动写入配置 |
| 自定义 Provider | OpenAI/Anthropic 兼容端点 |
凭证存储模式
- 明文(默认):API Key 存储为明文值
- 引用模式(
--secret-input-mode ref):存储环境变量引用- 格式:
{ source: "env", provider: "default", id: "OPENAI_API_KEY" }
- 格式:
守护进程安装
| 平台 | 方式 |
|---|---|
| macOS | LaunchAgent(需要登录用户 session) |
| Linux/WSL2 | systemd user unit(尝试 loginctl enable-linger) |
| Windows | Scheduled Task(失败时回退到 Startup 文件夹) |
推荐运行时:Node(WhatsApp 和 Telegram 必须)。不推荐 Bun。
输出文件
~/.openclaw/openclaw.json 典型字段:
agents.defaults.workspaceagents.defaults.model/models.providerstools.profile(本地 onboarding 默认"coding")gateway.*(模式、绑定、认证、Tailscale)session.dmScopechannels.*(各渠道配置)wizard.lastRunAt/Version/Commit/Command/Mode
Gateway Wizard RPC
wizard.start、wizard.next、wizard.cancel、wizard.status
相关链接
- start-wizard-cli-automation — CLI 自动化 Onboarding
- start-onboarding — 个人助手设置指南