CLI 后端

CLI 后端(fallback 运行时)

当 API 提供商宕机、 速率受限或暂时表现不佳时,OpenClaw 可以运行 本地 AI CLI 作为 纯文本 fallback。这是故意保守的:

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

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

初学者友好快速开始

你可以 无需任何配置 使用 Claude Code CLI(OpenClaw 附带内置默认值):

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

Codex CLI 也可以开箱即用:

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

如果你的 gateway 在 launchd/systemd 下运行且 PATH 最小,只需添加 命令路径:

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

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

用作 fallback

将 CLI 后端添加到你的 fallback 列表,以便它仅在主要模型失败时运行:

{
  agents: {
    defaults: {
      model: {
        primary: "anthropic/claude-opus-4-6",
        fallbacks: ["claude-cli/opus-4.6", "claude-cli/opus-4.5"],
      },
      models: {
        "anthropic/claude-opus-4-6": { alias: "Opus" },
        "claude-cli/opus-4.6": {},
        "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-6": "opus",
            "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 参数传递。如果缺少 imageArg,OpenClaw 将 文件路径附加到提示中(路径注入),这对于自动从纯路径加载本地文件的 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 设置为完整路径。
  • 错误的模型名称:使用 modelAliases 映射 provider/model → CLI 模型。
  • 无会话连续性:确保设置了 sessionArgsessionMode 不是 none(Codex CLI 当前无法使用 JSON 输出恢复)。
  • 图像被忽略:设置 imageArg(并验证 CLI 支持文件路径)。