From 06b31eb946531d5e861372f65444417c664ae079 Mon Sep 17 00:00:00 2001 From: "openclaw-docs-i18n[bot]" Date: Thu, 16 Apr 2026 15:44:23 +0000 Subject: [PATCH] chore(i18n): refresh zh-CN translations --- docs/zh-CN/gateway/cli-backends.md | 141 +++++++++++++++-------------- 1 file changed, 71 insertions(+), 70 deletions(-) diff --git a/docs/zh-CN/gateway/cli-backends.md b/docs/zh-CN/gateway/cli-backends.md index 246c4a4fc..c1050ceb7 100644 --- a/docs/zh-CN/gateway/cli-backends.md +++ b/docs/zh-CN/gateway/cli-backends.md @@ -1,41 +1,41 @@ --- read_when: - - 当 API 提供商失败时,你希望有一个可靠的回退方案 + - 当 API 提供商失败时,你需要一个可靠的回退方案 - 你正在运行 Codex CLI 或其他本地 AI CLI,并希望复用它们 - - 你想了解用于 CLI 后端工具访问的 MCP loopback bridge + - 你想了解用于 CLI 后端工具访问的 MCP loopback 桥接机制 summary: CLI 后端:带可选 MCP 工具桥接的本地 AI CLI 回退方案 title: CLI 后端 x-i18n: - generated_at: "2026-04-11T01:19:09Z" + generated_at: "2026-04-16T15:43:38Z" model: gpt-5.4 provider: openai - source_hash: d108dbea043c260a80d15497639298f71a6b4d800f68d7b39bc129f7667ca608 + source_hash: 0fff1d783dc49e97739fd322cd5762f5a5b9f239886b6cf1495b715a511e8c82 source_path: gateway/cli-backends.md workflow: 15 --- # CLI 后端(回退运行时) -当 API 提供商不可用、受到速率限制或暂时行为异常时,OpenClaw 可以运行**本地 AI CLI** 作为**纯文本回退**。这是一种有意保守的设计: +当 API 提供商不可用、触发速率限制或暂时异常时,OpenClaw 可以运行**本地 AI CLI** 作为**仅文本回退方案**。这是一个有意保持保守的设计: -- **OpenClaw 工具不会被直接注入**,但设置了 `bundleMcp: true` 的后端可以通过 loopback MCP bridge 接收 Gateway 网关工具。 -- 支持相关 CLI 的 **JSONL 流式传输**。 -- **支持会话**(因此后续轮次能保持连贯)。 -- 如果 CLI 接受图像路径,**图片可以透传**。 +- **不会直接注入 OpenClaw 工具**,但设置了 `bundleMcp: true` 的后端可以通过 loopback MCP 桥接接收 Gateway 网关工具。 +- 对支持的 CLI 提供 **JSONL 分块流式传输**。 +- **支持会话**(因此后续轮次可以保持连贯)。 +- 如果 CLI 接受图片路径,**图片可以透传**。 -这被设计为一个**安全兜底方案**,而不是主要路径。当你希望在不依赖外部 API 的情况下获得“始终可用”的文本响应时,可以使用它。 +这被设计为一个**安全兜底方案**,而不是主要路径。当你希望获得“不管怎样都能工作”的文本响应,而不依赖外部 API 时,可以使用它。 -如果你想要具备 ACP 会话控制、后台任务、线程/会话绑定以及持久化外部编码会话的完整 harness 运行时,请改用 [ACP Agents](/zh-CN/tools/acp-agents)。CLI 后端不是 ACP。 +如果你需要具备 ACP 会话控制、后台任务、线程/会话绑定以及持久化外部编码会话的完整 harness 运行时,请改用 [ACP Agents](/zh-CN/tools/acp-agents)。CLI 后端不是 ACP。 -## 适合初学者的快速开始 +## 面向初学者的快速开始 -你可以**无需任何配置**使用 Codex CLI(内置的 OpenAI 插件会注册一个默认后端): +你可以**无需任何配置**就使用 Codex CLI(内置的 OpenAI 插件会注册一个默认后端): ```bash openclaw agent --message "hi" --model codex-cli/gpt-5.4 ``` -如果你的 Gateway 网关运行在 launchd/systemd 下,且 `PATH` 很精简,只需添加命令路径: +如果你的 Gateway 网关运行在 `launchd`/`systemd` 下且 `PATH` 很精简,只需添加命令路径: ```json5 { @@ -51,13 +51,13 @@ openclaw agent --message "hi" --model codex-cli/gpt-5.4 } ``` -就这些。除了 CLI 自身之外,不需要密钥,也不需要额外的认证配置。 +就是这样。除了 CLI 本身之外,不需要密钥,也不需要额外的认证配置。 -如果你在 Gateway 网关主机上将某个内置 CLI 后端用作**主要消息提供商**,当你的配置在模型引用中或在 `agents.defaults.cliBackends` 下显式引用该后端时,OpenClaw 现在会自动加载其所属的内置插件。 +如果你在 Gateway 网关主机上将内置 CLI 后端用作**主要消息提供商**,现在当你的配置在模型引用或 `agents.defaults.cliBackends` 下显式引用该后端时,OpenClaw 会自动加载其所属的内置插件。 -## 将其用作回退方案 +## 将它用作回退方案 -将一个 CLI 后端加入你的回退列表,这样它只会在主模型失败时运行: +将 CLI 后端添加到你的回退列表中,这样它只会在主要模型失败时运行: ```json5 { @@ -78,8 +78,8 @@ openclaw agent --message "hi" --model codex-cli/gpt-5.4 说明: -- 如果你使用 `agents.defaults.models`(允许列表),你也必须在其中包含你的 CLI 后端模型。 -- 如果主提供商失败(认证、速率限制、超时),OpenClaw 将接着尝试 CLI 后端。 +- 如果你使用 `agents.defaults.models`(允许列表),你也必须在其中包含 CLI 后端模型。 +- 如果主要提供商失败(认证、速率限制、超时),OpenClaw 将接着尝试 CLI 后端。 ## 配置概览 @@ -120,7 +120,7 @@ agents.defaults.cliBackends sessionMode: "existing", sessionIdFields: ["session_id", "conversation_id"], systemPromptArg: "--system", - // 对于 Codex 风格的 CLI,也可以改为指向一个 prompt 文件: + // 类似 Codex 的 CLI 也可以改为指向一个提示词文件: // systemPromptFileConfigArg: "-c", // systemPromptFileConfigKey: "model_instructions_file", systemPromptWhen: "first", @@ -136,77 +136,78 @@ agents.defaults.cliBackends ## 工作原理 -1. 根据提供商前缀(`codex-cli/...`)**选择后端**。 -2. 使用相同的 OpenClaw prompt 和工作区上下文**构建系统 prompt**。 -3. 如果支持,会使用会话 id **执行 CLI**,以保持历史一致。 +1. 根据提供商前缀(`codex-cli/...`)**选择一个后端**。 +2. 使用相同的 OpenClaw 提示词和工作区上下文**构建系统提示词**。 +3. 使用会话 id(如果支持)**执行 CLI**,以保持历史一致。 4. **解析输出**(JSON 或纯文本)并返回最终文本。 5. 按后端**持久化会话 id**,以便后续轮次复用同一个 CLI 会话。 -内置的 Anthropic `claude-cli` 后端现已再次受支持。Anthropic 员工告诉我们,允许使用 OpenClaw 风格的 Claude CLI,因此除非 Anthropic 发布新政策,否则 OpenClaw 会将这种 `claude -p` 用法视为该集成的许可方式。 +内置的 Anthropic `claude-cli` 后端现已再次受支持。Anthropic 工作人员告诉我们,再次允许 OpenClaw 风格的 Claude CLI 用法,因此除非 Anthropic 发布新政策,否则 OpenClaw 会将此集成中的 `claude -p` 用法视为已获认可。 -内置的 OpenAI `codex-cli` 后端会通过 Codex 的 `model_instructions_file` 配置覆盖(`-c -model_instructions_file="..."`)传递 OpenClaw 的系统 prompt。Codex 没有提供类似 Claude 的 `--append-system-prompt` 标志,因此 OpenClaw 会为每个新的 Codex CLI 会话把组装后的 prompt 写入一个临时文件。 +内置的 OpenAI `codex-cli` 后端会通过 Codex 的 `model_instructions_file` 配置覆盖项(`-c +model_instructions_file="..."`)传入 OpenClaw 的系统提示词。Codex 没有提供类似 Claude 的 +`--append-system-prompt` 标志,因此对于每个新的 Codex CLI 会话,OpenClaw 都会将组装后的提示词写入临时文件。 -内置的 Anthropic `claude-cli` 后端会通过两种方式接收 OpenClaw 的 Skills 快照:一是附加系统 prompt 中的精简 OpenClaw Skills 目录,二是通过 `--plugin-dir` 传入的临时 Claude Code 插件。该插件仅包含对当前智能体/会话符合条件的 Skills,因此 Claude Code 的原生 skill 解析器看到的过滤结果,与 OpenClaw 原本会在 prompt 中通告的结果一致。对于运行过程,Skill 的环境变量/API 密钥覆盖仍然由 OpenClaw 应用到子进程环境中。 +内置的 Anthropic `claude-cli` 后端会通过两种方式接收 OpenClaw Skills 快照:一种是在附加系统提示词中的紧凑 OpenClaw Skills 目录,另一种是通过 `--plugin-dir` 传入的临时 Claude Code 插件。该插件只包含对当前智能体/会话符合条件的 Skills,因此 Claude Code 原生的技能解析器会看到与 OpenClaw 原本会在提示词中公布的同一组经过筛选的 Skills。Skills 的环境变量/API key 覆盖仍由 OpenClaw 应用到本次运行的子进程环境中。 ## 会话 - 如果 CLI 支持会话,请设置 `sessionArg`(例如 `--session-id`)或 - `sessionArgs`(占位符 `{sessionId}`),以便在需要将 ID 插入多个标志时使用。 + `sessionArgs`(占位符为 `{sessionId}`),用于需要将 ID 插入多个标志的情况。 - 如果 CLI 使用带有不同标志的**恢复子命令**,请设置 - `resumeArgs`(恢复时替换 `args`),并可选设置 `resumeOutput` + `resumeArgs`(恢复时替代 `args`),并可选设置 `resumeOutput` (用于非 JSON 恢复)。 - `sessionMode`: - - `always`:始终发送会话 id(如果尚未存储,则生成新的 UUID)。 + - `always`:始终发送会话 id(如果未存储则生成一个新的 UUID)。 - `existing`:仅当之前已存储会话 id 时才发送。 - `none`:从不发送会话 id。 序列化说明: -- `serialize: true` 会让同一通道的运行保持顺序。 -- 大多数 CLI 会在一个提供商通道上串行执行。 -- 当后端认证状态发生变化时,包括重新登录、令牌轮换或认证配置文件凭证变更,OpenClaw 会丢弃已存储的 CLI 会话复用状态。 +- `serialize: true` 会保持同一通道运行按顺序执行。 +- 大多数 CLI 会在单个提供商通道上串行执行。 +- 当后端认证状态发生变化时,包括重新登录、令牌轮换或认证配置中的凭证变更,OpenClaw 会丢弃已存储的 CLI 会话复用。 ## 图片(透传) -如果你的 CLI 接受图像路径,请设置 `imageArg`: +如果你的 CLI 接受图片路径,请设置 `imageArg`: ```json5 imageArg: "--image", imageMode: "repeat" ``` -OpenClaw 会将 base64 图片写入临时文件。如果设置了 `imageArg`,这些路径会作为 CLI 参数传递。如果缺少 `imageArg`,OpenClaw 会将文件路径附加到 prompt 中(路径注入),这对于那些能从普通路径自动加载本地文件的 CLI 已经足够。 +OpenClaw 会将 base64 图片写入临时文件。如果设置了 `imageArg`,这些路径会作为 CLI 参数传入。如果缺少 `imageArg`,OpenClaw 会将文件路径附加到提示词中(路径注入),这对于那些能从普通路径自动加载本地文件的 CLI 已经足够。 ## 输入 / 输出 - `output: "json"`(默认)会尝试解析 JSON,并提取文本 + 会话 id。 - 对于 Gemini CLI 的 JSON 输出,当 `usage` 缺失或为空时,OpenClaw 会从 `response` 读取回复文本,并从 `stats` 读取用量。 -- `output: "jsonl"` 会解析 JSONL 流(例如 Codex CLI `--json`),并在存在时提取最终智能体消息和会话标识符。 +- `output: "jsonl"` 会解析 JSONL 流(例如 Codex CLI `--json`),并在存在时提取最终智能体消息以及会话标识符。 - `output: "text"` 会将 stdout 视为最终响应。 输入模式: -- `input: "arg"`(默认)将 prompt 作为最后一个 CLI 参数传递。 -- `input: "stdin"` 通过 stdin 发送 prompt。 -- 如果 prompt 很长且设置了 `maxPromptArgChars`,则会改用 stdin。 +- `input: "arg"`(默认)将提示词作为最后一个 CLI 参数传递。 +- `input: "stdin"` 通过 stdin 发送提示词。 +- 如果提示词很长且设置了 `maxPromptArgChars`,则会使用 stdin。 -## 默认值(插件自有) +## 默认值(插件拥有) -内置的 OpenAI 插件还为 `codex-cli` 注册了默认值: +内置 OpenAI 插件还为 `codex-cli` 注册了一个默认值: - `command: "codex"` - `args: ["exec","--json","--color","never","--sandbox","workspace-write","--skip-git-repo-check"]` -- `resumeArgs: ["exec","resume","{sessionId}","--color","never","--sandbox","workspace-write","--skip-git-repo-check"]` +- `resumeArgs: ["exec","resume","{sessionId}","--skip-git-repo-check"]` - `output: "jsonl"` - `resumeOutput: "text"` - `modelArg: "--model"` - `imageArg: "--image"` - `sessionMode: "existing"` -内置的 Google 插件也为 `google-gemini-cli` 注册了默认值: +内置 Google 插件也为 `google-gemini-cli` 注册了一个默认值: - `command: "gemini"` - `args: ["--output-format", "json", "--prompt", "{prompt}"]` @@ -217,8 +218,8 @@ OpenClaw 会将 base64 图片写入临时文件。如果设置了 `imageArg`, - `sessionMode: "existing"` - `sessionIdFields: ["session_id", "sessionId"]` -前提条件:本地 Gemini CLI 必须已安装,并且可在 -`PATH` 中作为 `gemini` 使用(`brew install gemini-cli` 或 +前提条件:本地 Gemini CLI 必须已安装,并可通过 `PATH` 中的 +`gemini` 使用(`brew install gemini-cli` 或 `npm install -g @google/gemini-cli`)。 Gemini CLI JSON 说明: @@ -231,17 +232,17 @@ Gemini CLI JSON 说明: 仅在需要时覆盖(常见情况:使用绝对 `command` 路径)。 -## 插件自有默认值 +## 插件拥有的默认值 CLI 后端默认值现在是插件表面的一部分: -- 插件使用 `api.registerCliBackend(...)` 注册它们。 -- 后端的 `id` 会成为模型引用中的提供商前缀。 +- 插件通过 `api.registerCliBackend(...)` 注册它们。 +- 后端 `id` 会成为模型引用中的提供商前缀。 - `agents.defaults.cliBackends.` 中的用户配置仍会覆盖插件默认值。 -- 特定后端的配置清理仍由插件通过可选的 - `normalizeConfig` hook 自行处理。 +- 后端特定的配置清理仍通过可选的 + `normalizeConfig` hook 由插件负责。 -需要进行轻量 prompt/消息兼容性调整的插件,可以声明双向文本转换,而无需替换提供商或 CLI 后端: +需要细小提示词/消息兼容性调整的插件,可以声明双向文本转换,而无需替换提供商或 CLI 后端: ```typescript api.registerTextTransforms({ @@ -258,45 +259,45 @@ api.registerTextTransforms({ }); ``` -`input` 会重写传递给 CLI 的系统 prompt 和用户 prompt。`output` -会在 OpenClaw 处理其自身控制标记和渠道投递之前,重写流式传输的 assistant 增量内容以及解析后的最终文本。 +`input` 会重写传递给 CLI 的系统提示词和用户提示词。`output` +会在 OpenClaw 处理其自身控制标记和渠道投递之前,重写流式传输的助手增量内容以及解析后的最终文本。 对于输出与 Claude Code stream-json 兼容的 JSONL 的 CLI,请在该后端配置上设置 `jsonlDialect: "claude-stream-json"`。 -## bundle MCP 覆盖层 +## Bundle MCP 覆盖层 CLI 后端**不会**直接接收 OpenClaw 工具调用,但后端可以通过设置 `bundleMcp: true` 选择接收生成的 MCP 配置覆盖层。 当前内置行为: -- `claude-cli`:生成的严格 MCP 配置文件 -- `codex-cli`:针对 `mcp_servers` 的内联配置覆盖 -- `google-gemini-cli`:生成的 Gemini 系统设置文件 +- `claude-cli`:生成严格的 MCP 配置文件 +- `codex-cli`:为 `mcp_servers` 提供内联配置覆盖 +- `google-gemini-cli`:生成 Gemini 系统设置文件 启用 bundle MCP 后,OpenClaw 会: -- 启动一个 loopback HTTP MCP 服务器,将 Gateway 网关工具暴露给 CLI 进程 -- 使用每个会话独有的令牌(`OPENCLAW_MCP_TOKEN`)对 bridge 进行认证 -- 将工具访问范围限定为当前会话、账户和渠道上下文 -- 为当前工作区加载已启用的 bundle-MCP 服务器 +- 启动一个 loopback HTTP MCP 服务器,向 CLI 进程暴露 Gateway 网关工具 +- 使用每会话令牌(`OPENCLAW_MCP_TOKEN`)对桥接进行认证 +- 将工具访问范围限制在当前会话、账户和渠道上下文内 +- 加载当前工作区中已启用的 bundle-MCP 服务器 - 将它们与任何现有的后端 MCP 配置/设置结构合并 -- 使用所属扩展中由后端自行定义的集成模式重写启动配置 +- 使用所属扩展中由后端拥有的集成模式重写启动配置 -即使没有启用任何 MCP 服务器,只要后端选择启用 bundle MCP,OpenClaw 仍会注入严格配置,以确保后台运行保持隔离。 +如果没有启用任何 MCP 服务器,当后端选择启用 bundle MCP 时,OpenClaw 仍会注入严格配置,以保持后台运行隔离。 ## 限制 -- **没有直接的 OpenClaw 工具调用。** OpenClaw 不会将工具调用注入到 - CLI 后端协议中。后端只有在选择 `bundleMcp: true` 时,才能看到 Gateway 网关工具。 -- **流式传输是后端特定的。** 有些后端会流式输出 JSONL;另一些则会一直缓冲到退出。 +- **没有直接的 OpenClaw 工具调用。** OpenClaw 不会将工具调用注入 + CLI 后端协议。后端只有在选择 `bundleMcp: true` 时才能看到 Gateway 网关工具。 +- **流式传输取决于后端。** 某些后端会流式输出 JSONL;其他后端则会缓冲到退出时。 - **结构化输出** 取决于 CLI 的 JSON 格式。 -- **Codex CLI 会话** 通过文本输出恢复(不是 JSONL),其结构化程度低于初始的 `--json` 运行。不过 OpenClaw 会话仍能正常工作。 +- **Codex CLI 会话** 通过文本输出恢复(没有 JSONL),其结构化程度低于初始 `--json` 运行。不过 OpenClaw 会话仍可正常工作。 ## 故障排除 - **找不到 CLI**:将 `command` 设置为完整路径。 - **模型名称错误**:使用 `modelAliases` 将 `provider/model` 映射为 CLI 模型。 -- **没有会话连续性**:确保已设置 `sessionArg`,并且 `sessionMode` 不是 - `none`(Codex CLI 目前无法以 JSON 输出恢复)。 +- **没有会话连续性**:确保已设置 `sessionArg`,且 `sessionMode` 不是 + `none`(Codex CLI 当前无法通过 JSON 输出恢复)。 - **图片被忽略**:设置 `imageArg`(并确认 CLI 支持文件路径)。