acp
运行与 OpenClaw Gateway 通信的 ACP(代理客户端协议,Agent Client Protocol)桥接器。
此命令通过 stdio 与 IDE 进行 ACP 通信,并通过 WebSocket 将提示转发到 Gateway。 它保持 ACP 会话映射到 Gateway 会话密钥。
用法
openclaw acp
# 远程 Gateway
openclaw acp --url wss://gateway-host:18789 --token <token>
# 附加到现有会话密钥
openclaw acp --session agent:main:main
# 通过标签附加(必须已存在)
openclaw acp --session-label "support inbox"
# 在第一个提示之前重置会话密钥
openclaw acp --session agent:main:main --reset-session
ACP 客户端(调试)
使用内置的 ACP 客户端在没有 IDE 的情况下对桥接器进行完整性检查。 它会生成 ACP 桥接器并允许您交互式地输入提示。
openclaw acp client
# 将生成的桥接器指向远程 Gateway
openclaw acp client --server-args --url wss://gateway-host:18789 --token <token>
# 覆盖服务器命令(默认:openclaw)
openclaw acp client --server "node" --server-args openclaw.mjs acp --url ws://127.0.0.1:19001
如何使用
当 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>
选择代理(Selecting agents)
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> 会话。
Zed 编辑器设置
在 ~/.config/zed/settings.json 中添加自定义 ACP 代理(或使用 Zed 的设置 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 中,打开 Agent 面板并选择 "OpenClaw ACP" 以开始线程。
会话映射(Session mapping)
默认情况下,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 认证令牌。
- --password <password>:Gateway 认证密码。
- --session <key>:默认会话密钥。
- --session-label <label>:要解析的默认会话标签。
- --require-existing:如果会话密钥/标签不存在则失败。
- --reset-session:在首次使用前重置会话密钥。
- --no-prefix-cwd:不在提示前添加工作目录前缀。
- --verbose, -v:详细日志输出到 stderr。
acp client 选项
- --cwd <dir>:ACP 会话的工作目录。
- --server <command>:ACP 服务器命令(默认:openclaw)。
- --server-args <args...>:传递给 ACP 服务器的额外参数。
- --server-verbose:在 ACP 服务器上启用详细日志。
- --verbose, -v:详细客户端日志。