入门向导(CLI)
入门向导是建议在 macOS、Linux 或 Windows(通过 WSL2;强烈推荐)上设置 OpenClaw 的推荐方式。它在一个引导流程中配置本地网关或远程网关连接,以及频道、技能和工作区默认设置。
最快的首次聊天:打开控制界面(无需频道设置)。运行
openclaw dashboard ,在浏览器中聊天。文档:Dashboard。--json 并不意味着非交互模式。对于脚本,请使用 --non-interactive。快速开始与高级
向导以 快速开始(默认)或 高级(完全控制)启动。- 快速开始(默认)
- 高级(完全控制)
- 本地网关(回环)
- 工作区默认(或现有工作区)
- 网关端口 18789
- 网关认证 Token(自动生成,即使是回环)
- 新本地设置的工具策略默认:
tools.profile: "coding"(保留现有显式配置文件) - 私聊隔离默认:本地入门在未设置时写入
session.dmScope: "per-channel-peer"。详情:CLI 入门参考 - Tailscale 暴露 关闭
- Telegram + WhatsApp 私聊默认为 允许列表(系统会提示输入你的手机号)
向导配置内容
本地模式(默认) 将引导完成以下步骤:- 模型/认证 — 选择任何支持的提供商/认证流程(API 密钥、OAuth 或 setup-token),包括自定义提供商
(兼容 OpenAI,兼容 Anthropic,或自动检测的未知提供商)。选择默认模型。
安全提示:如果此代理将运行工具或处理 webhook/钩子内容,建议使用最强最新一代模型,并保持工具策略严格。较弱/较旧的模型更易被提示注入。
对于非交互运行,--secret-input-mode ref会在认证配置中存储基于环境变量的引用,而非明文 API 密钥。
在非交互ref模式下,必须设置提供商环境变量;若无该环境变量且传入内联密钥标志,则会快速失败。
在交互运行中,选择秘密引用模式可指向环境变量或配置的提供商引用(file或exec),保存前会快速预验证。 - 工作区 — 代理文件存放位置(默认
~/.openclaw/workspace)。初始化引导文件。 - 网关 — 端口、绑定地址、认证模式、Tailscale 暴露设置。
在交互式令牌模式中,选择默认明文令牌存储或启用 SecretRef。
非交互令牌 SecretRef 路径:--gateway-token-ref-env <ENV_VAR>。 - 频道 — WhatsApp、Telegram、Discord、Google Chat、Mattermost、Signal、BlueBubbles 或 iMessage。
- 守护进程 — 安装 LaunchAgent(macOS)或 systemd 用户单元(Linux/WSL2)。
如果令牌认证需要令牌且gateway.auth.token由 SecretRef 管理,守护进程安装会验证该令牌但不会将解析后的令牌持久化到守护进程服务环境元数据中。
如果令牌认证需要令牌且配置的令牌 SecretRef 未解析,阻止守护进程安装并提供可操作指导。
如果同时配置了gateway.auth.token和gateway.auth.password,且未设置gateway.auth.mode,则阻止守护进程安装,直到显式设置认证模式。 - 健康检查 — 启动网关并确认其运行状态。
- 技能 — 安装推荐技能及可选依赖。
重新运行向导不会清除任何内容,除非你显式选择 重置(或传入
CLI 的
如果配置无效或包含旧版键,向导会提示先运行
--reset)。CLI 的
--reset 默认重置配置、凭据和会话;使用 --reset-scope full 可包括工作区。如果配置无效或包含旧版键,向导会提示先运行
openclaw doctor。它不会在远程主机上安装或更改任何内容。
添加其他代理
使用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 应用入门: 入门
- 代理首次运行流程: 代理引导