跳转到内容
OpenClaw Docs

新手引导参考

新手引导参考

Section titled “新手引导参考”

这是 openclaw onboard 的完整参考。 如需高层次概览，请参阅 新手引导 (CLI)。

流程详细信息（本地模式）

Section titled “流程详细信息（本地模式）”

  1. 现有配置检测

    • 如果存在 ~/.openclaw/openclaw.json，请选择 保留 / 修改 / 重置。
    • 重新运行新手引导不会清除任何内容，除非您明确选择 重置 （或传递 --reset）。
    • CLI --reset 默认为 config+creds+sessions；使用 --reset-scope full 同时删除工作区。
    • 如果配置无效或包含旧版键，向导将停止并要求 您在继续之前运行 openclaw doctor。
    • 重置使用 trash（绝不使用 rm）并提供范围选项：
      • 仅配置
      • 配置 + 凭证 + 会话
      • 完全重置（也会删除工作区）

  2. Model/Auth

    • Anthropic API key：如果存在 ANTHROPIC_API_KEY 则使用它，否则提示输入密钥，然后将其保存以供守护进程使用。
    • Anthropic Claude CLI：在 macOS 上，新手引导会检查钥匙串项“Claude Code-credentials”（选择“始终允许”以免 launchd 启动受阻）；在 Linux/Windows 上，如果存在 ~/.claude/.credentials.json 则会复用它，并将模型选择切换到 claude-cli/...。
    • Anthropic token（粘贴 setup-token）：在任何机器上运行 claude setup-token，然后粘贴 token（您可以为其命名；空白则表示默认）。
    • OpenAI Code (Codex) 订阅 (Codex CLI)：如果 ~/.codex/auth.json 存在，新手引导可以复用它。
    • OpenAI Code (Codex) 订阅 (OAuth)：浏览器流程；粘贴 code#state。
      • 当模型未设置或 openai/* 时，将 agents.defaults.model 设置为 openai-codex/gpt-5.2。
    • OpenAI API key：如果存在 OPENAI_API_KEY 则使用它，否则提示输入密钥，然后将其存储在身份验证配置文件中。
    • xAI (Grok) API key：提示输入 XAI_API_KEY 并将 xAI 配置为模型提供商。
    • OpenCode：提示输入 OPENCODE_API_KEY（或 OPENCODE_ZEN_API_KEY，在 https://opencode.ai/auth 获取），并让您选择 Zen 或 Go 目录。
    • Ollama：提示输入 Ollama 基础 URL，提供 Cloud + Local 或 Local 模式，发现可用模型，并在需要时自动拉选定的本地模型。
    • 更多详情：Ollama
    • API key：为您存储密钥。
    • Vercel AI Gateway(网关)（多模型代理）：提示输入 AI_GATEWAY_API_KEY。
    • 更多详情：Vercel AI Gateway(网关)
    • Cloudflare AI Gateway(网关)：提示输入账户 ID、Gateway(网关) ID 和 CLOUDFLARE_AI_GATEWAY_API_KEY。
    • 更多详情：Cloudflare AI Gateway(网关)
    • MiniMax：配置自动写入；托管默认值为 MiniMax-M2.7。
    • 更多详情：MiniMax
    • Synthetic (Anthropic-compatible)：提示输入 SYNTHETIC_API_KEY。
    • 更多详情：Synthetic
    • Moonshot (Kimi K2)：配置自动写入。
    • Kimi Coding：配置自动写入。
    • 更多详情：Moonshot AI (Kimi + Kimi Coding)
    • Skip：尚未配置身份验证。
    • 从检测到的选项中选择默认模型（或手动输入提供商/模型）。为了获得最佳质量和更低的提示注入风险，请选择您提供商堆栈中可用的最强最新一代模型。
    • 新手引导运行模型检查，如果配置的模型未知或缺少身份验证，则会发出警告。
    • API 密钥存储模式默认为纯文本身份验证配置文件值。使用 --secret-input-mode ref 来存储环境变量支持的引用（例如 keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }）。
    • OAuth 凭据位于 ~/.openclaw/credentials/oauth.json 中；身份验证配置文件位于 `~/.openclaw/agents/

    /agent/auth-profiles.json` 中（API 密钥 + OAuth）。 - 更多详情：/concepts/oauth

  3. Workspace

    • 默认 ~/.openclaw/workspace （可配置）。
    • 播种 agent 引导仪式所需的工作区文件。
    • 完整的工作区布局 + 备份指南：Agent workspace

  4. Gateway(网关)

    • 端口、绑定、认证模式、Tailscale 暴露。
    • 认证建议：即使是环回也保留 Token，以便本地 WS 客户端必须进行身份验证。
    • 在 Token 模式下，交互式设置提供：
      • 生成/存储明文令牌（默认）
      • 使用 SecretRef（可选）
      • 快速启动会跨 env、file 和 exec 提供程序重用现有的 gateway.auth.token SecretRefs，用于引导探针/仪表板引导。
      • 如果配置了该 SecretRef 但无法解析，引导将提前失败并显示清晰的修复消息，而不是在运行时静默降低认证级别。
    • 在密码模式下，交互式设置也支持明文或 SecretRef 存储。
    • 非交互式令牌 SecretRef 路径：`—gateway-token-ref-env

    。 - 要求在引导进程环境中设置非空的环境变量。 - 不能与 —gateway-token` 组合使用。 - 仅当您完全信任每个本地进程时，才禁用认证。 - 非环回绑定仍然需要认证。

  5. Channels

    • WhatsApp：可选的二维码登录。
    • Telegram：机器人令牌。
    • Discord：机器人令牌。
    • Google Chat：服务账户 JSON + Webhook 受众。
    • Mattermost （插件）：机器人令牌 + 基础 URL。
    • Signal：可选的 signal-cli 安装 + 账户配置。
    • BlueBubbles：推荐用于 iMessage；服务器 URL + 密码 + Webhook。
    • iMessage：旧版 imsg CLI 路径 + 数据库访问权限。
    • 私信安全性：默认为配对。第一条私信会发送一个代码；通过 `openclaw pairing approve

    ` 批准或使用允许列表。

非交互模式

Section titled “非交互模式”

使用 --non-interactive 自动化或编写新手引导脚本：

Terminal window
openclaw onboard --non-interactive \
  --mode local \
  --auth-choice apiKey \
  --anthropic-api-key "$ANTHROPIC_API_KEY" \
  --gateway-port 18789 \
  --gateway-bind loopback \
  --install-daemon \
  --daemon-runtime node \
  --skip-skills

添加 --json 以获取机器可读的摘要。

非交互模式下的 Gateway(网关) 网关 token SecretRef：

Terminal window
export OPENCLAW_GATEWAY_TOKEN="your-token"
openclaw onboard --non-interactive \
  --mode local \
  --auth-choice skip \
  --gateway-auth token \
  --gateway-token-ref-env OPENCLAW_GATEWAY_TOKEN

--gateway-token 和 --gateway-token-ref-env 互斥。

特定于提供商的命令示例位于 CLI Automation 中。 使用此参考页面了解标志语义和步骤顺序。

添加代理（非交互）

Section titled “添加代理（非交互）”
Terminal window
openclaw agents add work \
  --workspace ~/.openclaw/workspace-work \
  --model openai/gpt-5.2 \
  --bind whatsapp:biz \
  --non-interactive \
  --json

Gateway(网关) 网关向导 RPC

Section titled “Gateway(网关) 网关向导 RPC”

Gateway(网关) 通过 RPC (wizard.start, wizard.next, wizard.cancel, wizard.status) 公开新手引导流程。 客户端（macOS 应用、控制 UI）可以渲染步骤而无需重新实现新手引导逻辑。

Signal 设置 (signal-cli)

Section titled “Signal 设置 (signal-cli)”

新手引导可以从 GitHub 版本安装 signal-cli：

  • 下载相应的版本资产。
  • 将其存储在 ~/.openclaw/tools/signal-cli/<version>/ 下。
  • 将 channels.signal.cliPath 写入您的配置。

注意事项：

  • JVM 构建版本需要 Java 21。
  • 如果可用，将使用原生构建版本。
  • Windows 使用 WSL2；signal-cli 安装遵循 WSL 内部的 Linux 流程。

向导写入的内容

Section titled “向导写入的内容”

~/.openclaw/openclaw.json 中的典型字段：

  • agents.defaults.workspace
  • agents.defaults.model / models.providers （如果选择了 Minimax）
  • tools.profile （如果未设置，本地新手引导默认为 "coding"；现有的显式值将被保留）
  • gateway.* （mode, bind, auth, tailscale）
  • session.dmScope （行为详情：[CLI Setup Reference](/en/start/wizard-cli-reference#outputs-and-internals））
  • channels.telegram.botToken，channels.discord.token，channels.matrix.*，channels.signal.*，channels.imessage.*
  • 频道允许列表（Slack/Discord/Matrix/Microsoft Teams），当您在提示期间选择加入时（名称尽可能解析为 ID）。
  • skills.install.nodeManager
  • wizard.lastRunAt
  • wizard.lastRunVersion
  • wizard.lastRunCommit
  • wizard.lastRunCommand
  • wizard.lastRunMode

openclaw agents add 会写入 agents.list[] 和可选的 bindings。

WhatsApp 凭证位于 ~/.openclaw/credentials/whatsapp/<accountId>/ 下。 会话存储在 ~/.openclaw/agents/<agentId>/sessions/ 下。

某些通道以插件形式提供。当您在设置期间选择一个时，新手引导 将提示您安装它 (npm 或本地路径)，然后才能对其进行配置。

相关文档

Section titled “相关文档”