CLI 命令

Models

openclaw models

模型发现、扫描和配置(默认模型、回退模型、身份验证配置文件)。

相关内容:

常用命令

bash
openclaw models statusopenclaw models listopenclaw models set <model-or-alias>openclaw models set-image <model-or-alias>openclaw models scan

statusauth 子命令接受 --agent <id>,用于指定已配置的智能体;listscanaliasesfallbacks/image-fallbacks 始终使用已配置的默认智能体,而 set/set-image 会直接拒绝 --agent。如果省略,支持 --agent 的命令会在已设置时使用 OPENCLAW_AGENT_DIR,否则使用已配置的默认智能体。

状态

openclaw models status 显示解析后的默认模型/回退模型以及身份验证概览。当提供商用量快照可用时,OAuth/API key 状态部分会包含提供商用量窗口和配额快照。目前支持用量窗口的提供商:Anthropic、GitHub Copilot、Gemini CLI、OpenAI、MiniMax、Xiaomi 和 z.ai。可用时,用量身份验证来自提供商特定的钩子;否则,OpenClaw 会回退到从身份验证配置文件、环境变量或配置中匹配 OAuth/API key 凭据。

--json 输出中,auth.providers 是感知环境变量/配置/存储的提供商概览,而 auth.oauth 仅表示身份验证存储中的配置文件健康状况。

选项:

标志 效果
--json JSON 输出;身份验证配置文件、提供商和启动诊断会写入 stderr,使 stdout 可继续通过管道传给 jq
--plain 纯文本输出。
--check 如果身份验证即将过期或已过期,则以非零状态退出:1 = 已过期/缺失,2 = 即将过期。
--probe 实时探测已配置的身份验证配置文件。会发出真实请求;可能消耗 token 并触发速率限制。
--probe-provider <name> 仅探测一个提供商。
--probe-profile <id> 探测指定的身份验证配置文件 ID(可重复指定或用逗号分隔)。
--probe-timeout <ms> 每次探测的超时时间。
--probe-concurrency <n> 并发探测数。
--probe-max-tokens <n> 探测的最大 token 数(尽力而为)。
--agent <id> 已配置的智能体 ID;覆盖 OPENCLAW_AGENT_DIR

探测行可来自身份验证配置文件、环境变量凭据或 models.json。探测状态类别:okauthrate_limitbillingtimeoutformatunknownno_model

当探测始终未能进行到模型调用时,可能出现以下探测详情/原因代码:

  • excluded_by_auth_order:存在已存储的配置文件,但显式的 auth.order.<provider> 将其省略,因此探测会报告该排除项,而不是尝试使用它。
  • missing_credentialinvalid_expiresexpiredunresolved_ref:配置文件存在,但不符合使用条件或无法解析。
  • ineligible_profile:由于其他原因,配置文件与提供商配置不兼容。
  • no_model:提供商身份验证存在,但 OpenClaw 无法为该提供商解析出可探测的候选模型。

对于 OpenAI ChatGPT/Codex OAuth 故障排除,openclaw models statusopenclaw models auth list --provider openaiopenclaw config get agents.defaults.model --json 是确认智能体是否具有可供原生 Codex 运行时用于 openai/*openai OAuth 配置文件的最快方式。请参阅 OpenAI provider 设置

列表

openclaw models list 是只读操作:它会读取配置、身份验证配置文件、现有目录状态和提供商拥有的目录行,但绝不会重写 models.json

选项:--all(完整目录)、--local(筛选本地模型)、--provider <id>--json--plain

注意:

  • Auth 列是只读的。对于 OpenAI 等提供商拥有的模型路由,它会将每行的 API/基础 URL 路由与有效 auth.order 中符合条件的配置文件、环境变量/配置凭据以及已解析的命令范围 SecretRef 进行匹配。当具体 OpenAI 行的路由策略不可用时,它会保持未知状态,而不是借用提供商级身份验证;仅提供商级的旧版检查和其他提供商仍保留提供商级行为。插件的合成身份验证元数据只是运行时能力提示,并不能证明原生账户身份验证,因此依赖账户的路由在没有明确注册表证据时仍保持未知状态。该命令不会加载提供商运行时、读取钥匙串机密、调用提供商 API,也不会证明具体的执行就绪状态。
  • 即使你尚未向某个提供商进行身份验证,models list --all --provider <id> 也可以包含来自插件清单或内置提供商目录元数据中由提供商拥有的静态目录行。在配置匹配的身份验证之前,这些行仍会显示为不可用。
  • 当提供商目录发现较慢时,models list 会保持控制平面的响应能力。短暂等待后,默认视图和已配置视图会回退到已配置或合成的模型行,并让发现过程在后台完成。如果你需要精确、完整的已发现目录,并且愿意等待提供商发现,请使用 --all
  • 范围广泛的 models list --all 会将清单目录行合并并覆盖注册表行,而不会加载提供商运行时补充钩子。按提供商筛选的清单快速路径仅使用标记为 static 的提供商;标记为 refreshable 的提供商仍由注册表/缓存提供支持,并将清单行作为补充追加;标记为 runtime 的提供商则继续使用注册表/运行时发现。
  • models list 会区分原生模型元数据和运行时上限。在表格输出中,当有效运行时上限与原生上下文窗口不同时,Ctx 会显示 contextTokens/contextWindow;当提供商公开该上限时,JSON 行会包含 contextTokens
  • 对于提供商拥有的路由,models list 会将一个逻辑提供商/模型行投影到选定路由。InputCtx 仅来自完全匹配的物理路由目录行,最后再应用显式配置的逻辑覆盖;当路由选择无法解析时,能力字段会显示为未知,而不是借用同级路由的元数据。
  • models list --provider <id> 按提供商 ID 筛选,例如 moonshotopenai。它不接受交互式提供商选择器中的显示标签,例如 Moonshot AI
  • 模型引用通过在第一个 / 处分割来解析。如果模型 ID 包含 /(OpenRouter 风格),请包含提供商前缀(示例:openrouter/moonshotai/kimi-k2)。
  • 如果省略提供商,OpenClaw 会先将输入解析为别名,然后查找与该确切模型 ID 唯一匹配的已配置提供商,最后才会回退到已配置的默认提供商并发出弃用警告。如果该提供商不再提供已配置的默认模型,OpenClaw 会回退到第一个已配置的提供商/模型,而不是显示已移除提供商的过时默认值。
  • 对于非机密占位符(例如 OPENAI_API_KEYsecretref-managedminimax-oauthoauth:chutesollama-local),models status 可能会在身份验证输出中显示 marker(<value>),而不是将其当作机密进行遮盖。

设置默认模型/图像模型

bash
openclaw models set <model-or-alias>openclaw models set-image <model-or-alias>

set 写入 agents.defaults.model.primaryset-image 写入 agents.defaults.imageModel.primary。两者都接受 provider/model 或已配置的别名。当新选择的模型需要 Codex/Copilot 运行时插件时,set 还会修复相应插件安装;set-image 不会。两个命令都不接受 --agent;它们始终写入智能体默认值。

扫描

models scan 读取 OpenRouter 的公共 :free 目录,并对候选模型进行排序,以供回退使用。目录本身是公开的,因此仅元数据扫描不需要 OpenRouter key。

默认情况下,OpenClaw 会尝试通过实时模型调用探测工具和图像支持。如果未配置 OpenRouter key,该命令会回退到仅元数据输出,并说明 :free 模型在探测和推理时仍需要 OPENROUTER_API_KEY

选项:

  • --no-probe(仅元数据;不查找配置/机密)
  • --min-params <b>
  • --max-age-days <days>
  • --provider <name>
  • --max-candidates <n>
  • --timeout <ms>(目录请求和每次探测的超时时间)
  • --concurrency <n>
  • --yes
  • --no-input
  • --set-default
  • --set-image
  • --json

--set-default--set-image 需要实时探测;仅元数据的扫描结果仅供参考,不会应用到配置。

别名

bash
openclaw models aliases list [--json] [--plain]openclaw models aliases add <alias> <model-or-alias>openclaw models aliases remove <alias>

别名按模型条目存储为 agents.defaults.models.<key>.aliasadd 会先将 <model-or-alias> 解析为规范的提供商/模型键,因此为别名设置别名会将其重新指向目标,而不会形成别名链。

回退模型

bash
openclaw models fallbacks list [--json] [--plain]openclaw models fallbacks add <model-or-alias>openclaw models fallbacks remove <model-or-alias>openclaw models fallbacks clear

管理 agents.defaults.model.fallbacksopenclaw models image-fallbacks list|add|remove|clear 使用相同的子命令结构管理并行的 agents.defaults.imageModel.fallbacks 列表。

身份验证配置文件

bash
openclaw models auth addopenclaw models auth list [--provider <id>] [--json]openclaw models auth login --provider <id>openclaw models auth login --provider openai --profile-id openai:workopenclaw models auth login-github-copilotopenclaw models auth paste-api-key --provider <id>openclaw models auth setup-token --provider <id>openclaw models auth paste-token --provider <id>openclaw models auth order get --provider <id>openclaw models auth order set --provider <id> <profileIds...>openclaw models auth order clear --provider <id>

models auth add 是交互式身份验证辅助命令。根据你选择的提供商,它可以启动提供商身份验证流程(OAuth/API key),或引导你手动粘贴 token。

models auth list 会列出所选智能体已保存的身份验证配置文件,但不会打印 token、API key 或 OAuth 机密材料。使用 --provider <id> 可筛选到单个提供商(例如 openai),使用 --json 可用于脚本处理。

models auth login 会运行提供商插件的身份验证流程(OAuth/API key)。使用 openclaw plugins list 查看已安装的提供商。对于登录期间支持命名配置文件的提供商,login 接受 --profile-id <id>(可用它将同一提供商的多个登录分开保存);接受 --method <id> 以选择特定的身份验证方法;接受 --device-code 作为 --method device-code 的快捷方式;接受 --set-default 以应用提供商推荐的默认模型;还接受 --force,以先移除该提供商的现有配置文件(当缓存的 OAuth 配置文件卡住,或你想切换账户时使用)。

models auth login-github-copilotmodels auth login --provider github-copilot --method device(GitHub 设备流程)的快捷方式;它接受 --yes,可在不提示的情况下覆盖现有配置文件。

使用 openclaw models auth --agent <id> <subcommand> 将身份验证结果写入特定的已配置 Agent 存储。父级 --agent 标志适用于 addlistloginpaste-api-keysetup-tokenpaste-tokenlogin-github-copilot,以及 order get/set/clear

对于 OpenAI 模型,--provider openai 默认使用 ChatGPT/Codex 账户登录。仅当你想添加 OpenAI API 密钥配置文件时才使用 --method api-key,通常用于在 Codex 订阅达到限制时作为备用方案。运行 openclaw doctor --fix,将旧版 OpenAI Codex 前缀的身份验证/配置文件状态迁移到 openai

示例:

bash
openclaw models auth login --provider openai --set-defaultopenclaw models auth login --provider openai --method api-keyopenclaw models auth paste-api-key --provider openaiopenclaw models auth list --provider openai

注意:

  • paste-api-key 接受在其他位置生成的 API 密钥,提示输入密钥值,并将其写入默认配置文件 ID <provider>:manual,除非你传入 --profile-id。在自动化场景中,通过标准输入传入密钥,例如 printf "%s\n" "$OPENAI_API_KEY" | openclaw models auth paste-api-key --provider openai
  • setup-tokenpaste-token 仍是通用令牌命令,适用于提供令牌身份验证方法的提供商。
  • setup-token 需要交互式 TTY,并运行提供商的令牌身份验证方法(如果该提供商提供 setup-token 方法,则默认使用该方法)。
  • paste-token 要求指定 --provider,默认提示输入令牌值,并将其写入默认配置文件 ID <provider>:manual,除非你传入 --profile-id。在自动化场景中,应通过标准输入传入令牌,而不是将其作为参数传递,以免提供商凭据出现在 shell 历史记录或进程列表中。
  • paste-token --expires-in <duration> 根据相对时长(例如 365d12h)存储令牌的绝对过期时间。
  • 对于 openai,OpenAI API 密钥与 ChatGPT/OAuth 令牌材料具有不同的身份验证结构。对于 sk-... OpenAI API 密钥,请使用 paste-api-key;仅对令牌身份验证材料使用 paste-token
  • Anthropic:setup-token/paste-tokenanthropic 支持的 OpenClaw 身份验证路径,但当主机上可用 Claude CLI(claude -p)时,OpenClaw 更倾向于复用它。
  • auth order get/set/clear 管理单个提供商按 Agent 设置的身份验证配置文件顺序覆盖,存储在 auth-state.json 中(与 auth.order.<provider> 配置键分开)。set 按优先级顺序接受一个或多个配置文件 ID;clear 则回退到配置/轮询顺序。

相关内容

Was this useful?
On this page

On this page