引导向导 (CLI)
引导向导 (CLI)
引导向导是在 macOS、Linux 或 Windows(通过 WSL2;强烈推荐)上设置 OpenClaw 的推荐方式。 它通过一个引导式流程配置本地 Gateway 或远程 Gateway 连接,以及频道、技能和工作区默认值。
openclaw onboard
最快的首次聊天:打开控制 UI(无需频道设置)。运行
openclaw dashboard 并在浏览器中聊天。文档:Dashboard。
稍后重新配置:
openclaw configure
openclaw agents add <name>
--json 不意味着非交互模式。对于脚本,请使用 --non-interactive。
推荐:设置 Brave Search API 密钥,以便代理可以使用 web_search
(web_fetch 无需密钥即可工作)。最简单的方式:openclaw configure --section web
这会存储 tools.web.search.apiKey。文档:Web 工具。
QuickStart 与高级
向导从 QuickStart(默认值)或 高级(完全控制)开始。
- 本地网关(环回)
- 工作区默认值(或现有工作区)
- 网关端口 18789
- 网关认证 Token(自动生成,即使在环回模式下)
- 新本地设置的工具策略默认值:
tools.profile: "messaging"(保留现有的显式配置) - DM 隔离默认值:本地引导在未设置时写入
session.dmScope: "per-channel-peer"。详情:CLI 引导参考 - Tailscale 暴露 关闭
- Telegram + WhatsApp DM 默认为 允许列表(将提示输入您的电话号码)
向导配置的内容
本地模式(默认) 引导您完成以下步骤:
- 模型/认证 — 选择任何支持的提供商/认证流程(API 密钥、OAuth 或设置令牌),包括自定义提供商
(OpenAI 兼容、Anthropic 兼容或未知自动检测)。选择默认模型。
安全提示:如果此代理将运行工具或处理 webhook/hooks 内容,优先选择最强的最新一代模型并保持工具策略严格。较弱/较旧的层级更容易受到提示注入攻击。
对于非交互运行,
--secret-input-mode ref在认证配置文件中存储基于环境的引用,而不是明文 API 密钥值。 在非交互ref模式下,必须设置提供商环境变量;在没有该环境变量的情况下传递内联密钥标志会快速失败。 在交互运行中,选择密钥引用模式可以让您指向环境变量或已配置的提供商引用(file或exec),在保存前进行快速预检验证。 - 工作区 — 代理文件的位置(默认
~/.openclaw/workspace)。种子引导文件。 - 网关 — 端口、绑定地址、认证模式、Tailscale 暴露。
- 频道 — WhatsApp、Telegram、Discord、Google Chat、Mattermost、Signal、BlueBubbles 或 iMessage。
- 守护进程 — 安装 LaunchAgent(macOS)或 systemd 用户单元(Linux/WSL2)。
- 健康检查 — 启动 Gateway 并验证其运行状态。
- 技能 — 安装推荐的技能和可选依赖项。
重新运行向导不会清除任何内容,除非您明确选择 重置(或传递 --reset)。
CLI --reset 默认配置、凭据和会话;使用 --reset-scope full 包含工作区。
如果配置无效或包含遗留密钥,向导会要求您先运行 openclaw doctor。
远程模式 仅配置本地客户端以连接到其他地方的 Gateway。 它不会在远程主机上安装或更改任何内容。
添加另一个代理
使用 openclaw agents add <name> 创建具有自己的工作区、
会话和认证配置文件的单独代理。在没有 --workspace 的情况下运行将启动向导。
它设置的内容:
agents.list[].nameagents.list[].workspaceagents.list[].agentDir
注意:
- 默认工作区遵循
~/.openclaw/workspace-<agentId>。 - 添加
bindings以路由入站消息(向导可以完成此操作)。 - 非交互标志:
--model、--agent-dir、--bind、--non-interactive。
完整参考
有关详细的分步分解、非交互脚本、Signal 设置、 RPC API 以及向导写入的配置字段的完整列表,请参阅 向导参考。
相关文档
- CLI 命令参考:
openclaw onboard - 引导概览:引导概览
- macOS 应用引导:引导
- 代理首次运行仪式:代理引导