Files
openclaw/docs/zh-CN/gateway/cli-backends.md
Josh Palmer a3ec2d0734 Docs: update zh-CN translations and pipeline
What:
- update zh-CN glossary, TM, and translator prompt
- regenerate zh-CN docs and apply targeted fixes
- add zh-CN AGENTS pipeline guidance

Why:
- address terminology/spacing feedback from #6995

Tests:
- pnpm build && pnpm check && pnpm test
2026-02-03 13:23:00 -08:00

6.8 KiB
Raw Permalink Blame History

read_when, summary, title, x-i18n
read_when summary title x-i18n
你想要一个在 API 提供商失败时的可靠回退
你正在运行 Claude Code CLI 或其他本地 AI CLI 并想要复用它们
你需要一个纯文本、无工具的路径,但仍支持会话和图像
CLI 后端:通过本地 AI CLI 实现纯文本回退 CLI 后端
generated_at model provider source_hash source_path workflow
2026-02-03T07:47:52Z claude-opus-4-5 pi 56a96e83b16a4f6443cbf4a9da7a660c41a5b178af5e13f35352c9d72e1b08dd gateway/cli-backends.md 15

CLI 后端(回退运行时)

当 API 提供商宕机、被限流或暂时异常时OpenClaw 可以运行本地 AI CLI 作为纯文本回退。这是有意保守的设计:

  • 工具被禁用(无工具调用)。
  • 文本输入 → 文本输出(可靠)。
  • 支持会话(因此后续轮次保持连贯)。
  • 如果 CLI 接受图像路径,图像可以传递

这被设计为安全网而非主要路径。当你想要"始终有效"的文本响应而不依赖外部 API 时使用它。

新手友好快速开始

你可以无需任何配置使用 Claude Code CLIOpenClaw 自带内置默认值):

openclaw agent --message "hi" --model claude-cli/opus-4.5

Codex CLI 也可以开箱即用:

openclaw agent --message "hi" --model codex-cli/gpt-5.2-codex

如果你的 Gateway 网关在 launchd/systemd 下运行且 PATH 很精简,只需添加命令路径:

{
  agents: {
    defaults: {
      cliBackends: {
        "claude-cli": {
          command: "/opt/homebrew/bin/claude",
        },
      },
    },
  },
}

就这样。除了 CLI 本身外,不需要密钥,不需要额外的认证配置。

作为回退使用

将 CLI 后端添加到你的回退列表中,这样它只在主要模型失败时运行:

{
  agents: {
    defaults: {
      model: {
        primary: "anthropic/claude-opus-4-5",
        fallbacks: ["claude-cli/opus-4.5"],
      },
      models: {
        "anthropic/claude-opus-4-5": { alias: "Opus" },
        "claude-cli/opus-4.5": {},
      },
    },
  },
}

注意事项:

  • 如果你使用 agents.defaults.models(允许列表),必须包含 claude-cli/...
  • 如果主要提供商失败认证、限流、超时OpenClaw 将接着尝试 CLI 后端。

配置概览

所有 CLI 后端位于:

agents.defaults.cliBackends

每个条目以提供商 ID(例如 claude-climy-cli)为键。提供商 ID 成为你的模型引用的左侧部分:

<provider>/<model>

配置示例

{
  agents: {
    defaults: {
      cliBackends: {
        "claude-cli": {
          command: "/opt/homebrew/bin/claude",
        },
        "my-cli": {
          command: "my-cli",
          args: ["--json"],
          output: "json",
          input: "arg",
          modelArg: "--model",
          modelAliases: {
            "claude-opus-4-5": "opus",
            "claude-sonnet-4-5": "sonnet",
          },
          sessionArg: "--session",
          sessionMode: "existing",
          sessionIdFields: ["session_id", "conversation_id"],
          systemPromptArg: "--system",
          systemPromptWhen: "first",
          imageArg: "--image",
          imageMode: "repeat",
          serialize: true,
        },
      },
    },
  },
}

工作原理

  1. 选择后端基于提供商前缀(claude-cli/...)。
  2. 构建系统提示使用相同的 OpenClaw 提示 + 工作区上下文。
  3. 执行 CLI并带有会话 ID如果支持使历史记录保持一致。
  4. 解析输出JSON 或纯文本)并返回最终文本。
  5. 持久化会话 ID按后端,使后续请求复用相同的 CLI 会话。

会话

  • 如果 CLI 支持会话,设置 sessionArg(例如 --session-id)或 sessionArgs(占位符 {sessionId})当 ID 需要插入到多个标志中时。
  • 如果 CLI 使用带有不同标志的恢复子命令,设置 resumeArgs(恢复时替换 args)以及可选的 resumeOutput(用于非 JSON 恢复)。
  • sessionMode
    • always:始终发送会话 ID如果没有存储则使用新 UUID
    • existing:仅在之前存储了会话 ID 时才发送。
    • none:从不发送会话 ID。

图像(传递)

如果你的 CLI 接受图像路径,设置 imageArg

imageArg: "--image",
imageMode: "repeat"

OpenClaw 会将 base64 图像写入临时文件。如果设置了 imageArg,这些路径作为 CLI 参数传递。如果缺少 imageArgOpenClaw 会将文件路径附加到提示中(路径注入),这对于从纯路径自动加载本地文件的 CLI 来说已经足够Claude Code CLI 行为)。

输入 / 输出

  • output: "json"(默认)尝试解析 JSON 并提取文本 + 会话 ID。
  • output: "jsonl" 解析 JSONL 流Codex CLI --json)并提取最后一条智能体消息以及存在时的 thread_id
  • output: "text" 将 stdout 视为最终响应。

输入模式:

  • input: "arg"(默认)将提示作为最后一个 CLI 参数传递。
  • input: "stdin" 通过 stdin 发送提示。
  • 如果提示很长且设置了 maxPromptArgChars,则使用 stdin。

默认值(内置)

OpenClaw 自带 claude-cli 的默认值:

  • command: "claude"
  • args: ["-p", "--output-format", "json", "--dangerously-skip-permissions"]
  • resumeArgs: ["-p", "--output-format", "json", "--dangerously-skip-permissions", "--resume", "{sessionId}"]
  • modelArg: "--model"
  • systemPromptArg: "--append-system-prompt"
  • sessionArg: "--session-id"
  • systemPromptWhen: "first"
  • sessionMode: "always"

OpenClaw 也自带 codex-cli 的默认值:

  • command: "codex"
  • args: ["exec","--json","--color","never","--sandbox","read-only","--skip-git-repo-check"]
  • resumeArgs: ["exec","resume","{sessionId}","--color","never","--sandbox","read-only","--skip-git-repo-check"]
  • output: "jsonl"
  • resumeOutput: "text"
  • modelArg: "--model"
  • imageArg: "--image"
  • sessionMode: "existing"

仅在需要时覆盖(常见:绝对 command 路径)。

限制

  • 无 OpenClaw 工具CLI 后端永远不会收到工具调用)。某些 CLI 可能仍会运行它们自己的智能体工具。
  • 无流式传输CLI 输出被收集后返回)。
  • 结构化输出取决于 CLI 的 JSON 格式。
  • Codex CLI 会话通过文本输出恢复(无 JSONL这比初始的 --json 运行结构化程度低。OpenClaw 会话仍然正常工作。

故障排除

  • 找不到 CLI:将 command 设置为完整路径。
  • 模型名称错误:使用 modelAliasesprovider/model 映射到 CLI 模型。
  • 无会话连续性:确保设置了 sessionArgsessionMode 不是 noneCodex CLI 目前无法使用 JSON 输出恢复)。
  • 图像被忽略:设置 imageArg(并验证 CLI 支持文件路径)。