chore(i18n): refresh zh-CN translations
This commit is contained in:
parent
f90a187462
commit
f8fbe5dd14
@ -1,141 +1,141 @@
|
||||
---
|
||||
read_when:
|
||||
- 通过 ACP 运行编码 harness
|
||||
- 在消息渠道上设置与会话绑定的 ACP 会话
|
||||
- 在消息渠道上设置绑定到会话的 ACP 会话
|
||||
- 将消息渠道会话绑定到持久化 ACP 会话
|
||||
- 排查 ACP 后端和插件连线问题
|
||||
- 排查 ACP 后端和插件接线问题
|
||||
- 从聊天中操作 `/acp` 命令
|
||||
summary: 使用 ACP 运行时会话来运行 Codex、Claude Code、Cursor、Gemini CLI、OpenClaw ACP 以及其他 harness 智能体
|
||||
summary: 对 Codex、Claude Code、Cursor、Gemini CLI、OpenClaw ACP 和其他 harness 智能体使用 ACP 运行时会话
|
||||
title: ACP 智能体
|
||||
x-i18n:
|
||||
generated_at: "2026-04-08T01:40:00Z"
|
||||
generated_at: "2026-04-21T07:48:56Z"
|
||||
model: gpt-5.4
|
||||
provider: openai
|
||||
source_hash: 71c7c0cdae5247aefef17a0029360950a1c2987ddcee21a1bb7d78c67da52950
|
||||
source_hash: e458ff21d63e52ed0eed4ed65ba2c45aecae20563a3ef10bf4b64e948284b51a
|
||||
source_path: tools/acp-agents.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
# ACP 智能体
|
||||
|
||||
[Agent Client Protocol (ACP)](https://agentclientprotocol.com/) 会话让 OpenClaw 能通过 ACP 后端插件运行外部编码 harness(例如 Pi、Claude Code、Codex、Cursor、Copilot、OpenClaw ACP、OpenCode、Gemini CLI,以及其他受支持的 ACPX harness)。
|
||||
[Agent Client Protocol(ACP)](https://agentclientprotocol.com/) 会话让 OpenClaw 能够通过 ACP 后端插件运行外部编码 harness(例如 Pi、Claude Code、Codex、Cursor、Copilot、OpenClaw ACP、OpenCode、Gemini CLI,以及其他受支持的 ACPX harness)。
|
||||
|
||||
如果你用自然语言要求 OpenClaw “在 Codex 中运行这个”或“在线程中启动 Claude Code”,OpenClaw 应该将该请求路由到 ACP 运行时(而不是原生子智能体运行时)。每次 ACP 会话启动都会被记录为一个[后台任务](/zh-CN/automation/tasks)。
|
||||
如果你用自然语言要求 OpenClaw “在 Codex 里运行这个”或“在线程里启动 Claude Code”,OpenClaw 应该将该请求路由到 ACP 运行时(而不是原生子智能体运行时)。每个 ACP 会话的启动都会被跟踪为一个[后台任务](/zh-CN/automation/tasks)。
|
||||
|
||||
如果你希望 Codex 或 Claude Code 作为外部 MCP 客户端直接连接到现有的 OpenClaw 渠道会话,
|
||||
请使用 [`openclaw mcp serve`](/cli/mcp)
|
||||
如果你想让 Codex 或 Claude Code 作为外部 MCP 客户端直接连接
|
||||
到现有的 OpenClaw 渠道会话,请使用 [`openclaw mcp serve`](/cli/mcp)
|
||||
而不是 ACP。
|
||||
|
||||
## 我需要哪个页面?
|
||||
|
||||
这里有三个相邻但很容易混淆的功能面:
|
||||
这里有三个相近但很容易混淆的入口:
|
||||
|
||||
| 你想要…… | 使用这个 | 说明 |
|
||||
| ---------------------------------------------------------------------------------- | ------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| 通过 OpenClaw 运行 Codex、Claude Code、Gemini CLI 或其他外部 harness | 本页:ACP 智能体 | 与聊天绑定的会话、`/acp spawn`、`sessions_spawn({ runtime: "acp" })`、后台任务、运行时控制 |
|
||||
| 将 OpenClaw Gateway 网关 会话作为 ACP 服务器暴露给编辑器或客户端 | [`openclaw acp`](/cli/acp) | 桥接模式。IDE/客户端 通过 stdio/WebSocket 使用 ACP 与 OpenClaw 通信 |
|
||||
| 复用本地 AI CLI 作为纯文本回退模型 | [CLI 后端](/zh-CN/gateway/cli-backends) | 不是 ACP。没有 OpenClaw 工具、没有 ACP 控制、没有 harness 运行时 |
|
||||
| 通过 OpenClaw 运行 Codex、Claude Code、Gemini CLI 或其他外部 harness | 本页:ACP 智能体 | 绑定聊天的会话、`/acp spawn`、`sessions_spawn({ runtime: "acp" })`、后台任务、运行时控制 |
|
||||
| 将一个 OpenClaw Gateway 网关会话作为 ACP 服务器暴露给编辑器或客户端 | [`openclaw acp`](/cli/acp) | 桥接模式。IDE/客户端 通过 stdio/WebSocket 向 OpenClaw 发送 ACP |
|
||||
| 将本地 AI CLI 复用为纯文本回退模型 | [CLI Backends](/zh-CN/gateway/cli-backends) | 不是 ACP。没有 OpenClaw 工具、没有 ACP 控制、没有 harness 运行时 |
|
||||
|
||||
## 这是开箱即用的吗?
|
||||
## 开箱即用吗?
|
||||
|
||||
通常是的。
|
||||
通常可以。
|
||||
|
||||
- 全新安装现在默认启用内置的 `acpx` 运行时插件。
|
||||
- 内置的 `acpx` 插件会优先使用其插件本地固定版本的 `acpx` 二进制文件。
|
||||
- 启动时,OpenClaw 会探测该二进制文件,并在需要时自动修复。
|
||||
- 如果你想快速检查就绪状态,请从 `/acp doctor` 开始。
|
||||
- 启动时,OpenClaw 会探测该二进制文件,并在需要时自行修复。
|
||||
- 如果你想快速检查就绪状态,请先运行 `/acp doctor`。
|
||||
|
||||
首次使用时仍然可能发生的情况:
|
||||
|
||||
- 第一次使用某个目标 harness 时,可能会通过 `npx` 按需获取对应的适配器。
|
||||
- 该 harness 的厂商认证信息仍然必须存在于主机上。
|
||||
- 如果主机没有 npm/网络访问能力,则首次运行的适配器获取可能会失败,直到缓存预热完成或适配器通过其他方式安装。
|
||||
- 某个目标 harness 适配器可能会在你首次使用该 harness 时通过 `npx` 按需获取。
|
||||
- 该 harness 对应厂商的认证信息仍然必须已存在于宿主机上。
|
||||
- 如果宿主机没有 npm/网络访问能力,那么首次运行时的适配器获取可能会失败,直到缓存被预热或适配器通过其他方式安装完成。
|
||||
|
||||
示例:
|
||||
|
||||
- `/acp spawn codex`:OpenClaw 应该已经准备好引导 `acpx`,但 Codex ACP 适配器仍可能需要首次运行时获取。
|
||||
- `/acp spawn claude`:Claude ACP 适配器也是同样情况,另外该主机上还需要 Claude 侧的认证。
|
||||
- `/acp spawn codex`:OpenClaw 应该已经可以引导启动 `acpx`,但 Codex ACP 适配器仍可能需要首次运行时获取。
|
||||
- `/acp spawn claude`:Claude ACP 适配器也是同样情况,另外该宿主机上还必须有 Claude 侧认证。
|
||||
|
||||
## 面向操作员的快速流程
|
||||
## 面向操作人员的快速流程
|
||||
|
||||
当你需要一个实用的 `/acp` 操作手册时,请使用这个流程:
|
||||
如果你想要一份实用的 `/acp` 操作手册,请使用这个流程:
|
||||
|
||||
1. 启动一个会话:
|
||||
- `/acp spawn codex --bind here`
|
||||
- `/acp spawn codex --mode persistent --thread auto`
|
||||
2. 在已绑定的会话或线程中工作(或显式指定该会话键)。
|
||||
2. 在已绑定的会话或线程中工作(或者显式指定该会话键)。
|
||||
3. 检查运行时状态:
|
||||
- `/acp status`
|
||||
4. 按需调整运行时选项:
|
||||
4. 根据需要调整运行时选项:
|
||||
- `/acp model <provider/model>`
|
||||
- `/acp permissions <profile>`
|
||||
- `/acp timeout <seconds>`
|
||||
5. 在不替换上下文的情况下微调活跃会话:
|
||||
5. 推动一个活动会话继续运行,而不替换上下文:
|
||||
- `/acp steer tighten logging and continue`
|
||||
6. 停止工作:
|
||||
- `/acp cancel`(停止当前轮次),或
|
||||
- `/acp cancel`(停止当前轮次),或者
|
||||
- `/acp close`(关闭会话并移除绑定)
|
||||
|
||||
## 面向人工用户的快速开始
|
||||
## 面向人工操作的快速开始
|
||||
|
||||
自然语言请求示例:
|
||||
|
||||
- “把这个 Discord 渠道绑定到 Codex。”
|
||||
- “在这里的线程中启动一个持久化的 Codex 会话,并让它保持聚焦。”
|
||||
- “在这里的线程里启动一个持久的 Codex 会话,并让它保持专注。”
|
||||
- “把这个作为一次性 Claude Code ACP 会话运行,并总结结果。”
|
||||
- “把这个 iMessage 聊天绑定到 Codex,并让后续消息保持在同一个工作区中。”
|
||||
- “针对这个任务使用 Gemini CLI 并放在线程中,然后让后续消息继续在同一个线程里。”
|
||||
- “把这个 iMessage 聊天绑定到 Codex,并让后续消息继续使用同一个工作区。”
|
||||
- “这个任务使用 Gemini CLI 在线程里处理,然后让后续消息继续留在同一个线程里。”
|
||||
|
||||
OpenClaw 应该执行的操作:
|
||||
|
||||
1. 选择 `runtime: "acp"`。
|
||||
2. 解析请求的 harness 目标(`agentId`,例如 `codex`)。
|
||||
3. 如果请求绑定当前会话,并且当前渠道支持该功能,则将 ACP 会话绑定到该会话。
|
||||
4. 否则,如果请求线程绑定,并且当前渠道支持该功能,则将 ACP 会话绑定到该线程。
|
||||
5. 将后续绑定消息路由到同一个 ACP 会话,直到失焦、关闭或过期为止。
|
||||
3. 如果请求了当前会话绑定,并且当前渠道支持,则将 ACP 会话绑定到该会话。
|
||||
4. 否则,如果请求了线程绑定,并且当前渠道支持,则将 ACP 会话绑定到该线程。
|
||||
5. 将后续的已绑定消息路由到同一个 ACP 会话,直到失焦、关闭或过期。
|
||||
|
||||
## ACP 与子智能体的区别
|
||||
## ACP 与子智能体
|
||||
|
||||
如果你想要外部 harness 运行时,请使用 ACP。如果你想要 OpenClaw 原生委派运行,请使用子智能体。
|
||||
当你想使用外部 harness 运行时时,请使用 ACP。当你想使用 OpenClaw 原生委派运行时,请使用子智能体。
|
||||
|
||||
| 区域 | ACP 会话 | 子智能体运行 |
|
||||
| ------------- | ------------------------------------- | ---------------------------------- |
|
||||
| 运行时 | ACP 后端插件(例如 acpx) | OpenClaw 原生子智能体运行时 |
|
||||
| 会话键 | `agent:<agentId>:acp:<uuid>` | `agent:<agentId>:subagent:<uuid>` |
|
||||
| 主要命令 | `/acp ...` | `/subagents ...` |
|
||||
| 启动工具 | `sessions_spawn` 配合 `runtime:"acp"` | `sessions_spawn`(默认运行时) |
|
||||
| 启动工具 | `sessions_spawn`,使用 `runtime:"acp"` | `sessions_spawn`(默认运行时) |
|
||||
|
||||
另见 [Sub-agents](/zh-CN/tools/subagents)。
|
||||
另请参阅 [Sub-agents](/zh-CN/tools/subagents)。
|
||||
|
||||
## ACP 如何运行 Claude Code
|
||||
|
||||
对于通过 ACP 运行的 Claude Code,栈结构如下:
|
||||
通过 ACP 运行 Claude Code 时,堆栈如下:
|
||||
|
||||
1. OpenClaw ACP 会话控制平面
|
||||
2. 内置的 `acpx` 运行时插件
|
||||
3. Claude ACP 适配器
|
||||
4. Claude 侧运行时/会话机制
|
||||
|
||||
重要区别:
|
||||
一个重要区别:
|
||||
|
||||
- ACP Claude 是一种 harness 会话,具备 ACP 控制、会话恢复、后台任务跟踪,以及可选的会话/线程绑定能力。
|
||||
- CLI 后端是独立的、仅文本的本地回退运行时。参见 [CLI 后端](/zh-CN/gateway/cli-backends)。
|
||||
- ACP Claude 是一种 harness 会话,具有 ACP 控制、会话恢复、后台任务跟踪,以及可选的会话/线程绑定。
|
||||
- CLI backends 是独立的纯文本本地回退运行时。参见 [CLI Backends](/zh-CN/gateway/cli-backends)。
|
||||
|
||||
对于操作员,实用规则是:
|
||||
对于操作人员,实用规则是:
|
||||
|
||||
- 想要 `/acp spawn`、可绑定会话、运行时控制或持久化 harness 工作:使用 ACP
|
||||
- 想要通过原始 CLI 实现简单的本地文本回退:使用 CLI 后端
|
||||
- 想要 `/acp spawn`、可绑定会话、运行时控制或持久 harness 工作:使用 ACP
|
||||
- 想要通过原始 CLI 获得简单的本地文本回退:使用 CLI backends
|
||||
|
||||
## 已绑定会话
|
||||
|
||||
### 当前会话绑定
|
||||
|
||||
当你希望当前会话成为一个持久的 ACP 工作区,而不创建子线程时,请使用 `/acp spawn <harness> --bind here`。
|
||||
当你想让当前会话成为一个持久的 ACP 工作区,而不创建子线程时,请使用 `/acp spawn <harness> --bind here`。
|
||||
|
||||
行为:
|
||||
行为如下:
|
||||
|
||||
- OpenClaw 继续负责渠道传输、认证、安全和消息投递。
|
||||
- 当前会话会固定绑定到所启动的 ACP 会话键。
|
||||
- OpenClaw 继续拥有渠道传输、认证、安全和消息投递控制。
|
||||
- 当前会话会被固定到新启动的 ACP 会话键。
|
||||
- 该会话中的后续消息会路由到同一个 ACP 会话。
|
||||
- `/new` 和 `/reset` 会就地重置同一个已绑定的 ACP 会话。
|
||||
- `/acp close` 会关闭该会话并移除当前会话绑定。
|
||||
@ -143,39 +143,39 @@ OpenClaw 应该执行的操作:
|
||||
这在实践中的含义:
|
||||
|
||||
- `--bind here` 会保留同一个聊天界面。在 Discord 上,当前渠道仍然是当前渠道。
|
||||
- 如果你是在启动新的工作,`--bind here` 仍然可以创建一个新的 ACP 会话。该绑定会将这个会话附加到当前会话。
|
||||
- `--bind here` 本身不会创建 Discord 子线程或 Telegram 主题。
|
||||
- ACP 运行时仍然可以有自己的工作目录(`cwd`)或由后端管理的磁盘工作区。该运行时工作区与聊天界面是分离的,并不意味着会新建消息线程。
|
||||
- 如果你启动到另一个 ACP 智能体且没有传入 `--cwd`,OpenClaw 默认会继承**目标智能体的**工作区,而不是请求者的。
|
||||
- 当你启动新的工作时,`--bind here` 仍然可以创建一个新的 ACP 会话。绑定会把该会话附加到当前会话。
|
||||
- `--bind here` 本身不会创建 Discord 子线程或 Telegram topic。
|
||||
- ACP 运行时仍然可以有它自己的工作目录(`cwd`)或由后端管理的磁盘工作区。这个运行时工作区与聊天界面是分开的,不代表会创建新的消息线程。
|
||||
- 如果你启动到另一个 ACP 智能体,并且没有传递 `--cwd`,OpenClaw 默认会继承**目标智能体的**工作区,而不是请求方的工作区。
|
||||
- 如果继承的工作区路径不存在(`ENOENT`/`ENOTDIR`),OpenClaw 会回退到后端默认的 cwd,而不是静默复用错误的目录树。
|
||||
- 如果继承的工作区存在但无法访问(例如 `EACCES`),启动会返回真实的访问错误,而不是丢弃 `cwd`。
|
||||
- 如果继承的工作区存在但无法访问(例如 `EACCES`),启动操作会返回真实的访问错误,而不是丢弃 `cwd`。
|
||||
|
||||
心智模型:
|
||||
思维模型:
|
||||
|
||||
- 聊天界面:人们持续交流的地方(`Discord 渠道`、`Telegram 主题`、`iMessage 聊天`)
|
||||
- ACP 会话:OpenClaw 路由到的、持久化的 Codex/Claude/Gemini 运行时状态
|
||||
- 子线程/主题:仅由 `--thread ...` 创建的可选额外消息界面
|
||||
- 运行时工作区:harness 运行所在的文件系统位置(`cwd`、仓库检出目录、后端工作区)
|
||||
- 聊天界面:人们持续交流的地方(`Discord channel`、`Telegram topic`、`iMessage chat`)
|
||||
- ACP 会话:OpenClaw 路由到的持久 Codex/Claude/Gemini 运行时状态
|
||||
- 子线程/topic:仅在使用 `--thread ...` 时才会创建的可选额外消息界面
|
||||
- 运行时工作区:harness 运行所在的文件系统位置(`cwd`、代码仓库检出目录、后端工作区)
|
||||
|
||||
示例:
|
||||
|
||||
- `/acp spawn codex --bind here`:保留当前聊天,启动或附加一个 Codex ACP 会话,并将未来消息都路由到它
|
||||
- `/acp spawn codex --thread auto`:OpenClaw 可能会创建一个子线程/主题,并在那里绑定 ACP 会话
|
||||
- `/acp spawn codex --bind here`:保留当前聊天,启动或附加一个 Codex ACP 会话,并将这里未来的消息路由给它
|
||||
- `/acp spawn codex --thread auto`:OpenClaw 可能会创建一个子线程/topic,并在那里绑定 ACP 会话
|
||||
- `/acp spawn codex --bind here --cwd /workspace/repo`:与上面相同的聊天绑定,但 Codex 在 `/workspace/repo` 中运行
|
||||
|
||||
当前会话绑定支持:
|
||||
|
||||
- 宣告支持当前会话绑定的聊天/消息渠道,可以通过共享的会话绑定路径使用 `--bind here`。
|
||||
- 具有自定义线程/主题语义的渠道,仍然可以在相同共享接口之后提供渠道特定的规范化处理。
|
||||
- 宣告支持当前会话绑定的聊天/消息渠道可以通过共享的会话绑定路径使用 `--bind here`。
|
||||
- 具有自定义线程/topic 语义的渠道仍然可以在相同共享接口后提供渠道特定的规范化。
|
||||
- `--bind here` 始终表示“就地绑定当前会话”。
|
||||
- 通用的当前会话绑定使用共享的 OpenClaw 绑定存储,并能在正常的 Gateway 网关 重启后保留。
|
||||
- 通用的当前会话绑定使用共享的 OpenClaw 绑定存储,并可在正常 Gateway 网关重启后继续保留。
|
||||
|
||||
说明:
|
||||
|
||||
- 在 `/acp spawn` 中,`--bind here` 与 `--thread ...` 互斥。
|
||||
- 在 `/acp spawn` 上,`--bind here` 和 `--thread ...` 互斥。
|
||||
- 在 Discord 上,`--bind here` 会就地绑定当前渠道或线程。只有当 OpenClaw 需要为 `--thread auto|here` 创建子线程时,才需要 `spawnAcpSessions`。
|
||||
- 如果当前渠道不暴露当前会话 ACP 绑定能力,OpenClaw 会返回清晰的不支持提示。
|
||||
- `resume` 和“新会话”问题属于 ACP 会话层面的问题,而不是渠道层面的问题。你可以复用或替换运行时状态,而无需更改当前聊天界面。
|
||||
- 如果当前渠道不暴露当前会话 ACP 绑定能力,OpenClaw 会返回清晰的“不支持”消息。
|
||||
- `resume` 和“新会话”这类问题是 ACP 会话问题,而不是渠道问题。你可以复用或替换运行时状态,而无需更改当前聊天界面。
|
||||
|
||||
### 线程绑定会话
|
||||
|
||||
@ -183,16 +183,16 @@ OpenClaw 应该执行的操作:
|
||||
|
||||
- OpenClaw 将一个线程绑定到目标 ACP 会话。
|
||||
- 该线程中的后续消息会路由到已绑定的 ACP 会话。
|
||||
- ACP 输出会返回到同一个线程。
|
||||
- 失焦、关闭、归档、空闲超时或最大存活时间到期后,绑定会被移除。
|
||||
- ACP 输出会回传到同一个线程。
|
||||
- 失焦、关闭、归档、空闲超时或最大存活时间到期都会移除绑定。
|
||||
|
||||
线程绑定支持因适配器而异。如果当前渠道适配器不支持线程绑定,OpenClaw 会返回清晰的不支持/不可用提示。
|
||||
线程绑定支持取决于适配器本身。如果当前渠道适配器不支持线程绑定,OpenClaw 会返回清晰的“不支持/不可用”消息。
|
||||
|
||||
线程绑定 ACP 所需功能开关:
|
||||
线程绑定 ACP 所需的功能开关:
|
||||
|
||||
- `acp.enabled=true`
|
||||
- `acp.dispatch.enabled` 默认开启(设为 `false` 可暂停 ACP 分发)
|
||||
- 已启用渠道适配器的 ACP 线程启动开关(适配器特定)
|
||||
- `acp.dispatch.enabled` 默认开启(设置为 `false` 可暂停 ACP 调度)
|
||||
- 启用渠道适配器的 ACP 线程启动开关(适配器特定)
|
||||
- Discord:`channels.discord.threadBindings.spawnAcpSessions=true`
|
||||
- Telegram:`channels.telegram.threadBindings.spawnAcpSessions=true`
|
||||
|
||||
@ -201,25 +201,25 @@ OpenClaw 应该执行的操作:
|
||||
- 任何暴露会话/线程绑定能力的渠道适配器。
|
||||
- 当前内置支持:
|
||||
- Discord 线程/渠道
|
||||
- Telegram 主题(群组/超级群组中的论坛主题,以及私信主题)
|
||||
- 渠道插件也可以通过同一个绑定接口添加支持。
|
||||
- Telegram topics(群组/超级群组中的 forum topics 和私信 topics)
|
||||
- 渠道插件可以通过相同的绑定接口添加支持。
|
||||
|
||||
## 渠道特定设置
|
||||
|
||||
对于非临时工作流,请在顶层 `bindings[]` 条目中配置持久化 ACP 绑定。
|
||||
对于非临时性工作流,请在顶层 `bindings[]` 条目中配置持久 ACP 绑定。
|
||||
|
||||
### 绑定模型
|
||||
|
||||
- `bindings[].type="acp"` 表示一个持久化 ACP 会话绑定。
|
||||
- `bindings[].type="acp"` 表示持久 ACP 会话绑定。
|
||||
- `bindings[].match` 用于标识目标会话:
|
||||
- Discord 渠道或线程:`match.channel="discord"` + `match.peer.id="<channelOrThreadId>"`
|
||||
- Telegram 论坛主题:`match.channel="telegram"` + `match.peer.id="<chatId>:topic:<topicId>"`
|
||||
- Telegram forum topic:`match.channel="telegram"` + `match.peer.id="<chatId>:topic:<topicId>"`
|
||||
- BlueBubbles 私信/群聊:`match.channel="bluebubbles"` + `match.peer.id="<handle|chat_id:*|chat_guid:*|chat_identifier:*>"`
|
||||
对于稳定的群组绑定,优先使用 `chat_id:*` 或 `chat_identifier:*`。
|
||||
- iMessage 私信/群聊:`match.channel="imessage"` + `match.peer.id="<handle|chat_id:*|chat_guid:*|chat_identifier:*>"`
|
||||
对于稳定的群组绑定,优先使用 `chat_id:*`。
|
||||
- `bindings[].agentId` 是所属的 OpenClaw 智能体 id。
|
||||
- 可选的 ACP 覆盖值位于 `bindings[].acp` 下:
|
||||
- 可选的 ACP 覆盖项位于 `bindings[].acp` 下:
|
||||
- `mode`(`persistent` 或 `oneshot`)
|
||||
- `label`
|
||||
- `cwd`
|
||||
@ -227,7 +227,7 @@ OpenClaw 应该执行的操作:
|
||||
|
||||
### 每个智能体的运行时默认值
|
||||
|
||||
使用 `agents.list[].runtime` 为每个智能体统一定义 ACP 默认值:
|
||||
使用 `agents.list[].runtime` 为每个智能体一次性定义 ACP 默认值:
|
||||
|
||||
- `agents.list[].runtime.type="acp"`
|
||||
- `agents.list[].runtime.acp.agent`(harness id,例如 `codex` 或 `claude`)
|
||||
@ -324,15 +324,15 @@ ACP 已绑定会话的覆盖优先级:
|
||||
行为:
|
||||
|
||||
- OpenClaw 会在使用前确保已配置的 ACP 会话存在。
|
||||
- 该渠道或主题中的消息会路由到已配置的 ACP 会话。
|
||||
- 该渠道或 topic 中的消息会被路由到已配置的 ACP 会话。
|
||||
- 在已绑定会话中,`/new` 和 `/reset` 会就地重置同一个 ACP 会话键。
|
||||
- 临时运行时绑定(例如由线程聚焦流程创建的绑定)在存在时仍会生效。
|
||||
- 对于未显式指定 `cwd` 的跨智能体 ACP 启动,OpenClaw 会从智能体配置继承目标智能体工作区。
|
||||
- 缺失的继承工作区路径会回退到后端默认 cwd;非缺失的访问失败则会作为启动错误暴露出来。
|
||||
- 临时运行时绑定(例如由线程聚焦流程创建的绑定)在存在时仍然会生效。
|
||||
- 对于未显式指定 `cwd` 的跨智能体 ACP 启动,OpenClaw 会从智能体配置中继承目标智能体的工作区。
|
||||
- 缺失的继承工作区路径会回退到后端默认 cwd;非缺失的访问失败会作为启动错误直接暴露。
|
||||
|
||||
## 启动 ACP 会话(接口)
|
||||
|
||||
### 从 `sessions_spawn` 启动
|
||||
### 从 `sessions_spawn`
|
||||
|
||||
使用 `runtime: "acp"` 从智能体轮次或工具调用中启动 ACP 会话。
|
||||
|
||||
@ -348,29 +348,29 @@ ACP 已绑定会话的覆盖优先级:
|
||||
|
||||
说明:
|
||||
|
||||
- `runtime` 默认为 `subagent`,因此对于 ACP 会话请显式设置 `runtime: "acp"`。
|
||||
- 如果省略 `agentId`,则在已配置时 OpenClaw 会使用 `acp.defaultAgent`。
|
||||
- `mode: "session"` 需要 `thread: true` 才能保留一个持久的已绑定会话。
|
||||
- `runtime` 默认值是 `subagent`,因此对于 ACP 会话请显式设置 `runtime: "acp"`。
|
||||
- 如果省略 `agentId`,在已配置时 OpenClaw 会使用 `acp.defaultAgent`。
|
||||
- `mode: "session"` 需要 `thread: true`,以保留一个持久的已绑定会话。
|
||||
|
||||
接口细节:
|
||||
|
||||
- `task`(必填):发送到 ACP 会话的初始提示。
|
||||
- `task`(必填):发送到 ACP 会话的初始提示词。
|
||||
- `runtime`(ACP 必填):必须为 `"acp"`。
|
||||
- `agentId`(可选):ACP 目标 harness id。如果设置了 `acp.defaultAgent`,则回退到该值。
|
||||
- `agentId`(可选):ACP 目标 harness id。如果已设置,则回退到 `acp.defaultAgent`。
|
||||
- `thread`(可选,默认 `false`):在支持时请求线程绑定流程。
|
||||
- `mode`(可选):`run`(一次性)或 `session`(持久化)。
|
||||
- 默认值为 `run`
|
||||
- 如果 `thread: true` 且省略了 mode,OpenClaw 可能会按运行时路径默认使用持久化行为
|
||||
- `mode`(可选):`run`(一次性)或 `session`(持久)。
|
||||
- 默认值是 `run`
|
||||
- 如果 `thread: true` 且省略 `mode`,OpenClaw 可能会根据运行时路径默认使用持久行为
|
||||
- `mode: "session"` 需要 `thread: true`
|
||||
- `cwd`(可选):请求的运行时工作目录(由后端/运行时策略校验)。如果省略,ACP 启动会在已配置时继承目标智能体工作区;缺失的继承路径会回退到后端默认值,而真实访问错误会被返回。
|
||||
- `label`(可选):用于会话/横幅文本中的面向操作员标签。
|
||||
- `resumeSessionId`(可选):恢复一个现有 ACP 会话,而不是创建新会话。智能体会通过 `session/load` 重放其会话历史。要求 `runtime: "acp"`。
|
||||
- `streamTo`(可选):`"parent"` 会将初始 ACP 运行的进度摘要,以系统事件形式流式回传给请求者会话。
|
||||
- 在可用时,返回结果中可包含 `streamLogPath`,指向一个会话范围的 JSONL 日志(`<sessionId>.acp-stream.jsonl`),你可以 tail 它来查看完整的转发历史。
|
||||
- `cwd`(可选):请求的运行时工作目录(由后端/运行时策略校验)。如果省略,在已配置时 ACP 启动会继承目标智能体的工作区;缺失的继承路径会回退到后端默认值,而真实的访问错误会直接返回。
|
||||
- `label`(可选):用于会话/横幅文本中的面向操作人员标签。
|
||||
- `resumeSessionId`(可选):恢复现有 ACP 会话而不是创建新会话。智能体会通过 `session/load` 重放其会话历史。需要 `runtime: "acp"`。
|
||||
- `streamTo`(可选):`"parent"` 会把初始 ACP 运行进度摘要作为系统事件流式返回到请求方会话。
|
||||
- 在可用时,可接受的响应会包含 `streamLogPath`,指向一个按会话范围划分的 JSONL 日志(`<sessionId>.acp-stream.jsonl`),你可以对其执行 tail 以查看完整的转发历史。
|
||||
|
||||
### 恢复现有会话
|
||||
|
||||
使用 `resumeSessionId` 继续之前的 ACP 会话,而不是重新开始。智能体会通过 `session/load` 重放其会话历史,因此它会带着之前的完整上下文继续工作。
|
||||
使用 `resumeSessionId` 继续之前的 ACP 会话,而不是重新开始。智能体会通过 `session/load` 重放其会话历史,因此它会带着之前完整上下文继续工作。
|
||||
|
||||
```json
|
||||
{
|
||||
@ -383,41 +383,41 @@ ACP 已绑定会话的覆盖优先级:
|
||||
|
||||
常见用例:
|
||||
|
||||
- 将一个 Codex 会话从你的笔记本交接到手机上 —— 让你的智能体接着你上次离开的地方继续
|
||||
- 继续你之前在 CLI 中交互式开启、现在想通过智能体无头继续的编码会话
|
||||
- 继续因 Gateway 网关 重启或空闲超时而中断的工作
|
||||
- 把一个 Codex 会话从你的笔记本交接到手机上——告诉你的智能体从你中断的地方继续
|
||||
- 继续一个你之前在 CLI 中交互式启动、现在想通过智能体以无头方式继续的编码会话
|
||||
- 继续一项因 Gateway 网关重启或空闲超时而中断的工作
|
||||
|
||||
说明:
|
||||
|
||||
- `resumeSessionId` 要求 `runtime: "acp"` —— 如果与子智能体运行时一起使用会返回错误。
|
||||
- `resumeSessionId` 会恢复上游 ACP 会话历史;`thread` 和 `mode` 仍会像平常一样应用到你正在创建的新 OpenClaw 会话,因此 `mode: "session"` 仍然需要 `thread: true`。
|
||||
- 目标智能体必须支持 `session/load`(Codex 和 Claude Code 支持)。
|
||||
- 如果找不到该会话 ID,启动会以明确错误失败 —— 不会静默回退到新会话。
|
||||
- `resumeSessionId` 需要 `runtime: "acp"`——如果与子智能体运行时一起使用会返回错误。
|
||||
- `resumeSessionId` 会恢复上游 ACP 会话历史;`thread` 和 `mode` 仍会正常作用于你正在创建的新 OpenClaw 会话,因此 `mode: "session"` 仍然要求 `thread: true`。
|
||||
- 目标智能体必须支持 `session/load`(Codex 和 Claude Code 都支持)。
|
||||
- 如果找不到该会话 ID,启动会以清晰错误失败——不会静默回退为新会话。
|
||||
|
||||
### 面向操作员的冒烟测试
|
||||
### 操作员冒烟测试
|
||||
|
||||
当你在 Gateway 网关 部署之后,希望快速进行一次在线检查以确认 ACP 启动
|
||||
确实端到端可用,而不只是通过单元测试时,请使用此方法。
|
||||
当你在 Gateway 网关部署后想快速做一次在线检查,以确认 ACP 启动
|
||||
确实在端到端工作,而不只是通过了单元测试时,请使用此方法。
|
||||
|
||||
推荐检查步骤:
|
||||
推荐门槛:
|
||||
|
||||
1. 在目标主机上验证已部署的 Gateway 网关 版本/提交。
|
||||
1. 在目标主机上验证已部署的 Gateway 网关版本/提交。
|
||||
2. 确认已部署源码在
|
||||
`src/gateway/sessions-patch.ts` 中包含 ACP 血缘接受逻辑(`subagent:* or acp:* sessions`)。
|
||||
3. 向一个在线智能体打开一个临时 ACPX 桥接会话(例如
|
||||
3. 打开一个临时 ACPX bridge 会话,连接到在线智能体(例如
|
||||
`jpclawhq` 上的 `razor(main)`)。
|
||||
4. 要求该智能体调用 `sessions_spawn`,参数如下:
|
||||
4. 要求该智能体使用以下参数调用 `sessions_spawn`:
|
||||
- `runtime: "acp"`
|
||||
- `agentId: "codex"`
|
||||
- `mode: "run"`
|
||||
- task:`Reply with exactly LIVE-ACP-SPAWN-OK`
|
||||
5. 验证智能体报告:
|
||||
5. 验证该智能体报告了:
|
||||
- `accepted=yes`
|
||||
- 一个真实的 `childSessionKey`
|
||||
- 没有校验器错误
|
||||
6. 清理这个临时 ACPX 桥接会话。
|
||||
6. 清理这个临时 ACPX bridge 会话。
|
||||
|
||||
发送给在线智能体的示例提示:
|
||||
发给在线智能体的示例提示词:
|
||||
|
||||
```text
|
||||
Use the sessions_spawn tool now with runtime: "acp", agentId: "codex", and mode: "run".
|
||||
@ -427,26 +427,26 @@ Then report only: accepted=<yes/no>; childSessionKey=<value or none>; error=<exa
|
||||
|
||||
说明:
|
||||
|
||||
- 除非你有意测试线程绑定的持久化 ACP 会话,否则请将这个冒烟测试保持在 `mode: "run"`。
|
||||
- 基础检查不需要 `streamTo: "parent"`。该路径依赖请求者/会话能力,是单独的集成检查项。
|
||||
- 将线程绑定的 `mode: "session"` 测试视为第二轮、更深入的集成验证,应从真实的 Discord 线程或 Telegram 主题发起。
|
||||
- 除非你是有意测试绑定到线程的持久 ACP 会话,否则请将这个冒烟测试保持在 `mode: "run"`。
|
||||
- 基础门槛不要要求 `streamTo: "parent"`。该路径依赖于请求方/会话能力,属于单独的集成检查。
|
||||
- 将绑定到线程的 `mode: "session"` 测试视为第二阶段、更完整的集成验证,应从真实的 Discord 线程或 Telegram topic 发起。
|
||||
|
||||
## 沙箱兼容性
|
||||
|
||||
ACP 会话当前运行在主机运行时上,而不是在 OpenClaw 沙箱内。
|
||||
ACP 会话当前运行在宿主机运行时上,而不是 OpenClaw 沙箱内。
|
||||
|
||||
当前限制:
|
||||
|
||||
- 如果请求者会话处于沙箱中,则 `sessions_spawn({ runtime: "acp" })` 和 `/acp spawn` 的 ACP 启动都会被阻止。
|
||||
- 如果请求方会话处于沙箱中,则 `sessions_spawn({ runtime: "acp" })` 和 `/acp spawn` 的 ACP 启动都会被阻止。
|
||||
- 错误:`Sandboxed sessions cannot spawn ACP sessions because runtime="acp" runs on the host. Use runtime="subagent" from sandboxed sessions.`
|
||||
- `runtime: "acp"` 的 `sessions_spawn` 不支持 `sandbox: "require"`。
|
||||
- 使用 `runtime: "acp"` 的 `sessions_spawn` 不支持 `sandbox: "require"`。
|
||||
- 错误:`sessions_spawn sandbox="require" is unsupported for runtime="acp" because ACP sessions run outside the sandbox. Use runtime="subagent" or sandbox="inherit".`
|
||||
|
||||
当你需要强制沙箱执行时,请使用 `runtime: "subagent"`。
|
||||
当你需要由沙箱强制执行时,请使用 `runtime: "subagent"`。
|
||||
|
||||
### 从 `/acp` 命令启动
|
||||
### 从 `/acp` 命令
|
||||
|
||||
在需要时,从聊天中使用 `/acp spawn` 进行显式的操作员控制。
|
||||
当你需要从聊天中进行显式的操作员控制时,请使用 `/acp spawn`。
|
||||
|
||||
```text
|
||||
/acp spawn codex --mode persistent --thread auto
|
||||
@ -473,14 +473,14 @@ ACP 会话当前运行在主机运行时上,而不是在 OpenClaw 沙箱内。
|
||||
|
||||
1. 显式目标参数(或 `/acp steer` 的 `--session`)
|
||||
- 先尝试 key
|
||||
- 再尝试 UUID 形状的 session id
|
||||
- 再尝试 UUID 形态的 session id
|
||||
- 最后尝试 label
|
||||
2. 当前线程绑定(如果此会话/线程绑定到了 ACP 会话)
|
||||
3. 当前请求者会话回退
|
||||
2. 当前线程绑定(如果这个会话/线程已绑定到一个 ACP 会话)
|
||||
3. 当前请求方会话回退
|
||||
|
||||
当前会话绑定和线程绑定都会参与第 2 步。
|
||||
|
||||
如果无法解析目标,OpenClaw 会返回清晰错误(`Unable to resolve session target: ...`)。
|
||||
如果无法解析出目标,OpenClaw 会返回清晰错误(`Unable to resolve session target: ...`)。
|
||||
|
||||
## 启动绑定模式
|
||||
|
||||
@ -488,12 +488,12 @@ ACP 会话当前运行在主机运行时上,而不是在 OpenClaw 沙箱内。
|
||||
|
||||
| 模式 | 行为 |
|
||||
| ------ | ---------------------------------------------------------------------- |
|
||||
| `here` | 就地绑定当前活动会话;如果没有活动会话则失败。 |
|
||||
| `off` | 不创建当前会话绑定。 |
|
||||
| `here` | 就地绑定当前活动会话;如果当前没有活动会话则失败。 |
|
||||
| `off` | 不创建当前会话绑定。 |
|
||||
|
||||
说明:
|
||||
|
||||
- `--bind here` 是“让这个渠道或聊天由 Codex 提供支持”的最简单操作路径。
|
||||
- `--bind here` 是“让这个渠道或聊天由 Codex 提供支持”的最简单操作员路径。
|
||||
- `--bind here` 不会创建子线程。
|
||||
- `--bind here` 仅在暴露当前会话绑定支持的渠道上可用。
|
||||
- `--bind` 和 `--thread` 不能在同一个 `/acp spawn` 调用中组合使用。
|
||||
@ -504,14 +504,14 @@ ACP 会话当前运行在主机运行时上,而不是在 OpenClaw 沙箱内。
|
||||
|
||||
| 模式 | 行为 |
|
||||
| ------ | --------------------------------------------------------------------------------------------------- |
|
||||
| `auto` | 在活动线程中:绑定该线程。在线程之外:在支持时创建/绑定一个子线程。 |
|
||||
| `auto` | 在活动线程中:绑定该线程。在非线程环境中:在支持时创建并绑定一个子线程。 |
|
||||
| `here` | 要求当前处于活动线程中;如果不在线程中则失败。 |
|
||||
| `off` | 不绑定。会话以未绑定状态启动。 |
|
||||
| `off` | 不创建绑定。会话以未绑定状态启动。 |
|
||||
|
||||
说明:
|
||||
|
||||
- 在不支持线程绑定的界面上,默认行为实际上等同于 `off`。
|
||||
- 线程绑定启动需要渠道策略支持:
|
||||
- 绑定到线程的启动需要渠道策略支持:
|
||||
- Discord:`channels.discord.threadBindings.spawnAcpSessions=true`
|
||||
- Telegram:`channels.telegram.threadBindings.spawnAcpSessions=true`
|
||||
- 当你想固定当前会话而不创建子线程时,请使用 `--bind here`。
|
||||
@ -536,7 +536,7 @@ ACP 会话当前运行在主机运行时上,而不是在 OpenClaw 沙箱内。
|
||||
- `/acp doctor`
|
||||
- `/acp install`
|
||||
|
||||
`/acp status` 会显示生效中的运行时选项,并在可用时显示运行时级别和后端级别的会话标识符。
|
||||
`/acp status` 会显示生效中的运行时选项,并在可用时显示运行时级和后端级的会话标识符。
|
||||
|
||||
某些控制依赖后端能力。如果某个后端不支持某项控制,OpenClaw 会返回清晰的“不支持该控制”错误。
|
||||
|
||||
@ -544,27 +544,27 @@ ACP 会话当前运行在主机运行时上,而不是在 OpenClaw 沙箱内。
|
||||
|
||||
| 命令 | 作用 | 示例 |
|
||||
| -------------------- | --------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| `/acp spawn` | 创建 ACP 会话;可选当前绑定或线程绑定。 | `/acp spawn codex --bind here --cwd /repo` |
|
||||
| `/acp spawn` | 创建 ACP 会话;可选择当前会话绑定或线程绑定。 | `/acp spawn codex --bind here --cwd /repo` |
|
||||
| `/acp cancel` | 取消目标会话的进行中轮次。 | `/acp cancel agent:codex:acp:<uuid>` |
|
||||
| `/acp steer` | 向运行中的会话发送引导指令。 | `/acp steer --session support inbox prioritize failing tests` |
|
||||
| `/acp close` | 关闭会话并解绑线程目标。 | `/acp close` |
|
||||
| `/acp status` | 显示后端、模式、状态、运行时选项、能力。 | `/acp status` |
|
||||
| `/acp set-mode` | 为目标会话设置运行时模式。 | `/acp set-mode plan` |
|
||||
| `/acp set` | 通用运行时配置项写入。 | `/acp set model openai/gpt-5.4` |
|
||||
| `/acp set` | 通用运行时配置选项写入。 | `/acp set model openai/gpt-5.4` |
|
||||
| `/acp cwd` | 设置运行时工作目录覆盖值。 | `/acp cwd /Users/user/Projects/repo` |
|
||||
| `/acp permissions` | 设置审批策略配置。 | `/acp permissions strict` |
|
||||
| `/acp permissions` | 设置审批策略配置文件。 | `/acp permissions strict` |
|
||||
| `/acp timeout` | 设置运行时超时(秒)。 | `/acp timeout 120` |
|
||||
| `/acp model` | 设置运行时模型覆盖值。 | `/acp model anthropic/claude-opus-4-6` |
|
||||
| `/acp reset-options` | 移除会话运行时选项覆盖值。 | `/acp reset-options` |
|
||||
| `/acp sessions` | 从存储中列出最近的 ACP 会话。 | `/acp sessions` |
|
||||
| `/acp doctor` | 后端健康状态、能力、可执行修复建议。 | `/acp doctor` |
|
||||
| `/acp install` | 打印可复现的安装和启用步骤。 | `/acp install` |
|
||||
| `/acp doctor` | 后端健康状态、能力、可执行修复。 | `/acp doctor` |
|
||||
| `/acp install` | 输出确定性的安装与启用步骤。 | `/acp install` |
|
||||
|
||||
`/acp sessions` 会读取当前已绑定会话或请求者会话的存储。接受 `session-key`、`session-id` 或 `session-label` 标记的命令,会通过 Gateway 网关 会话发现来解析目标,包括自定义的按智能体划分的 `session.store` 根目录。
|
||||
`/acp sessions` 会读取当前已绑定会话或请求方会话对应的存储。接受 `session-key`、`session-id` 或 `session-label` 标记的命令,会通过 Gateway 网关会话发现来解析目标,包括自定义的每智能体 `session.store` 根路径。
|
||||
|
||||
## 运行时选项映射
|
||||
|
||||
`/acp` 提供便捷命令和一个通用设置器。
|
||||
`/acp` 提供便捷命令和通用设置器。
|
||||
|
||||
等价操作:
|
||||
|
||||
@ -573,12 +573,12 @@ ACP 会话当前运行在主机运行时上,而不是在 OpenClaw 沙箱内。
|
||||
- `/acp timeout <seconds>` 映射到运行时配置键 `timeout`。
|
||||
- `/acp cwd <path>` 直接更新运行时 cwd 覆盖值。
|
||||
- `/acp set <key> <value>` 是通用路径。
|
||||
- 特殊情况:`key=cwd` 使用 cwd 覆盖路径。
|
||||
- 特殊情况:`key=cwd` 会使用 cwd 覆盖路径。
|
||||
- `/acp reset-options` 会清除目标会话的所有运行时覆盖值。
|
||||
|
||||
## acpx harness 支持(当前)
|
||||
|
||||
当前 acpx 内置 harness 别名:
|
||||
当前 acpx 内置的 harness 别名:
|
||||
|
||||
- `claude`
|
||||
- `codex`
|
||||
@ -596,9 +596,9 @@ ACP 会话当前运行在主机运行时上,而不是在 OpenClaw 沙箱内。
|
||||
- `qwen`
|
||||
|
||||
当 OpenClaw 使用 acpx 后端时,除非你的 acpx 配置定义了自定义智能体别名,否则应优先将这些值用作 `agentId`。
|
||||
如果你的本地 Cursor 安装仍将 ACP 暴露为 `agent acp`,请在 acpx 配置中覆盖 `cursor` 智能体命令,而不要更改内置默认值。
|
||||
如果你的本地 Cursor 安装仍将 ACP 暴露为 `agent acp`,请在 acpx 配置中覆盖 `cursor` 智能体命令,而不是修改内置默认值。
|
||||
|
||||
直接使用 acpx CLI 也可以通过 `--agent <command>` 指向任意适配器,但这个原始逃生口是 acpx CLI 功能(不是常规的 OpenClaw `agentId` 路径)。
|
||||
直接使用 acpx CLI 也可以通过 `--agent <command>` 定位任意适配器,但这个原始逃生舱是 acpx CLI 功能(不是正常的 OpenClaw `agentId` 路径)。
|
||||
|
||||
## 必需配置
|
||||
|
||||
@ -608,7 +608,7 @@ ACP 会话当前运行在主机运行时上,而不是在 OpenClaw 沙箱内。
|
||||
{
|
||||
acp: {
|
||||
enabled: true,
|
||||
// 可选。默认值为 true;设为 false 可在保留 /acp 控制的同时暂停 ACP 分发。
|
||||
// 可选。默认值为 true;设置为 false 可暂停 ACP 调度,同时保留 /acp 控制。
|
||||
dispatch: { enabled: true },
|
||||
backend: "acpx",
|
||||
defaultAgent: "codex",
|
||||
@ -640,7 +640,7 @@ ACP 会话当前运行在主机运行时上,而不是在 OpenClaw 沙箱内。
|
||||
}
|
||||
```
|
||||
|
||||
线程绑定配置因渠道适配器而异。Discord 示例:
|
||||
线程绑定配置取决于具体渠道适配器。以下是 Discord 示例:
|
||||
|
||||
```json5
|
||||
{
|
||||
@ -662,7 +662,7 @@ ACP 会话当前运行在主机运行时上,而不是在 OpenClaw 沙箱内。
|
||||
}
|
||||
```
|
||||
|
||||
如果线程绑定 ACP 启动无法工作,请先验证适配器功能开关:
|
||||
如果绑定到线程的 ACP 启动无法工作,请先验证适配器功能开关:
|
||||
|
||||
- Discord:`channels.discord.threadBindings.spawnAcpSessions=true`
|
||||
|
||||
@ -672,10 +672,10 @@ ACP 会话当前运行在主机运行时上,而不是在 OpenClaw 沙箱内。
|
||||
|
||||
## acpx 后端的插件设置
|
||||
|
||||
全新安装默认启用内置 `acpx` 运行时插件,因此 ACP
|
||||
全新安装默认启用内置的 `acpx` 运行时插件,因此 ACP
|
||||
通常无需手动安装插件即可工作。
|
||||
|
||||
请从以下命令开始:
|
||||
首先运行:
|
||||
|
||||
```text
|
||||
/acp doctor
|
||||
@ -689,7 +689,7 @@ openclaw plugins install acpx
|
||||
openclaw config set plugins.entries.acpx.enabled true
|
||||
```
|
||||
|
||||
开发期间进行本地工作区安装:
|
||||
开发期间安装本地工作区版本:
|
||||
|
||||
```bash
|
||||
openclaw plugins install ./path/to/local/acpx-plugin
|
||||
@ -701,16 +701,16 @@ openclaw plugins install ./path/to/local/acpx-plugin
|
||||
/acp doctor
|
||||
```
|
||||
|
||||
### acpx 命令和版本配置
|
||||
### acpx 命令与版本配置
|
||||
|
||||
默认情况下,内置 acpx 后端插件(`acpx`)使用插件本地固定版本的二进制文件:
|
||||
默认情况下,内置的 acpx 后端插件(`acpx`)使用插件本地固定版本的二进制文件:
|
||||
|
||||
1. 命令默认指向 ACPX 插件包内插件本地的 `node_modules/.bin/acpx`。
|
||||
2. 预期版本默认使用扩展固定版本。
|
||||
3. 启动时会立即将 ACP 后端注册为未就绪状态。
|
||||
4. 一个后台确保任务会验证 `acpx --version`。
|
||||
3. 启动时立即将 ACP 后端注册为未就绪。
|
||||
4. 一个后台 ensure 作业会验证 `acpx --version`。
|
||||
5. 如果插件本地二进制文件缺失或版本不匹配,它会运行:
|
||||
`npm install --omit=dev --no-save acpx@<pinned>` 并重新验证。
|
||||
`npm install --omit=dev --no-save acpx@<pinned>`,然后重新验证。
|
||||
|
||||
你可以在插件配置中覆盖命令/版本:
|
||||
|
||||
@ -736,78 +736,89 @@ openclaw plugins install ./path/to/local/acpx-plugin
|
||||
- 相对路径从 OpenClaw 工作区目录解析。
|
||||
- `expectedVersion: "any"` 会禁用严格版本匹配。
|
||||
- 当 `command` 指向自定义二进制文件/路径时,插件本地自动安装会被禁用。
|
||||
- 在后端健康检查运行期间,OpenClaw 启动保持非阻塞。
|
||||
- 在后端健康检查运行期间,OpenClaw 启动仍然是非阻塞的。
|
||||
|
||||
参见 [Plugins](/zh-CN/tools/plugin)。
|
||||
|
||||
### 自动安装依赖
|
||||
### 自动依赖安装
|
||||
|
||||
当你通过 `npm install -g openclaw` 全局安装 OpenClaw 时,acpx
|
||||
运行时依赖(平台相关二进制文件)会通过 postinstall 钩子自动安装。
|
||||
如果自动安装失败,Gateway 网关 仍会正常启动,并通过 `openclaw acp doctor` 报告缺失的依赖。
|
||||
当你使用 `npm install -g openclaw` 全局安装 OpenClaw 时,acpx
|
||||
运行时依赖(平台特定二进制文件)会通过 postinstall 钩子自动安装。
|
||||
如果自动安装失败,Gateway 网关仍会正常启动,
|
||||
并通过 `openclaw acp doctor` 报告缺失的依赖。
|
||||
|
||||
### 插件工具 MCP 桥接
|
||||
### 插件工具 MCP bridge
|
||||
|
||||
默认情况下,ACPX 会话**不会**向 ACP harness 暴露 OpenClaw 已注册的插件工具。
|
||||
默认情况下,ACPX 会话**不会**将 OpenClaw 已注册的插件工具暴露给
|
||||
ACP harness。
|
||||
|
||||
如果你希望 Codex 或 Claude Code 之类的 ACP 智能体调用已安装的
|
||||
OpenClaw 插件工具,例如 memory recall/store,请启用专用桥接:
|
||||
如果你希望 Codex 或 Claude Code 之类的 ACP 智能体可以调用已安装的
|
||||
OpenClaw 插件工具,例如 memory recall/store,请启用专用 bridge:
|
||||
|
||||
```bash
|
||||
openclaw config set plugins.entries.acpx.config.pluginToolsMcpBridge true
|
||||
```
|
||||
|
||||
它会执行以下操作:
|
||||
其作用是:
|
||||
|
||||
- 将一个名为 `openclaw-plugin-tools` 的内置 MCP 服务器注入到 ACPX 会话
|
||||
启动流程中。
|
||||
- 暴露由已安装并启用的 OpenClaw
|
||||
插件注册的插件工具。
|
||||
- 在 ACPX 会话引导过程中注入一个名为 `openclaw-plugin-tools` 的内置 MCP 服务器。
|
||||
- 暴露已安装并启用的 OpenClaw 插件已经注册的插件工具。
|
||||
- 保持该功能为显式启用,且默认关闭。
|
||||
|
||||
安全和信任说明:
|
||||
安全与信任说明:
|
||||
|
||||
- 这会扩大 ACP harness 的工具暴露面。
|
||||
- ACP 智能体只能访问 Gateway 网关 中已经处于活动状态的插件工具。
|
||||
- 应将其视为与允许这些插件在
|
||||
OpenClaw 本身中执行相同的信任边界。
|
||||
- 这会扩展 ACP harness 的工具面。
|
||||
- ACP 智能体只能访问 Gateway 网关中已经激活的插件工具。
|
||||
- 应将其视为与允许这些插件在 OpenClaw 本身中执行相同的信任边界。
|
||||
- 启用前请审查已安装的插件。
|
||||
|
||||
自定义 `mcpServers` 仍像以前一样可用。内置的插件工具桥接是一个
|
||||
额外的按需启用便捷功能,而不是通用 MCP 服务器配置的替代方案。
|
||||
自定义 `mcpServers` 仍与之前一样可用。内置的插件工具 bridge
|
||||
是额外的显式启用便利功能,不是通用 MCP 服务器配置的替代品。
|
||||
|
||||
### 运行时超时配置
|
||||
|
||||
内置 `acpx` 插件默认将嵌入式运行时轮次超时设置为 120 秒。
|
||||
这让像 Gemini CLI 这样的较慢 harness 也有足够时间完成
|
||||
ACP 启动和初始化。如果你的主机需要不同的
|
||||
运行时限制,可以覆盖该值:
|
||||
内置的 `acpx` 插件默认将嵌入式运行时轮次超时设置为 120 秒。
|
||||
这让 Gemini CLI 之类较慢的 harness 有足够时间完成
|
||||
ACP 启动和初始化。如果你的宿主机需要不同的
|
||||
运行时限制,可以覆盖它:
|
||||
|
||||
```bash
|
||||
openclaw config set plugins.entries.acpx.config.timeoutSeconds 180
|
||||
```
|
||||
|
||||
更改此值后请重启 Gateway 网关。
|
||||
修改此值后请重启 Gateway 网关。
|
||||
|
||||
### 健康探针智能体配置
|
||||
|
||||
内置的 `acpx` 插件在判断嵌入式运行时后端是否
|
||||
就绪时,会探测一个 harness 智能体。默认值是 `codex`。如果你的部署
|
||||
使用不同的默认 ACP 智能体,请将探针智能体设置为相同 id:
|
||||
|
||||
```bash
|
||||
openclaw config set plugins.entries.acpx.config.probeAgent claude
|
||||
```
|
||||
|
||||
修改此值后请重启 Gateway 网关。
|
||||
|
||||
## 权限配置
|
||||
|
||||
ACP 会话以非交互方式运行 —— 没有 TTY 可用于批准或拒绝文件写入和 shell 执行权限提示。acpx 插件提供了两个配置键来控制权限处理方式:
|
||||
ACP 会话以非交互方式运行——没有 TTY 可用于批准或拒绝文件写入和 shell 执行权限提示。acpx 插件提供了两个配置键,用于控制权限处理方式:
|
||||
|
||||
这些 ACPX harness 权限与 OpenClaw exec 审批是分开的,也与 CLI 后端厂商绕过标志(例如 Claude CLI `--permission-mode bypassPermissions`)分开。ACPX 的 `approve-all` 是 ACP 会话的 harness 级破窗开关。
|
||||
这些 ACPX harness 权限与 OpenClaw exec 审批分离,也与 CLI 后端厂商绕过标志分离,例如 Claude CLI `--permission-mode bypassPermissions`。ACPX `approve-all` 是 ACP 会话在 harness 级别的紧急放行开关。
|
||||
|
||||
### `permissionMode`
|
||||
|
||||
控制 harness 智能体可以在不提示的情况下执行哪些操作。
|
||||
控制 harness 智能体无需提示即可执行哪些操作。
|
||||
|
||||
| 值 | 行为 |
|
||||
| --------------- | --------------------------------------------------------- |
|
||||
| `approve-all` | 自动批准所有文件写入和 shell 命令。 |
|
||||
| `approve-reads` | 仅自动批准读取;写入和执行仍需提示。 |
|
||||
| `approve-reads` | 仅自动批准读取;写入和执行仍需要提示。 |
|
||||
| `deny-all` | 拒绝所有权限提示。 |
|
||||
|
||||
### `nonInteractivePermissions`
|
||||
|
||||
控制当本应显示权限提示,但没有可交互 TTY 可用时会发生什么(而这对于 ACP 会话始终如此)。
|
||||
控制当本应显示权限提示但没有可用交互式 TTY 时会发生什么(对于 ACP 会话,这种情况始终成立)。
|
||||
|
||||
| 值 | 行为 |
|
||||
| ------ | ----------------------------------------------------------------- |
|
||||
@ -816,18 +827,18 @@ ACP 会话以非交互方式运行 —— 没有 TTY 可用于批准或拒绝文
|
||||
|
||||
### 配置
|
||||
|
||||
通过插件配置设置:
|
||||
通过插件配置进行设置:
|
||||
|
||||
```bash
|
||||
openclaw config set plugins.entries.acpx.config.permissionMode approve-all
|
||||
openclaw config set plugins.entries.acpx.config.nonInteractivePermissions fail
|
||||
```
|
||||
|
||||
更改这些值后请重启 Gateway 网关。
|
||||
修改这些值后请重启 Gateway 网关。
|
||||
|
||||
> **重要:** OpenClaw 当前默认使用 `permissionMode=approve-reads` 和 `nonInteractivePermissions=fail`。在非交互式 ACP 会话中,任何触发权限提示的写入或执行操作都可能因 `AcpRuntimeError: Permission prompt unavailable in non-interactive mode` 而失败。
|
||||
> **重要:** OpenClaw 当前默认使用 `permissionMode=approve-reads` 和 `nonInteractivePermissions=fail`。在非交互 ACP 会话中,任何触发权限提示的写入或执行都可能失败,并报错 `AcpRuntimeError: Permission prompt unavailable in non-interactive mode`。
|
||||
>
|
||||
> 如果你需要限制权限,请将 `nonInteractivePermissions` 设为 `deny`,这样会话会优雅降级而不是崩溃。
|
||||
> 如果你需要限制权限,请将 `nonInteractivePermissions` 设置为 `deny`,这样会话会优雅降级,而不是直接崩溃。
|
||||
|
||||
## 故障排除
|
||||
|
||||
@ -835,17 +846,17 @@ openclaw config set plugins.entries.acpx.config.nonInteractivePermissions fail
|
||||
| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ACP runtime backend is not configured` | 后端插件缺失或被禁用。 | 安装并启用后端插件,然后运行 `/acp doctor`。 |
|
||||
| `ACP is disabled by policy (acp.enabled=false)` | ACP 被全局禁用。 | 设置 `acp.enabled=true`。 |
|
||||
| `ACP dispatch is disabled by policy (acp.dispatch.enabled=false)` | 已禁用来自普通线程消息的分发。 | 设置 `acp.dispatch.enabled=true`。 |
|
||||
| `ACP dispatch is disabled by policy (acp.dispatch.enabled=false)` | 来自普通线程消息的调度被禁用。 | 设置 `acp.dispatch.enabled=true`。 |
|
||||
| `ACP agent "<id>" is not allowed by policy` | 智能体不在允许列表中。 | 使用允许的 `agentId`,或更新 `acp.allowedAgents`。 |
|
||||
| `Unable to resolve session target: ...` | key/id/label 标记错误。 | 运行 `/acp sessions`,复制准确的 key/label,然后重试。 |
|
||||
| `--bind here requires running /acp spawn inside an active ... conversation` | 在没有活动可绑定会话的情况下使用了 `--bind here`。 | 移动到目标聊天/渠道后重试,或使用无绑定启动。 |
|
||||
| `Conversation bindings are unavailable for <channel>.` | 适配器缺少当前会话 ACP 绑定能力。 | 在支持时使用 `/acp spawn ... --thread ...`、配置顶层 `bindings[]`,或移动到受支持渠道。 |
|
||||
| `--thread here requires running /acp spawn inside an active ... thread` | 在非线程上下文中使用了 `--thread here`。 | 移动到目标线程,或使用 `--thread auto`/`off`。 |
|
||||
| `Only <user-id> can rebind this channel/conversation/thread.` | 当前绑定目标属于另一位用户。 | 由所有者重新绑定,或使用其他会话或线程。 |
|
||||
| `--bind here requires running /acp spawn inside an active ... conversation` | 在没有活动且可绑定的会话中使用了 `--bind here`。 | 移动到目标聊天/渠道后重试,或使用不绑定的启动方式。 |
|
||||
| `Conversation bindings are unavailable for <channel>.` | 适配器缺少当前会话 ACP 绑定能力。 | 在支持时使用 `/acp spawn ... --thread ...`,配置顶层 `bindings[]`,或切换到受支持的渠道。 |
|
||||
| `--thread here requires running /acp spawn inside an active ... thread` | 在线程上下文之外使用了 `--thread here`。 | 移动到目标线程,或使用 `--thread auto`/`off`。 |
|
||||
| `Only <user-id> can rebind this channel/conversation/thread.` | 另一个用户拥有当前活动绑定目标。 | 由绑定所有者重新绑定,或使用其他会话或线程。 |
|
||||
| `Thread bindings are unavailable for <channel>.` | 适配器缺少线程绑定能力。 | 使用 `--thread off`,或切换到受支持的适配器/渠道。 |
|
||||
| `Sandboxed sessions cannot spawn ACP sessions ...` | ACP 运行时在主机侧运行;请求者会话处于沙箱中。 | 在沙箱会话中使用 `runtime="subagent"`,或从非沙箱会话中运行 ACP 启动。 |
|
||||
| `sessions_spawn sandbox="require" is unsupported for runtime="acp" ...` | 为 ACP 运行时请求了 `sandbox="require"`。 | 对需要沙箱的情况使用 `runtime="subagent"`,或在非沙箱会话中配合 `sandbox="inherit"` 使用 ACP。 |
|
||||
| 绑定会话缺少 ACP 元数据 | ACP 会话元数据已过期/被删除。 | 使用 `/acp spawn` 重新创建,然后重新绑定/聚焦线程。 |
|
||||
| `AcpRuntimeError: Permission prompt unavailable in non-interactive mode` | `permissionMode` 阻止了非交互式 ACP 会话中的写入/执行。 | 将 `plugins.entries.acpx.config.permissionMode` 设为 `approve-all`,然后重启 Gateway 网关。参见[权限配置](#permission-configuration)。 |
|
||||
| ACP 会话很早失败且输出很少 | 权限提示被 `permissionMode`/`nonInteractivePermissions` 阻止。 | 检查 Gateway 网关 日志中的 `AcpRuntimeError`。如需完整权限,请设为 `permissionMode=approve-all`;如需优雅降级,请设为 `nonInteractivePermissions=deny`。 |
|
||||
| `Sandboxed sessions cannot spawn ACP sessions ...` | ACP 运行时位于宿主机侧;请求方会话处于沙箱中。 | 在沙箱会话中使用 `runtime="subagent"`,或从非沙箱会话发起 ACP 启动。 |
|
||||
| `sessions_spawn sandbox="require" is unsupported for runtime="acp" ...` | 为 ACP 运行时请求了 `sandbox="require"`。 | 对必须使用沙箱的情况使用 `runtime="subagent"`,或从非沙箱会话以 `sandbox="inherit"` 使用 ACP。 |
|
||||
| 已绑定会话缺少 ACP 元数据 | ACP 会话元数据已过期或被删除。 | 使用 `/acp spawn` 重新创建,然后重新绑定/重新聚焦线程。 |
|
||||
| `AcpRuntimeError: Permission prompt unavailable in non-interactive mode` | `permissionMode` 在非交互 ACP 会话中阻止了写入/执行。 | 将 `plugins.entries.acpx.config.permissionMode` 设置为 `approve-all`,然后重启 Gateway 网关。参见[权限配置](#permission-configuration)。 |
|
||||
| ACP 会话很早失败且几乎没有输出 | 权限提示被 `permissionMode`/`nonInteractivePermissions` 阻止。 | 检查 Gateway 网关日志中的 `AcpRuntimeError`。如需完全权限,设置 `permissionMode=approve-all`;如需优雅降级,设置 `nonInteractivePermissions=deny`。 |
|
||||
| ACP 会话在完成工作后无限期卡住 | harness 进程已结束,但 ACP 会话未报告完成。 | 使用 `ps aux \| grep acpx` 监控;手动杀掉陈旧进程。 |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user