CLI 命令
ACP
运行与 OpenClaw Gateway 网关通信的 Agent Client Protocol (ACP) 桥接。
此命令通过 stdio 为 IDE 提供 ACP 通信,并通过 WebSocket 将提示转发到 Gateway 网关。它会让 ACP 会话映射到 Gateway 网关会话键。
openclaw acp 是由 Gateway 网关支撑的 ACP 桥接,而不是完整的 ACP 原生编辑器运行时。它专注于会话路由、提示递送和基础流式更新。
如果你希望外部 MCP 客户端直接与 OpenClaw 渠道会话对话,而不是托管 ACP harness 会话,请改用 openclaw mcp serve。
这不是什么
此页面常与 ACP harness 会话混淆。
openclaw acp 表示:
- OpenClaw 作为 ACP 服务器运行
- IDE 或 ACP 客户端连接到 OpenClaw
- OpenClaw 将该工作转发到 Gateway 网关会话
这不同于 ACP Agents,后者是 OpenClaw 通过 acpx 运行 Codex 或 Claude Code 等外部 harness。
快速规则:
- 编辑器/客户端想通过 ACP 与 OpenClaw 对话:使用
openclaw acp - OpenClaw 应该将 Codex/Claude/Gemini 作为 ACP harness 启动:使用
/acp spawn和 ACP Agents
兼容性矩阵
| ACP 区域 | Status | 说明 |
|---|---|---|
initialize, newSession, prompt, cancel |
已实现 | 通过 stdio 到 Gateway 网关 chat/send + abort 的核心桥接流程。 |
listSessions, slash commands |
已实现 | 会话列表基于 Gateway 网关会话状态工作;命令通过 available_commands_update 公布。 |
loadSession |
部分支持 | 将 ACP 会话重新绑定到 Gateway 网关会话键,并重放已存储的用户/助手文本历史。工具/系统历史尚未重建。 |
提示内容(text、嵌入的 resource、图像) |
部分支持 | 文本/资源会被展平为聊天输入;图像会变成 Gateway 网关附件。 |
| 会话模式 | 部分支持 | 支持 session/set_mode,且桥接会暴露初始的 Gateway 网关支撑会话控制项,用于思考级别、工具详细程度、推理、用量详情和提权操作。更广泛的 ACP 原生模式/配置表面仍不在范围内。 |
| 会话信息和用量更新 | 部分支持 | 桥接会根据缓存的 Gateway 网关会话快照发出 session_info_update 和尽力而为的 usage_update 通知。用量是近似值,并且仅在 Gateway 网关 token 总量被标记为新鲜时发送。 |
| 工具流式传输 | 部分支持 | 当 Gateway 网关工具参数/结果暴露原始 I/O、文本内容和尽力而为的文件位置时,tool_call / tool_call_update 事件会包含这些内容。嵌入式终端和更丰富的 diff 原生输出仍未暴露。 |
每会话 MCP 服务器(mcpServers) |
不支持 | 桥接模式会拒绝每会话 MCP 服务器请求。请改为在 OpenClaw gateway 或智能体上配置 MCP。 |
客户端文件系统方法(fs/read_text_file、fs/write_text_file) |
不支持 | 桥接不会调用 ACP 客户端文件系统方法。 |
客户端终端方法(terminal/*) |
不支持 | 桥接不会创建 ACP 客户端终端,也不会通过工具调用流式传输终端 id。 |
| 会话计划 / 思考流式传输 | 不支持 | 桥接目前会发出输出文本和工具状态,而不是 ACP 计划或思考更新。 |
已知限制
loadSession会重放已存储的用户和助手文本历史,但不会重建历史工具调用、系统通知或更丰富的 ACP 原生事件类型。- 如果多个 ACP 客户端共享同一个 Gateway 网关会话键,事件和取消路由是尽力而为的,而不是按客户端严格隔离。需要干净的编辑器本地轮次时,请优先使用默认隔离的
acp:<uuid>会话。 - Gateway 网关停止状态会转换为 ACP 停止原因,但该映射不如完全 ACP 原生运行时那样有表现力。
- 初始会话控制目前只暴露一组聚焦的 Gateway 网关旋钮:思考级别、工具详细程度、推理、用量详情和提权操作。模型选择和执行主机控制尚未作为 ACP 配置选项暴露。
session_info_update和usage_update派生自 Gateway 网关会话快照,而不是实时 ACP 原生运行时计量。用量是近似值,不包含费用数据,并且仅在 Gateway 网关将总 token 数据标记为新鲜时发出。- 工具跟随数据是尽力而为的。桥接可以暴露出现在已知工具参数/结果中的文件路径,但尚不会发出 ACP 终端或结构化文件 diff。
用法
openclaw acp
# Remote Gateway
openclaw acp --url wss://gateway-host:18789 --token <token>
# Remote Gateway (token from file)
openclaw acp --url wss://gateway-host:18789 --token-file ~/.openclaw/gateway.token
# Attach to an existing session key
openclaw acp --session agent:main:main
# Attach by label (must already exist)
openclaw acp --session-label "support inbox"
# Reset the session key before the first prompt
openclaw acp --session agent:main:main --reset-session
ACP 客户端(调试)
使用内置 ACP 客户端在没有 IDE 的情况下对桥接做完整性检查。它会启动 ACP 桥接,并让你以交互方式输入提示。
openclaw acp client
# Point the spawned bridge at a remote Gateway
openclaw acp client --server-args --url wss://gateway-host:18789 --token-file ~/.openclaw/gateway.token
# Override the server command (default: openclaw)
openclaw acp client --server "node" --server-args openclaw.mjs acp --url ws://127.0.0.1:19001
权限模型(客户端调试模式):
- 自动批准基于 allowlist,并且仅适用于受信任的核心工具 ID。
read自动批准限定在当前工作目录内(设置了--cwd时使用该目录)。- ACP 只会自动批准狭窄的只读类别:活动 cwd 下的作用域内
read调用,加上只读搜索工具(search、web_search、memory_search)。未知/非核心工具、范围外读取、可执行工具、控制平面工具、变更型工具和交互式流程始终需要显式提示批准。 - 服务器提供的
toolCall.kind会被视为不受信任的元数据(不是授权来源)。 - 此 ACP 桥接策略独立于 ACPX harness 权限。如果你通过
acpx后端运行 OpenClaw,plugins.entries.acpx.config.permissionMode=approve-all是该 harness 会话的 break-glass "yolo" 开关。
如何使用它
当 IDE(或其他客户端)使用 Agent Client Protocol,并且你希望它驱动 OpenClaw Gateway 网关会话时,请使用 ACP。
- 确保 Gateway 网关正在运行(本地或远程)。
- 配置 Gateway 网关目标(配置或标志)。
- 指向你的 IDE,让它通过 stdio 运行
openclaw acp。
示例配置(持久化):
openclaw config set gateway.remote.url wss://gateway-host:18789
openclaw config set gateway.remote.token <token>
示例直接运行(不写入配置):
openclaw acp --url wss://gateway-host:18789 --token <token>
# preferred for local process safety
openclaw acp --url wss://gateway-host:18789 --token-file ~/.openclaw/gateway.token
选择智能体
ACP 不会直接选择智能体。它按 Gateway 网关会话键路由。
使用智能体作用域会话键来定位特定智能体:
openclaw acp --session agent:main:main
openclaw acp --session agent:design:main
openclaw acp --session agent:qa:bug-123
每个 ACP 会话都会映射到单个 Gateway 网关会话键。一个智能体可以有多个会话;除非你覆盖键或标签,否则 ACP 默认使用隔离的 acp:<uuid> 会话。
桥接模式不支持每会话 mcpServers。如果 ACP 客户端在 newSession 或 loadSession 期间发送它们,桥接会返回清晰错误,而不是静默忽略。
如果你希望 ACPX 支撑的会话看到 OpenClaw 插件工具,或 cron 等选定的内置工具,请启用 gateway 侧 ACPX MCP 桥接,而不是尝试传递每会话 mcpServers。参见 ACP Agents 和 OpenClaw 工具 MCP 桥接。
从 acpx 使用(Codex、Claude、其他 ACP 客户端)
如果你希望 Codex 或 Claude Code 等编码智能体通过 ACP 与你的 OpenClaw bot 对话,请使用 acpx 及其内置的 openclaw 目标。
典型流程:
- 运行 Gateway 网关,并确保 ACP 桥接可以访问它。
- 将
acpx openclaw指向openclaw acp。 - 定位你希望编码智能体使用的 OpenClaw 会话键。
示例:
# One-shot request into your default OpenClaw ACP session
acpx openclaw exec "Summarize the active OpenClaw session state."
# Persistent named session for follow-up turns
acpx openclaw sessions ensure --name codex-bridge
acpx openclaw -s codex-bridge --cwd /path/to/repo \
"Ask my OpenClaw work agent for recent context relevant to this repo."
如果你希望 acpx openclaw 每次都定位到特定 Gateway 网关和会话键,请在 ~/.acpx/config.json 中覆盖 openclaw 智能体命令:
{
"agents": {
"openclaw": {
"command": "env OPENCLAW_HIDE_BANNER=1 OPENCLAW_SUPPRESS_NOTES=1 openclaw acp --url ws://127.0.0.1:18789 --token-file ~/.openclaw/gateway.token --session agent:main:main"
}
}
}
对于 repo 本地的 OpenClaw checkout,请使用直接 CLI 入口点,而不是 dev runner,这样 ACP 流会保持干净。例如:
env OPENCLAW_HIDE_BANNER=1 OPENCLAW_SUPPRESS_NOTES=1 node openclaw.mjs acp ...
这是让 Codex、Claude Code 或另一个支持 ACP 的客户端从 OpenClaw 智能体拉取上下文信息,而无需抓取终端的最简单方式。
Zed 编辑器设置
在 ~/.config/zed/settings.json 中添加自定义 ACP 智能体(或使用 Zed 的 Settings UI):
{
"agent_servers": {
"OpenClaw ACP": {
"type": "custom",
"command": "openclaw",
"args": ["acp"],
"env": {}
}
}
}
要指定特定的 Gateway 网关或智能体:
{
"agent_servers": {
"OpenClaw ACP": {
"type": "custom",
"command": "openclaw",
"args": [
"acp",
"--url",
"wss://gateway-host:18789",
"--token",
"<token>",
"--session",
"agent:design:main"
],
"env": {}
}
}
}
在 Zed 中,打开智能体面板并选择 “OpenClaw ACP” 来启动一个线程。
会话映射
默认情况下,ACP 会话会获得一个带有 acp: 前缀的隔离 Gateway 网关会话键。
要复用已知会话,请传入会话键或标签:
--session <key>:使用指定的 Gateway 网关会话键。--session-label <label>:按标签解析现有会话。--reset-session:为该键生成一个新的会话 ID(相同键,新的对话记录)。
如果你的 ACP 客户端支持元数据,可以按会话覆盖:
{
"_meta": {
"sessionKey": "agent:main:main",
"sessionLabel": "support inbox",
"resetSession": true
}
}
在 /concepts/session 了解更多会话键信息。
选项
--url <url>:Gateway 网关 WebSocket URL(配置时默认使用 gateway.remote.url)。--token <token>:Gateway 网关认证令牌。--token-file <path>:从文件读取 Gateway 网关认证令牌。--password <password>:Gateway 网关认证密码。--password-file <path>:从文件读取 Gateway 网关认证密码。--session <key>:默认会话键。--session-label <label>:要解析的默认会话标签。--require-existing:如果会话键/标签不存在,则失败。--reset-session:首次使用前重置会话键。--no-prefix-cwd:不要在提示前添加工作目录前缀。--provenance <off|meta|meta+receipt>:包含 ACP 来源元数据或回执。--verbose, -v:向 stderr 输出详细日志。
安全提示:
- 在某些系统上,
--token和--password可能会显示在本地进程列表中。 - 优先使用
--token-file/--password-file或环境变量(OPENCLAW_GATEWAY_TOKEN、OPENCLAW_GATEWAY_PASSWORD)。 - Gateway 网关认证解析遵循其他 Gateway 网关客户端使用的共享契约:
- 本地模式:env(
OPENCLAW_GATEWAY_*)->gateway.auth.*-> 仅当gateway.auth.*未设置时回退到gateway.remote.*(已配置但未解析的本地 SecretRefs 会安全失败) - 远程模式:
gateway.remote.*,并按远程优先级规则使用 env/config 回退 --url可安全覆盖,并且不会复用隐式配置/env 凭证;请传入显式--token/--password(或文件变体)
- 本地模式:env(
- ACP 运行时后端子进程会收到
OPENCLAW_SHELL=acp,可用于特定上下文的 shell/profile 规则。 openclaw acp client会在生成的桥接进程上设置OPENCLAW_SHELL=acp-client。
acp client 选项
--cwd <dir>:ACP 会话的工作目录。--server <command>:ACP 服务器命令(默认:openclaw)。--server-args <args...>:传递给 ACP 服务器的额外参数。--server-verbose:启用 ACP 服务器上的详细日志。--verbose, -v:详细客户端日志。