英文 CLI reference wizard
- 原始链接:https://docs.openclaw.ai/start/wizard-cli-reference
- 来源章节:2. 官方文档:入门必读
- 来源小节:无
- 抓取方式:jina:https://r.jina.ai/http://docs.openclaw.ai/start/wizard-cli-reference
- 抓取时间:2026-04-05 13:47:10
- 状态:ok
中文内容
CLI 设置参考 - OpenClaw
[OpenClaw主页!图片1:深色徽标!图片2:深色徽标](http://docs.openclaw.ai/)
英语
搜索...
⌘K
搜索...
导航
指南
CLI 设置参考
概述
第一步
指南
在此页面上
指南
CLI 设置参考
CLI 设置参考
本页是“openclaw onboard”的完整参考。有关简短指南,请参阅入门 (CLI)。
向导做什么
本地模式(默认)将引导您完成:
- 模型和身份验证设置(OpenAI Code 订阅 OAuth、Anthropic Claude CLI 或 API 密钥,以及 MiniMax、GLM、Ollama、Moonshot、StepFun 和 AI Gateway 选项)
- 工作区位置和引导文件
- 网关设置(端口、绑定、身份验证、tailscale)
- 渠道和提供商(Telegram、WhatsApp、Discord、Google Chat、Mattermost、Signal、BlueBubbles 和其他捆绑渠道插件)
- 守护进程安装(LaunchAgent、systemd 用户单元或具有启动文件夹回退功能的本机 Windows 计划任务)
- 健康检查
- 技能设置
远程模式将此计算机配置为连接到其他地方的网关。它不会在远程主机上安装或修改任何内容。
本地流量详情
1
现有配置检测
- 如果
~/.openclaw/openclaw.json存在,请选择“保留”、“修改”或“重置”。 - 重新运行向导不会擦除任何内容,除非您明确选择重置(或传递“--reset”)。
- CLI
--reset默认为config+creds+sessions;使用“--reset-scope full”也可以删除工作空间。 - 如果配置无效或包含旧密钥,向导将停止并要求您在继续之前运行“openclaw doctor”。
- Reset 使用
trash并提供范围:- 仅配置
- 配置+凭证+会话
- 完全重置(也删除工作空间)
2
型号及授权
- 完整选项矩阵位于Auth 和模型选项。
3
工作空间
- 默认
~/.openclaw/workspace(可配置)。 - 种子首次运行引导仪式所需的工作空间文件。
- 工作区布局:代理工作区。
4
网关
-
提示端口、绑定、身份验证模式和 tailscale 暴露。
-
建议:即使对于环回也保持启用令牌身份验证,以便本地 WS 客户端必须进行身份验证。
-
在令牌模式下,交互式设置提供:
- 生成/存储明文令牌(默认)
- 使用 SecretRef(选择加入)
-
在密码模式下,交互式设置还支持明文或SecretRef存储。
-
非交互式令牌 SecretRef 路径:
--gateway-token-ref-env <ENV_VAR>。- 入职流程环境中需要非空环境变量。
- 不能与
--gateway-token结合使用。
-
仅当您完全信任每个本地进程时才禁用身份验证。
-
非环回绑定仍然需要身份验证。
5
渠道
- WhatsApp: 可选二维码登录
- Telegram: 机器人令牌
- Discord: 机器人令牌
- Google Chat:服务帐户 JSON + webhook 受众
- Mattermost: 机器人令牌 + 基本 URL
- Signal: 可选的
signal-cli安装 + 帐户配置 - BlueBubbles:推荐用于 iMessage;服务器 URL + 密码 + webhook
- iMessage:旧版
imsgCLI 路径 + 数据库访问 - DM 安全:默认为配对。首先DM发送一个代码;通过“openclaw 配对批准 ” 批准或使用白名单。
6
守护进程安装
-
macOS:启动代理
- 需要登录的用户会话;对于无头,使用自定义 LaunchDaemon(未发货)。
-
Linux 和 Windows 通过 WSL2:systemd 用户单元
- 向导尝试“loginctl enable-linger ”,以便网关在注销后保持运行状态。
- 可能会提示输入 sudo (写入
/var/lib/systemd/linger);它首先尝试不使用 sudo 。
-
本机Windows:计划任务优先
- 如果任务创建被拒绝,OpenClaw 将退回到每用户启动文件夹登录项并立即启动网关。
- 计划任务仍然是首选,因为它们提供更好的主管状态。
-
运行时选择:Node(推荐;WhatsApp 和 Telegram 必需)。不推荐包子。
7
健康检查
- 启动网关(如果需要)并运行“openclaw health”。
openclaw status --deep将实时网关运行状况探测添加到状态输出,包括支持的通道探测。
8
技能
- 阅读可用技能并检查要求。
- 允许您选择节点管理器:npm、pnpm 或 Bun。
- 安装可选依赖项(有些在 macOS 上使用 Homebrew)。
9
完成
- 摘要和后续步骤,包括 iOS、Android 和 macOS 应用选项。
如果未检测到 GUI,向导将打印控制 UI 的 SSH 端口转发指令,而不是打开浏览器。如果 Control UI 资源丢失,向导会尝试构建它们;后备是“pnpm ui:build”(自动安装 UI 依赖项)。
远程模式详细信息
远程模式将此计算机配置为连接到其他地方的网关。
远程模式不会在远程主机上安装或修改任何内容。
您设置的内容:
-
远程网关 URL (
ws://...) -
如果需要远程网关身份验证,则使用令牌(推荐)
-
如果网关仅环回,请使用 SSH 隧道或尾网。
-
发现提示:
- macOS:Bonjour (
dns-sd) - Linux:Avahi(
avahi-browse)
- macOS:Bonjour (
授权和型号选项
人为 API 密钥
使用“ANTHROPIC_API_KEY”(如果存在)或提示输入密钥,然后将其保存以供守护程序使用。
人类克劳德 CLI
在网关主机上重用本地 Claude CLI 登录,并将模型选择切换到规范的“claude-cli/claude-*” ref。这是“openclaw onboard”和“openclaw configure”中的首选交互式人类路径。
- macOS:检查钥匙串项“Claude Code-credentials”
- Linux 和 Windows:重用
~/.claude/.credentials.json(如果存在)
在 macOS 上,选择“始终允许”,这样 launchd 启动就不会被阻止。
OpenAI 代码订阅(Codex CLI 重用)
如果 ~/.codex/auth.json 存在,向导可以重用它。重复使用的 Codex CLI 凭证仍由 Codex CLI 管理;到期时,OpenClaw 首先重新读取该源,并且当提供者可以刷新它时,将刷新的凭证写回 Codex 存储,而不是自行获取所有权。
OpenAI 代码订阅 (OAuth)
浏览器流量;粘贴“code#state”。当模型未设置或“openai/*”时,将“agents.defaults.model”设置为“openai-codex/gpt-5.4”。
OpenAI API 密钥
使用“OPENAI_API_KEY”(如果存在)或提示输入密钥,然后将凭据存储在身份验证配置文件中。当模型未设置时,将“agents.defaults.model”设置为“openai/gpt-5.4”、“openai/”或“openai-codex/”。
xAI (Grok) API 密钥
提示输入“XAI_API_KEY”并将 xAI 配置为模型提供程序。
开放代码
提示输入“OPENCODE_API_KEY”(或“OPENCODE_ZEN_API_KEY”)并让您选择 Zen 或 Go 目录。设置 URL:opencode.ai/auth。
API 密钥(通用)
为您存储密钥。
Vercel人工智能网关
提示输入“AI_GATEWAY_API_KEY”。更多详细信息:Vercel AI 网关。
Cloudflare AI 网关
提示输入帐户 ID、网关 ID 和“CLOUDFLARE_AI_GATEWAY_API_KEY”。更多详细信息:Cloudflare AI Gateway。
最小最大
配置是自动写入的。托管默认为“MiniMax-M2.7”; API 密钥设置使用“minimax/...”,OAuth 设置使用“minimax-portal/...”。更多详细信息:MiniMax。
步趣
配置是针对中国或全球端点上的 StepFun 标准或 Step Plan 自动编写的。标准目前包括“step-3.5-flash”,Step Plan还包括“step-3.5-flash-2603”。更多详细信息:StepFun。
合成(人类兼容)
提示输入“SYNTHETIC_API_KEY”。更多详细信息:合成。
Ollama(云和本地开放模型)
提示输入基本 URL(默认“http://127.0.0.1:11434”),然后提供云 + 本地或本地模式。发现可用模型并建议默认值。更多详细信息:Ollama。
Moonshot 和 Kimi 编码
Moonshot (Kimi K2) 和 Kimi Coding 配置是自动编写的。更多详细信息:Moonshot AI(Kimi + Kimi 编码)。
定制提供商
可与 OpenAI 兼容和 Anthropic 兼容的端点配合使用。交互式加入支持与其他提供商 API 密钥流程相同的 API 密钥存储选择:
- 立即粘贴 API 密钥(纯文本)
- 使用秘密引用(env ref 或配置的提供程序引用,带有预检验证)
非交互式标志:
--auth-choice 自定义 api-key--自定义基址--自定义模型 ID--custom-api-key(可选;回退到CUSTOM_API_KEY)--custom-provider-id(可选)--custom-compatibility <openai|anthropic>(可选;默认为openai)
跳过
使身份验证保持未配置状态。
模型行为:
- 从检测到的选项中选择默认型号,或手动输入提供商和型号。
- 当从提供商身份验证选择开始加入时,模型选择器会自动选择该提供商。对于 Volcengine 和 BytePlus,相同的首选项也匹配它们的编码计划变体(“volcengine-plan/”、“byteplus-plan/”)。
- 如果首选提供商过滤器为空,选择器将回退到完整目录,而不是不显示任何型号。
- 向导运行模型检查,并在配置的模型未知或缺少身份验证时发出警告。
凭证和配置文件路径:
- 身份验证配置文件(API 密钥 + OAuth):
~/.openclaw/agents/<agentId>/agent/auth-profiles.json - 旧版 OAuth 导入:
~/.openclaw/credentials/oauth.json
凭证存储方式:
-
默认加入行为将 API 密钥保留为身份验证配置文件中的纯文本值。
-
--secret-input-mode ref启用引用模式而不是明文密钥存储。在交互式设置中,您可以选择:- 环境变量 ref (例如
keyRef: { source: "env",provider: "default", id: "OPENAI_API_KEY" }) - 使用提供者别名 + id 配置提供者引用(
file或exec)
- 环境变量 ref (例如
-
交互式参考模式在保存前运行快速预检验证。
- Env 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”;否则入职很快就会失败。
-
网关身份验证凭据支持交互式设置中的明文和 SecretRef 选择:
- 令牌模式:生成/存储明文令牌(默认)或使用 SecretRef。
- 密码模式:明文或SecretRef。
-
非交互式令牌 SecretRef 路径:
--gateway-token-ref-env <ENV_VAR>。 -
现有的明文设置继续保持不变。
无头和服务器提示:使用浏览器在计算机上完成 OAuth,然后将该代理的“auth-profiles.json”(例如“~/.openclaw/agents//agent/auth-profiles.json”或匹配的“$OPENCLAW_STATE_DIR/...”路径)复制到网关主机。 credentials/oauth.json 只是一个遗留的导入源。
输出和内部结构
~/.openclaw/openclaw.json 中的典型字段:
-
agents.defaults.workspace -
agents.defaults.model/models.providers(如果选择 Minimax) -
tools.profile(未设置时,本地入门默认为“编码”;保留现有的显式值) -
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.nodeManagersetup --node-manager标志接受npm、pnpm或bun。- 手动配置稍后仍可以设置
skills.install.nodeManager: "yarn"。
-
向导.lastRunAt -
向导.lastRunVersion -
向导.lastRunCommit -
向导.lastRunCommand -
向导.lastRunMode
openclaw代理添加写入agents.list[]和可选的绑定。WhatsApp凭证位于~/.openclaw/credentials/whatsapp/<accountId>/下。会话存储在“~/.openclaw/agents//sessions/”下。
某些频道作为插件提供。在安装过程中选择时,向导会提示在通道配置之前安装插件(npm 或本地路径)。
网关向导 RPC:
向导.启动向导.下一个向导.取消向导状态
客户端(macOS 应用程序和控制 UI)可以渲染步骤,而无需重新实现入门逻辑。信号设置行为:
- 下载适当的发布资产
- 将其存储在
~/.openclaw/tools/signal-cli/<version>/下 - 在配置中写入
channels.signal.cliPath - JVM 构建需要 Java 21
- 可用时使用本机构建
- Windows 使用 WSL2 并遵循 WSL 内的 Linux signal-cli 流程
相关文档
- 入门中心:入门 (CLI)
- 自动化和脚本:CLI 自动化
- 命令参考:
openclaw onboard
⌘我