openclaw onboard

交互式入职向导(本地或远程网关设置)?

相关指南

示例

openclaw onboard
openclaw onboard --flow quickstart
openclaw onboard --flow manual
openclaw onboard --mode remote --remote-url ws://gateway-host:18789

非交互式自定义提供商?

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-api-key 在非交互式模式下是可选的。如果省略,入职检?CUSTOM_API_KEY?

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

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

使用 --secret-input-mode ref,入职写入环境支持的引用而不是明文密钥值。对于由认证配置文件支持的提供商,这写入 keyRef 条目;对于自定义提供商,这将 models.providers.<id>.apiKey 写为环境引用(例?{ source: "env", provider: "default", id: "CUSTOM_API_KEY" })?

非交互式 ref 模式契约?

  • 在入职流程环境中设置提供商环境变量(例如 OPENAI_API_KEY)?
  • 不要传递内联密钥标志(例如 --openai-api-key),除非该环境变量也已设置?
  • 如果传递内联密钥标志而没有所需的环境变量,入职会快速失败并提供指导?

引用模式的交互式入职行为?

  • 出现提示时选择 使用密钥引用?
  • 然后选择?
    • 环境变量
    • 配置的密钥提供商(file ?exec?
  • 入职在保存引用之前执行快速预检验证?
  • 如果验证失败,入职显示错误并允许重试?

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

注意:--auth-choice zai-api-key 现在自动为你的密钥检测最?Z.AI 端点(优先选择带有 zai/glm-5 的一?API)? 如果你特别想?GLM Coding Plan 端点,请选择 zai-coding-global ?zai-coding-cn?

# 无提示端点选择
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"

流程说明?

  • quickstart:最少提示,自动生成网关令牌?
  • manual:完整提示用于端?绑定/认证(advanced 的别名)?
  • 本地入职私聊范围行为:CLI Onboarding Reference?
  • 最快的首次聊天:openclaw dashboard(控制面板,无需频道设置)?
  • 自定义提供商:连接任?OpenAI ?Anthropic 兼容端点,包括未列出的托管提供商。使?Unknown 进行自动检测?

常用后续命令

openclaw configure
openclaw agents add <name>
`--json` 并不意味着非交互模式。使?`--non-interactive` 用于脚本?