English简体中文繁體中文日本語EspañolPortuguês (BR)한국어DeutschFrançaisالعربيةItalianoTiếng ViệtNederlandsTürkçeУкраїнськаBahasa IndonesiaPolskiفارسیไทย

快速开始

CLI 设置参考

Edit source

此页是 openclaw onboard 的完整参考。 短版指南见 新手引导（CLI）。

向导会做什么

本地模式（默认）会引导你完成：

  • 模型和凭证设置（OpenAI Code 订阅 OAuth、Anthropic Claude CLI 或 API key，以及 MiniMax、GLM、Ollama、Moonshot、StepFun 和 AI Gateway 选项）
  • 工作区位置和引导文件
  • Gateway 网关设置（端口、绑定、凭证、tailscale）
  • 渠道和提供商（Telegram、WhatsApp、Discord、Google Chat、Mattermost、Signal、iMessage，以及其他内置渠道插件）
  • 守护进程安装（LaunchAgent、systemd 用户单元，或原生 Windows 计划任务，并以启动文件夹作为回退）
  • 健康检查
  • Skills 设置

远程模式会配置这台机器连接到其他位置的 Gateway 网关。 它不会在远程主机上安装或修改任何内容。

本地流程详情

  • 现有配置检测

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

  • 模型和凭证

  • 工作区

    • 默认 ~/.openclaw/workspace（可配置）。
    • 写入首次运行引导流程所需的工作区文件。
    • 工作区布局：Agent 工作区。

  • Gateway 网关

    • 提示输入端口、绑定、凭证模式和 tailscale 暴露设置。
    • 建议：即使是 loopback，也保持 token 凭证启用，以便本地 WS 客户端必须进行身份验证。
    • 在 token 模式中，交互式设置提供：
      • 生成/存储明文 token（默认）
      • 使用 SecretRef（选择启用）
    • 在密码模式中，交互式设置也支持明文或 SecretRef 存储。
    • 非交互式 token SecretRef 路径：--gateway-token-ref-env <ENV_VAR>。
      • 要求新手引导进程环境中有一个非空环境变量。
      • 不能与 --gateway-token 组合使用。
    • 只有在你完全信任每一个本地进程时，才禁用凭证。
    • 非 loopback 绑定仍然需要凭证。

  • 渠道

    • WhatsApp：可选二维码登录
    • Telegram：bot token
    • Discord：bot token
    • Google Chat：服务账号 JSON + webhook audience
    • Mattermost：bot token + base URL
    • Signal：可选 signal-cli 安装 + 账号配置
    • iMessage：imsg CLI 路径 + Messages 数据库访问；当 Gateway 网关运行在非 Mac 设备上时使用 SSH wrapper
    • 私信安全：默认是配对。第一条私信会发送一个代码；通过 openclaw pairing approve <channel> <code> 批准，或使用允许列表。

  • 守护进程安装

    • macOS：LaunchAgent
      • 需要已登录的用户会话；无头环境请使用自定义 LaunchDaemon（未随附）。
    • Linux 和通过 WSL2 的 Windows：systemd 用户单元
      • 向导会尝试 loginctl enable-linger <user>，让 Gateway 网关在登出后继续运行。
      • 可能会提示使用 sudo（写入 /var/lib/systemd/linger）；它会先尝试不使用 sudo。
    • 原生 Windows：优先使用计划任务
      • 如果任务创建被拒绝，OpenClaw 会回退到每用户启动文件夹登录项，并立即启动 Gateway 网关。
      • 计划任务仍是首选，因为它提供更好的 supervisor 状态。
    • 运行时选择：Node（推荐；WhatsApp 和 Telegram 必需）。不推荐 Bun。

  • 健康检查

    • 启动 Gateway 网关（如需要），并运行 openclaw health。
    • openclaw status --deep 会将实时 Gateway 网关健康探测加入状态输出，包括受支持时的渠道探测。

  • Skills

    • 读取可用 Skills 并检查要求。
    • 让你选择 node 管理器：npm、pnpm 或 bun。
    • 安装可选依赖（部分在 macOS 上使用 Homebrew）。

  • 完成

    • 摘要和后续步骤，包括 iOS、Android 和 macOS 应用选项。

    • 远程模式详情

    远程模式会配置这台机器连接到其他位置的 Gateway 网关。

    你需要设置：

    • 远程 Gateway 网关 URL（ws://...）
    • 如果远程 Gateway 网关需要凭证，则设置 token（推荐）

    凭证和模型选项

    Anthropic API key

    如果存在则使用 ANTHROPIC_API_KEY，否则提示输入密钥，然后保存它供守护进程使用。

    OpenAI Code 订阅（OAuth）

    浏览器流程；粘贴 code#state。

    当模型未设置或已是 OpenAI 系列时，通过 Codex harness runtime 将 agents.defaults.model 设置为 openai/gpt-5.5。

    OpenAI Code 订阅（设备配对）

    使用短期设备代码的浏览器配对流程。

    当模型未设置或已是 OpenAI 系列时，通过 Codex harness runtime 将 agents.defaults.model 设置为 openai/gpt-5.5。

    OpenAI API key

    如果存在则使用 OPENAI_API_KEY，否则提示输入密钥，然后将凭证存储到 auth profiles 中。

    当模型未设置、为 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），并让你选择 Zen 或 Go 目录。 设置 URL：opencode.ai/auth。

    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；API-key 设置使用 minimax/...，OAuth 设置使用 minimax-portal/...。 更多详情：MiniMax。

    StepFun

    会为中国或全球端点上的 StepFun standard 或 Step Plan 自动写入配置。 Standard 当前包含 step-3.5-flash，Step Plan 还包含 step-3.5-flash-2603。 更多详情：StepFun。

    Synthetic（Anthropic 兼容）

    提示输入 SYNTHETIC_API_KEY。 更多详情：Synthetic。

    Ollama（云端和本地开放模型）

    首先提示选择 Cloud + Local、Cloud only 或 Local only。 Cloud only 使用 OLLAMA_API_KEY 和 https://ollama.com。 主机支持的模式会提示输入 base URL（默认 http://127.0.0.1:11434）、发现可用模型，并建议默认值。 Cloud + Local 还会检查该 Ollama 主机是否已登录以获得云端访问权限。 更多详情：Ollama。

    Moonshot 和 Kimi Coding

    Moonshot（Kimi K2）和 Kimi Coding 配置会自动写入。 更多详情：Moonshot AI（Kimi + Kimi Coding）。

    自定义提供商

    可与 OpenAI 兼容和 Anthropic 兼容端点配合使用。

    交互式新手引导支持与其他提供商 API key 流程相同的 API key 存储选择：

    • 立即粘贴 API key（明文）
    • 使用密钥引用（env ref 或已配置 provider ref，并带预检验证）

    非交互式标志：

    • --auth-choice custom-api-key
    • --custom-base-url
    • --custom-model-id
    • --custom-api-key（可选；回退到 CUSTOM_API_KEY）
    • --custom-provider-id（可选）
    • --custom-compatibility <openai|anthropic>（可选；默认 openai）
    • --custom-image-input / --custom-text-input（可选；覆盖推断出的模型输入能力）
    跳过

    保持凭证未配置。

    模型行为：

    • 从检测到的选项中选择默认模型，或手动输入提供商和模型。
    • 自定义提供商新手引导会为常见模型 ID 推断图像支持，并且只在模型名称未知时询问。
    • 当新手引导从提供商凭证选择开始时，模型选择器会自动优先使用 该提供商。对于 Volcengine 和 BytePlus，相同偏好 也会匹配它们的 coding-plan 变体（volcengine-plan/*、 byteplus-plan/*）。
    • 如果该首选提供商筛选结果为空，选择器会回退到 完整目录，而不是显示没有模型。
    • 向导会运行模型检查，并在配置的模型未知或缺少凭证时发出警告。

    凭证和 profile 路径：

    • Auth profiles（API keys + OAuth）：~/.openclaw/agents/<agentId>/agent/auth-profiles.json
    • 旧版 OAuth 导入：~/.openclaw/credentials/oauth.json

    凭证存储模式：

    • 默认新手引导行为会将 API keys 作为明文值持久化到 auth profiles 中。
    • --secret-input-mode ref 启用引用模式，而不是明文密钥存储。 在交互式设置中，你可以选择：
      • 环境变量 ref（例如 keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }）
      • 已配置 provider ref（file 或 exec），带提供商别名 + id
    • 交互式引用模式会在保存前运行快速预检验证。
      • Env refs：验证变量名 + 当前新手引导环境中的非空值。
      • Provider refs：验证提供商配置并解析请求的 id。
      • 如果预检失败，新手引导会显示错误并允许你重试。
    • 在非交互式模式中，--secret-input-mode ref 仅由 env 支持。
      • 在新手引导进程环境中设置提供商环境变量。
      • 内联密钥标志（例如 --openai-api-key）要求设置该环境变量；否则新手引导会快速失败。
      • 对于自定义提供商，非交互式 ref 模式会将 models.providers.<id>.apiKey 存储为 { source: "env", provider: "default", id: "CUSTOM_API_KEY" }。
      • 在该自定义提供商场景中，--custom-api-key 要求设置 CUSTOM_API_KEY；否则新手引导会快速失败。
    • Gateway 网关凭证在交互式设置中支持明文和 SecretRef 选择：
      • Token 模式：生成/存储明文 token（默认）或 使用 SecretRef。
      • 密码模式：明文或 SecretRef。
    • 非交互式 token SecretRef 路径：--gateway-token-ref-env &lt;ENV_VAR&gt;。
    • 现有明文设置会继续原样工作。

    输出和内部机制

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

    • agents.defaults.workspace
    • 传入 --skip-bootstrap 时的 agents.defaults.skipBootstrap
    • agents.defaults.model / models.providers（如果选择了 Minimax）
    • tools.profile（本地新手引导在未设置时默认为 "coding"；保留现有显式值）
    • gateway.*（模式、绑定、认证、tailscale）
    • session.dmScope（本地新手引导在未设置时默认为 per-channel-peer；保留现有显式值）
    • 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/ 下。

    Gateway 网关向导 RPC：

    • wizard.start
    • wizard.next
    • wizard.cancel
    • wizard.status

    客户端（macOS 应用和控制 UI）可以渲染步骤，而无需重新实现新手引导逻辑。

    Signal 设置行为：

    • 下载适用的发布资产
    • 将其存储在 ~/.openclaw/tools/signal-cli/<version>/ 下
    • 在配置中写入 channels.signal.cliPath
    • JVM 构建需要 Java 21
    • 可用时使用原生构建
    • Windows 使用 WSL2，并在 WSL 内遵循 Linux signal-cli 流程

    相关文档

    Was this useful?