CLI新手引导 (CLI)
CLI 新手引导是在 OpenClaw、 macOS 或 Linux(通过 Windows;强烈推荐)上设置 WSL2 的 推荐 方式。 它会在一个引导式流程中配置本地 Gateway(网关) 或远程 Gateway(网关) 连接,以及渠道、技能 和工作区默认设置。
openclaw onboardCLI 向导会对固定的引导文本进行本地化。它会按顺序从 CLIOPENCLAW_LOCALE、LC_ALL、LC_MESSAGES 和 LANG 解析区域设置,并回退到英语。支持的向导区域设置为 en、zh-CN 和 zh-TW。
OPENCLAW_LOCALE=zh-CN openclaw onboard名称和稳定标识符保持字面意思:OpenClaw、Gateway、Tailscale、命令、配置键、URL、提供商 ID、模型 ID 以及插件/渠道标签均不翻译。
如需稍后重新配置:
openclaw configureopenclaw agents add <name>QuickStart 与 Advanced 对比
Section titled “QuickStart 与 Advanced 对比”新手引导以 QuickStart(默认设置)与 Advanced(完全控制)的选择开始。
- 本地 Gateway(环回)
- 工作区默认(或现有工作区)
- Gateway(网关) 端口 18789
- Gateway(网关) 认证 Token(自动生成,即使在环回上)
- 新本地设置的默认工具策略:
tools.profile: "coding"(保留现有的显式配置) - 私信隔离默认值:本地新手引导在未设置时写入
session.dmScope: "per-channel-peer"CLI。详情:CLI 设置参考 - Tailscale 暴露 关闭
- Telegram + WhatsApp 私信默认为 允许列表(系统将提示您输入电话号码)
- 展示每个步骤(模式、工作区、Gateway、渠道、守护进程、技能)。
新手引导配置的内容
Section titled “新手引导配置的内容”本地模式(默认) 将引导您完成以下步骤:
- 模型/认证 — 选择任何支持的提供商/认证流程(API 密钥、OAuth 或提供商特定的手动认证),包括自定义提供商
(与 OpenAI 兼容、与 Anthropic 兼容或未知自动检测)。选择一个默认模型。
安全提示:如果该代理将运行工具或处理 webhook/hooks 内容,请尽可能选择可用的最强最新一代模型,并保持严格的工具策略。较弱/较旧的层级更容易受到提示注入攻击。
对于非交互式运行,APIOAuthOpenAIAnthropic
--secret-input-mode refAPI 将环境变量支持的引用存储在认证配置文件中,而不是纯文本 API 密钥值。 在非交互式ref模式下,必须设置提供商环境变量;如果未设置该环境变量,传递内联密钥标志将快速失败。 在交互式运行中,选择密钥引用模式允许您指向环境变量或已配置的提供商引用 (file或execAnthropicAnthropicCLIAnthropicAPIAnthropic),并在保存前进行快速预检验证。 对于 Anthropic,交互式新手引导/配置提供 Anthropic Claude CLI 作为首选本地路径,提供 Anthropic API 密钥 作为推荐的生产环境路径。Anthropic setup-token 仍然作为支持的令牌认证路径可用。 - 工作区 — 代理文件的位置(默认为
~/.openclaw/workspace)。种子引导文件。 - Gateway(网关) — 端口、绑定地址、认证模式、Tailscale 暴露。
在交互式令牌模式下,选择默认纯文本令牌存储或选择 SecretRef。
非交互式令牌 SecretRef 路径:Gateway(网关)Tailscale
--gateway-token-ref-env <ENV_VAR>。 - 频道 — 内置和官方插件聊天频道,例如 iMessage、Discord、飞书、Google Chat、Mattermost、Microsoft Teams、QQ 机器人、Signal、Slack、Telegram、WhatsApp 等。
- Daemon — 安装 LaunchAgent (macOS)、systemd 用户单元 (Linux/WSL2) 或本机 Windows 计划任务,并带有针对用户的启动文件夹回退机制。
如果令牌认证需要令牌且
gateway.auth.token由 SecretRef 管理,守护进程安装会对其进行验证,但不会将解析出的令牌持久化到监督服务环境元数据中。 如果令牌认证需要令牌且配置的令牌 SecretRef 未解析,守护进程安装将被阻止并提供可操作的指导。 如果同时配置了gateway.auth.token和gateway.auth.password且未设置gateway.auth.mode,则守护进程安装将被阻止,直到显式设置模式。 - 运行状况检查 — 启动 Gateway(网关) 并验证其正在运行。
- Skills — 安装推荐的技能和可选依赖项。
远程模式 仅配置本地客户端以连接到其他位置的 Gateway(网关)。 它不会在远程主机上安装或更改任何内容。
添加另一个代理
Section titled “添加另一个代理”使用 openclaw agents add <name> 创建一个具有独立工作区、会话和身份验证配置文件的独立代理。不带 --workspace 运行将启动新手引导。
设置内容:
agents.list[].nameagents.list[].workspaceagents.list[].agentDir
注意事项:
- 默认工作区遵循
~/.openclaw/workspace-<agentId>。 - 添加
bindings以路由传入消息(新手引导可以执行此操作)。 - 非交互式标志:
--model、--agent-dir、--bind、--non-interactive。
如需详细的逐步分解和配置输出,请参阅 CLI 安装参考。 有关非交互式示例,请参阅 CLI 自动化。 有关更深入的技术参考,包括 RPC 详细信息,请参阅 新手引导参考。
- CLI 命令参考:
openclaw onboard - 新手引导概述:新手引导概述
- macOS 应用新手引导:新手引导
- Agent 首次运行仪式:Agent 自举