跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

CLI 新手引导是在 macOS、Linux 或 Windows（通过 WSL2；强烈推荐）上设置 OpenClaw 的推荐方式。 它会在一个引导式流程中配置本地 Gateway 网关或远程 Gateway 网关连接，以及渠道、技能和工作区默认值。 
openclaw onboard
最快开始第一次聊天：打开控制 UI（无需设置渠道）。运行 openclaw dashboard 并在浏览器中聊天。文档：仪表板。
稍后重新配置： 
openclaw configure
openclaw agents add <name>
--json 不表示非交互模式。脚本请使用 --non-interactive。
CLI 新手引导包含一个 Web 搜索步骤，你可以在其中选择提供商， 例如 Brave、DuckDuckGo、Exa、Firecrawl、Gemini、Grok、Kimi、MiniMax Search、 Ollama Web Search、Perplexity、SearXNG 或 Tavily。某些提供商需要 API key，而其他提供商无需密钥。你也可以稍后使用 openclaw configure --section web 配置此项。文档：Web 工具。

​
快速开始与高级

新手引导从快速开始（默认值）与高级（完全控制）开始。
  • 本地 Gateway 网关（loopback）
  • 工作区默认值（或现有工作区）
  • Gateway 网关端口 18789
  • Gateway 网关认证 Token（自动生成，即使在 loopback 上也是如此）
  • 新本地设置的工具策略默认值：tools.profile: "coding"（保留现有显式 profile）
  • 私信隔离默认值：本地新手引导会在未设置时写入 session.dmScope: "per-channel-peer"。详情：CLI 设置参考
  • Tailscale 暴露关闭
  • Telegram + WhatsApp 私信默认使用允许列表（系统会提示你输入电话号码）

​
新手引导会配置什么

**本地模式（默认）**会引导你完成以下步骤：
  1. 模型/认证 — 选择任意受支持的提供商/认证流程（API key、OAuth 或提供商专用手动认证），包括 Custom Provider （OpenAI 兼容、Anthropic 兼容或 Unknown 自动检测）。选择默认模型。 安全注意事项：如果此 agent 将运行工具或处理 webhook/hooks 内容，请优先选择可用的最强最新一代模型，并保持工具策略严格。较弱/较旧的层级更容易被提示注入。 对于非交互运行，--secret-input-mode ref 会在认证 profile 中存储由环境变量支持的引用，而不是明文 API key 值。 在非交互 ref 模式中，必须设置提供商环境变量；如果没有该环境变量却传入内联密钥 flag，会快速失败。 在交互运行中，选择密钥引用模式可让你指向环境变量或已配置的提供商引用（file 或 exec），并在保存前进行快速预检验证。 对于 Anthropic，交互式新手引导/配置会提供 Anthropic Claude CLI 作为首选本地路径，并提供 Anthropic API key 作为推荐生产路径。Anthropic setup-token 也仍作为受支持的 token-auth 路径可用。
  2. 工作区 — agent 文件的位置（默认 ~/.openclaw/workspace）。会生成引导文件。
  3. Gateway 网关 — 端口、绑定地址、认证模式、Tailscale 暴露。 在交互式 token 模式中，选择默认明文 token 存储，或选择使用 SecretRef。 非交互 token SecretRef 路径：--gateway-token-ref-env <ENV_VAR>。
  4. 渠道 — 内置和捆绑的聊天渠道，例如 iMessage、Discord、Feishu、Google Chat、Mattermost、Microsoft Teams、QQ Bot、Signal、Slack、Telegram、WhatsApp 等。
  5. 守护进程 — 安装 LaunchAgent（macOS）、systemd 用户单元（Linux/WSL2），或原生 Windows 计划任务，并带有按用户 Startup 文件夹的回退方案。 如果 token 认证需要 token 且 gateway.auth.token 由 SecretRef 管理，守护进程安装会验证它，但不会将解析后的 token 持久化到 supervisor 服务环境元数据中。 如果 token 认证需要 token 且配置的 token SecretRef 未解析，守护进程安装会被阻止，并给出可操作指导。 如果同时配置了 gateway.auth.token 和 gateway.auth.password，且未设置 gateway.auth.mode，守护进程安装会被阻止，直到显式设置模式。
  6. 健康检查 — 启动 Gateway 网关并验证它正在运行。
  7. Skills — 安装推荐 Skills 和可选依赖项。
重新运行新手引导不会清除任何内容，除非你明确选择重置（或传入 --reset）。 CLI --reset 默认重置配置、凭据和会话；使用 --reset-scope full 可包含工作区。 如果配置无效或包含旧版键名，新手引导会要求你先运行 openclaw doctor。
远程模式只会配置本地客户端以连接到其他位置的 Gateway 网关。 它不会在远程主机上安装或更改任何内容。

​
添加另一个 agent

使用 openclaw agents add <name> 创建一个独立 agent，它有自己的工作区、 会话和认证 profile。不带 --workspace 运行会启动新手引导。 它会设置：
  • agents.list[].name
  • agents.list[].workspace
  • agents.list[].agentDir
注意：
  • 默认工作区遵循 ~/.openclaw/workspace-<agentId>。
  • 添加 bindings 可路由入站消息（新手引导可以执行此操作）。
  • 非交互 flag：--model、--agent-dir、--bind、--non-interactive。

​
完整参考

有关详细的分步说明和配置输出，请参阅 CLI 设置参考。 有关非交互示例，请参阅 CLI 自动化。 有关更深入的技术参考（包括 RPC 详情），请参阅 新手引导参考。

​
相关文档