跳转到主要内容

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.

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

​
流程详情（本地模式）

1

现有配置检测

  • 如果 ~/.openclaw/openclaw.json 存在，请选择 保留当前值、查看并更新 或 设置前重置。
  • 重新运行新手引导不会清除任何内容，除非你明确选择 重置 （或传入 --reset）。
  • CLI --reset 默认使用 config+creds+sessions；使用 --reset-scope full 还会移除工作区。
  • 如果配置无效或包含旧版键名，向导会停止并要求 你先运行 openclaw doctor 再继续。
  • 重置使用 trash（绝不使用 rm），并提供以下范围：
    • 仅配置
    • 配置 + 凭证 + 会话
    • 完全重置（也会移除工作区）
2

模型/凭证

  • Anthropic API key：如果存在则使用 ANTHROPIC_API_KEY，否则提示输入密钥，然后保存供守护进程使用。
  • Anthropic API key：新手引导/配置中的首选 Anthropic assistant 选项。
  • Anthropic setup-token：仍可在新手引导/配置中使用，不过 OpenClaw 现在会优先复用可用的 Claude CLI。
  • OpenAI Code（Codex）订阅（OAuth）：浏览器流程；粘贴 code#state。
    • 当模型未设置或已经属于 OpenAI 系列时，通过 Codex runtime 将 agents.defaults.model 设置为 openai/gpt-5.5。
  • OpenAI Code（Codex）订阅（设备配对）：浏览器配对流程，使用短期设备代码。
    • 当模型未设置或已经属于 OpenAI 系列时，通过 Codex runtime 将 agents.defaults.model 设置为 openai/gpt-5.5。
  • OpenAI API key：如果存在则使用 OPENAI_API_KEY，否则提示输入密钥，然后存储到凭证档案中。
    • 当模型未设置、为 openai/* 或为 openai-codex/* 时，将 agents.defaults.model 设置为 openai/gpt-5.5。
  • xAI（Grok）API key：提示输入 XAI_API_KEY，并将 xAI 配置为模型提供商。
  • OpenCode：提示输入 OPENCODE_API_KEY（或 OPENCODE_ZEN_API_KEY，可在 https://opencode.ai/auth 获取），并允许你选择 Zen 或 Go 目录。
  • Ollama：首先提供 云端 + 本地、仅云端 或 仅本地。Cloud only 会提示输入 OLLAMA_API_KEY 并使用 https://ollama.com；主机支持的模式会提示输入 Ollama 基础 URL，发现可用模型，并在需要时自动拉取所选的本地模型；Cloud + Local 还会检查该 Ollama 主机是否已登录以获得云端访问权限。
  • 更多详情：Ollama
  • API key：为你存储该密钥。
  • Vercel AI Gateway（多模型代理）：提示输入 AI_GATEWAY_API_KEY。
  • 更多详情：Vercel AI Gateway
  • Cloudflare AI Gateway：提示输入 Account ID、Gateway ID 和 CLOUDFLARE_AI_GATEWAY_API_KEY。
  • 更多详情：Cloudflare AI Gateway
  • MiniMax：配置会自动写入；托管默认值为 MiniMax-M2.7。 API key 设置使用 minimax/...，OAuth 设置使用 minimax-portal/...。
  • 更多详情：MiniMax
  • StepFun：会为中国或全球端点上的 StepFun 标准版或 Step Plan 自动写入配置。
  • 标准版目前包含 step-3.5-flash，Step Plan 还包含 step-3.5-flash-2603。
  • 更多详情：StepFun
  • Synthetic（Anthropic 兼容）：提示输入 SYNTHETIC_API_KEY。
  • 更多详情：Synthetic
  • Moonshot（Kimi K2）：配置会自动写入。
  • Kimi Coding：配置会自动写入。
  • 更多详情：Moonshot AI（Kimi + Kimi Coding）
  • 跳过：暂不配置凭证。
  • 从检测到的选项中选择默认模型（或手动输入 provider/model）。为获得最佳质量并降低提示注入风险，请选择你的提供商栈中可用的最强最新一代模型。
  • 新手引导会运行模型检查，并在配置的模型未知或缺少凭证时发出警告。
  • API key 存储模式默认使用明文凭证档案值。使用 --secret-input-mode ref 可改为存储由环境变量支持的引用（例如 keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }）。
  • 凭证档案位于 ~/.openclaw/agents/<agentId>/agent/auth-profiles.json（API keys + OAuth）。~/.openclaw/credentials/oauth.json 仅为旧版导入源。
  • 更多详情：/concepts/oauth
无头/服务器提示：在带浏览器的机器上完成 OAuth，然后复制 该 agent 的 auth-profiles.json（例如 ~/.openclaw/agents/<agentId>/agent/auth-profiles.json，或匹配的 $OPENCLAW_STATE_DIR/... 路径）到 Gateway 网关主机。credentials/oauth.json 仅是旧版导入源。
3

工作区

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

Gateway 网关

  • 端口、绑定、凭证模式、Tailscale 暴露。
  • 凭证建议：即使是 loopback，也保留 Token，这样本地 WS 客户端必须通过身份验证。
  • 在 token 模式下，交互式设置提供：
    • 生成/存储明文 token（默认）
    • 使用 SecretRef（选择启用）
    • Quickstart 会复用跨 env、file 和 exec 提供商的现有 gateway.auth.token SecretRefs，用于新手引导探测/仪表板启动。
    • 如果该 SecretRef 已配置但无法解析，新手引导会提前失败并显示明确的修复消息，而不是静默降级运行时凭证。
  • 在 password 模式下，交互式设置也支持明文或 SecretRef 存储。
  • 非交互式 token SecretRef 路径：--gateway-token-ref-env <ENV_VAR>。
    • 要求新手引导进程环境中存在非空环境变量。
    • 不能与 --gateway-token 组合使用。
  • 仅当你完全信任每个本地进程时才禁用凭证。
  • 非 loopback 绑定仍需要凭证。
5

渠道

  • WhatsApp：可选 QR 登录。
  • Telegram：bot token。
  • Discord：bot token。
  • Google Chat：服务账号 JSON + webhook audience。
  • Mattermost（插件）：bot token + base URL。
  • Signal：可选 signal-cli 安装 + 账号配置。
  • iMessage：imsg CLI 路径 + Messages DB 访问权限；当 Gateway 网关运行在非 Mac 上时，请使用 SSH 包装器。
  • 私信安全：默认是配对。第一条私信会发送一个代码；通过 openclaw pairing approve <channel> <code> 批准，或使用 allowlists。
6

Web 搜索

  • 选择受支持的提供商，例如 Brave、DuckDuckGo、Exa、Firecrawl、Gemini、Grok、Kimi、MiniMax Search、Ollama Web 搜索、Perplexity、SearXNG 或 Tavily（或跳过）。
  • API 支持的提供商可以使用环境变量或现有配置进行快速设置；无需密钥的提供商则使用其提供商特定的前置条件。
  • 使用 --skip-search 跳过。
  • 稍后配置：openclaw configure --section web。
7

守护进程安装

  • macOS：LaunchAgent
    • 需要已登录的用户会话；对于无头环境，请使用自定义 LaunchDaemon（未随附）。
  • Linux（以及通过 WSL2 的 Windows）：systemd 用户单元
    • 新手引导会尝试通过 loginctl enable-linger <user> 启用 lingering，以便 Gateway 网关在注销后仍保持运行。
    • 可能提示输入 sudo（写入 /var/lib/systemd/linger）；它会先尝试不使用 sudo。
  • 运行时选择： Node（推荐；WhatsApp/Telegram 必需）。Bun 不推荐。
  • 如果 token 凭证需要 token，且 gateway.auth.token 由 SecretRef 管理，守护进程安装会验证它，但不会将解析后的明文 token 值持久化到 supervisor 服务环境元数据中。
  • 如果 token 凭证需要 token，且配置的 token SecretRef 未解析，守护进程安装会被阻止，并给出可操作的指导。
  • 如果同时配置了 gateway.auth.token 和 gateway.auth.password，且 gateway.auth.mode 未设置，守护进程安装会被阻止，直到显式设置模式。
8

健康检查

  • 启动 Gateway 网关（如需要）并运行 openclaw health。
  • 提示：openclaw status --deep 会将实时 Gateway 网关健康探测添加到状态输出中，包括受支持时的渠道探测（需要可访问的 Gateway 网关）。
9

Skills（推荐）

  • 读取可用 Skills 并检查要求。
  • 允许你选择节点管理器：npm / pnpm（不推荐 bun）。
  • 安装可选依赖（部分在 macOS 上使用 Homebrew）。
10

完成

  • 摘要 + 后续步骤，包括 你想如何孵化你的 agent？ 提示，可选择 Terminal、Browser 或稍后。
如果未检测到 GUI，新手引导会打印 Control UI 的 SSH 端口转发说明，而不是打开浏览器。 如果缺少 Control UI 资产，新手引导会尝试构建它们；回退方案是 pnpm ui:build（自动安装 UI 依赖）。

​
非交互式模式

使用 --non-interactive 自动化或编写新手引导脚本： 
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： 
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 互斥。
--json 并不意味着非交互式模式。脚本请使用 --non-interactive（以及 --workspace）。
提供商特定命令示例位于 CLI 自动化。 使用此参考页了解标志语义和步骤顺序。

​
添加 agent（非交互式）

openclaw agents add work \
  --workspace ~/.openclaw/workspace-work \
  --model openai/gpt-5.5 \
  --bind whatsapp:biz \
  --non-interactive \
  --json

​
Gateway 网关向导 RPC

Gateway 网关通过 RPC（wizard.start、wizard.next、wizard.cancel、wizard.status）暴露新手引导流程。 客户端（macOS app、Control UI）可以渲染步骤，而无需重新实现新手引导逻辑。

​
Signal 设置（signal-cli）

新手引导可以从 GitHub releases 安装 signal-cli：
  • 下载适当的 release 资产。
  • 将其存储在 ~/.openclaw/tools/signal-cli/<version>/ 下。
  • 将 channels.signal.cliPath 写入你的配置。
注意：
  • JVM 构建需要 Java 21。
  • 可用时会使用原生构建。
  • Windows 使用 WSL2；signal-cli 安装遵循 WSL 内部的 Linux 流程。

​
向导写入的内容

~/.openclaw/openclaw.json 中的典型字段：
  • agents.defaults.workspace
  • agents.defaults.model / models.providers（如果选择了 Minimax）
  • tools.profile（未设置时，本地新手引导默认使用 "coding"；现有显式值会保留）
  • gateway.*（mode, bind, auth, tailscale）
  • session.dmScope（行为详情：CLI 设置参考）
  • channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
  • 当你在提示中选择加入时的渠道允许列表（Slack/Discord/Matrix/Microsoft Teams）（可行时名称会解析为 ID）。
  • skills.install.nodeManager
    • setup --node-manager 接受 npm、pnpm 或 bun。
    • 手动配置仍可通过直接设置 skills.install.nodeManager 来使用 yarn。
  • 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 或本地路径）。

​
相关文档