ACP
运行 ACP 桥以进行 IDE 集成
运行与 OpenClaw 网关对话的 ACP(代理客户端协议)桥。
此命令通过 IDE 的 stdio 讲 ACP 并将提示转发到网关
通过 WebSocket。它将 ACP 会话映射到网关会话密钥。
用法
openclaw acp 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 openclaw acp client --server-args --url wss://gateway-host:18789 --token <token> openclaw acp client --server "node" --server-args openclaw.mjs acp --url ws://127.0.0.1:19001
如何使用这个
当 IDE(或其他客户端)使用代理客户端协议并且您想要时,请使用 ACP
它来驱动 OpenClaw Gateway 会话。
1. 确保网关正在运行(本地或远程)。
2. 配置网关目标(配置或标志)。
3. 将您的 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>
选择代理
ACP 不直接挑选代理商。它通过网关会话密钥进行路由。
使用代理范围的会话密钥来定位特定代理:
openclaw acp --session agent:main:main openclaw acp --session agent:design:main openclaw acp --session agent:qa:bug-123
每个 ACP 会话映射到一个网关会话密钥。一个代理可以有多个代理
sessions; ACP defaults to an isolated ''acp:<uuid>'' session unless you override
键或标签。
Zed 编辑器设置
在 ''~/.config/zed/settings.json'' 中添加自定义 ACP 代理(或使用 Zed 的设置 UI):
{
"agent_servers": {
"OpenClaw ACP": {
"type": "custom",
"command": "openclaw",
"args": ["acp"],
"env": {}
}
}
}要定位特定网关或代理:
{
"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"来启动线程。
会话映射
默认情况下,ACP 会话获取带有 ''acp:'' 前缀的隔离网关会话密钥。
要重用已知会话,请传递会话密钥或标签:
- ''--session <key>'': Use a specific gateway session key.
- ''--session-label <label>'': Resolve an existing session by label.
- ''--reset-session'':为该密钥创建一个新的会话 ID(相同的密钥,新的记录)。
如果您的 ACP 客户端支持元数据,您可以覆盖每个会话:
{
"_meta": {
"sessionKey": "agent:main:main",
"sessionLabel": "support inbox",
"resetSession": true
}
}要了解有关会话密钥的更多信息,请访问 ''/concepts/session''。
选项
- ''--url <url>'': Gateway WebSocket URL (defaults to gateway.remote.url when configured).
- ''--token <token>'': Gateway authentication token.
- ''--password <password>'': Gateway verification password.
- ''--session <key>'': Default session key.
- ''--session-label <label>'': Default session label to resolve.
- ''--require-existing'':如果会话密钥/标签不存在,则失败。
- ''--reset-session'':首次使用前重置会话密钥。
- ''--no-prefix-cwd'':不要在提示前加上工作目录前缀。
- ''--verbose, -v'':详细记录到 stderr。
#
`acp client` 选项
- ''--cwd <dir>'': Working directory for ACP session.
- ''--server <command>'': ACP server command (default: ''openclaw'').
- ''--server-args <args...>'': Extra arguments to pass to ACP server.
- ''--server-verbose'':在 ACP 服务器上启用详细日志记录。
- ''--verbose, -v'':详细的客户端日志记录。