# openclaw onboard

用于本地或远程 Gateway 网关设置的交互式新手引导。

# 相关指南

# 示例

openclaw onboard
openclaw onboard --modern
openclaw onboard --flow quickstart
openclaw onboard --flow manual
openclaw onboard --flow import
openclaw onboard --import-from hermes --import-source ~/.hermes
openclaw onboard --skip-bootstrap
openclaw onboard --mode remote --remote-url wss://gateway-host:18789

--flow import 使用插件拥有的迁移提供商，例如 Hermes。它只会针对全新的 OpenClaw 设置运行；如果已有配置、凭据、会话，或工作区记忆/身份文件，请在导入前重置或选择全新设置。

--modern 会启动 Crestodian 对话式新手引导预览版。不使用 --modern 时，openclaw onboard 会保留经典新手引导流程。

对于明文私有网络 ws:// 目标（仅限受信任网络），请在新手引导进程环境中设置 OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1。 这个客户端侧传输协议应急开关没有对应的 openclaw.json 配置项。

非交互式自定义提供商：

openclaw onboard --non-interactive \
  --auth-choice custom-api-key \
  --custom-base-url "https://llm.example.com/v1" \
  --custom-model-id "foo-large" \
  --custom-api-key "$CUSTOM_API_KEY" \
  --secret-input-mode plaintext \
  --custom-compatibility openai \
  --custom-image-input

--custom-api-key 在非交互式模式下是可选的。如果省略，新手引导会检查 CUSTOM_API_KEY。 OpenClaw 会自动将常见视觉模型 ID 标记为支持图像。对于未知的自定义视觉 ID，请传入 --custom-image-input；或传入 --custom-text-input 强制使用仅文本元数据。

LM Studio 在非交互式模式下也支持特定于提供商的密钥标志：

openclaw onboard --non-interactive \
  --auth-choice lmstudio \
  --custom-base-url "http://localhost:1234/v1" \
  --custom-model-id "qwen/qwen3.5-9b" \
  --lmstudio-api-key "$LM_API_TOKEN" \
  --accept-risk

非交互式 Ollama：

openclaw onboard --non-interactive \
  --auth-choice ollama \
  --custom-base-url "http://ollama-host:11434" \
  --custom-model-id "qwen3.5:27b" \
  --accept-risk

--custom-base-url 默认值为 http://127.0.0.1:11434。--custom-model-id 是可选的；如果省略，新手引导会使用 Ollama 的建议默认值。诸如 kimi-k2.5:cloud 的云模型 ID 在这里也可用。

将提供商密钥存储为引用，而不是明文：

openclaw onboard --non-interactive \
  --auth-choice openai-api-key \
  --secret-input-mode ref \
  --accept-risk

使用 --secret-input-mode ref 时，新手引导会写入由环境变量支持的引用，而不是明文密钥值。 对于由 auth-profile 支持的提供商，这会写入 keyRef 条目；对于自定义提供商，这会将 models.providers.<id>.apiKey 写为环境变量引用（例如 { source: "env", provider: "default", id: "CUSTOM_API_KEY" }）。

非交互式 ref 模式契约：

• 在新手引导进程环境中设置提供商环境变量（例如 OPENAI_API_KEY）。
• 除非该环境变量也已设置，否则不要传入内联密钥标志（例如 --openai-api-key）。
• 如果传入了内联密钥标志但没有所需环境变量，新手引导会快速失败并给出指导。

非交互式模式下的 Gateway 网关令牌选项：

• --gateway-auth token --gateway-token <token> 存储明文令牌。
• --gateway-auth token --gateway-token-ref-env <name> 将 gateway.auth.token 存储为环境变量 SecretRef。
• --gateway-token 和 --gateway-token-ref-env 互斥。
• --gateway-token-ref-env 要求新手引导进程环境中存在非空环境变量。
• 使用 --install-daemon 时，当令牌认证需要令牌时，由 SecretRef 管理的 Gateway 网关令牌会被验证，但不会以解析后的明文形式持久化到 supervisor 服务环境元数据中。
• 使用 --install-daemon 时，如果令牌模式需要令牌且配置的令牌 SecretRef 未解析，新手引导会关闭失败并给出修复指导。
• 使用 --install-daemon 时，如果同时配置了 gateway.auth.token 和 gateway.auth.password，并且 gateway.auth.mode 未设置，新手引导会阻止安装，直到显式设置模式。
• 本地新手引导会将 gateway.mode="local" 写入配置。如果之后的配置文件缺少 gateway.mode，请将其视为配置损坏或未完成的手动编辑，而不是有效的本地模式快捷方式。
• 当所选设置路径需要时，本地新手引导会安装选定的可下载插件。
• 远程新手引导只会写入远程 Gateway 网关的连接信息，不会安装本地插件包。
• --allow-unconfigured 是单独的 Gateway 网关运行时逃生口。它不表示新手引导可以省略 gateway.mode。

示例：

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 \
  --accept-risk

非交互式本地 Gateway 网关健康检查：

• 除非传入 --skip-health，否则新手引导会等待本地 Gateway 网关可达后才成功退出。
• --install-daemon 会先启动托管 Gateway 网关安装路径。没有它时，你必须已经有一个本地 Gateway 网关在运行，例如 openclaw gateway run。
• 如果你只想在自动化中写入配置/工作区/bootstrap，请使用 --skip-health。
• 如果你自行管理工作区文件，请传入 --skip-bootstrap 来设置 agents.defaults.skipBootstrap: true，并跳过创建 AGENTS.md、SOUL.md、TOOLS.md、IDENTITY.md、USER.md、HEARTBEAT.md 和 BOOTSTRAP.md。
• 在原生 Windows 上，--install-daemon 会先尝试 Scheduled Tasks，如果任务创建被拒绝，则回退到每用户 Startup-folder 登录项。

引用模式下的交互式新手引导行为：

• 提示时选择 Use secret reference。
• 然后选择以下任一项：
  • 环境变量
  • 已配置的机密提供商（file 或 exec）
• 新手引导会在保存引用前执行快速预检验证。
  • 如果验证失败，新手引导会显示错误并允许你重试。

# 非交互式 Z.AI 端点选择

# 无提示端点选择
openclaw onboard --non-interactive \
  --auth-choice zai-coding-global \
  --zai-api-key "$ZAI_API_KEY"

# 其他 Z.AI 端点选择：
# --auth-choice zai-coding-cn
# --auth-choice zai-global
# --auth-choice zai-cn

非交互式 Mistral 示例：

openclaw onboard --non-interactive \
  --auth-choice mistral-api-key \
  --mistral-api-key "$MISTRAL_API_KEY"

# 流程说明

# 常用后续命令

openclaw configure
openclaw agents add <name>