文档
节点
节点是一个配套设备(macOS/iOS/Android/无头),它以 role: "node" 连接到 Gateway 网关 WebSocket(与操作员相同的端口),并通过 node.invoke 暴露命令接口(例如 canvas.*、camera.*、system.*)。协议详情:Gateway 网关协议。
旧版传输:Bridge 协议(TCP JSONL;当前节点已弃用/移除)。
macOS 也可以在节点模式下运行:菜单栏应用连接到 Gateway 网关的 WS 服务器,并将其本地 canvas/camera 命令作为节点暴露(因此 openclaw nodes … 可以针对这台 Mac 工作)。
注意事项:
- 节点是外围设备,不是 Gateway 网关。它们不运行 Gateway 网关服务。
- Telegram/WhatsApp 等消息落在 Gateway 网关上,而不是节点上。
配对 + 状态
WS 节点使用设备配对。 节点在 connect 期间呈现设备身份;Gateway 网关
为 role: node 创建设备配对请求。通过设备 CLI(或 UI)批准。
快速 CLI:
“`bash theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
openclaw devices list
openclaw devices approve
openclaw devices reject
openclaw nodes status
openclaw nodes describe –node
注意事项:
* 当节点的设备配对角色包含 `node` 时,`nodes status` 将节点标记为**已配对**。
* `node.pair.*`(CLI:`openclaw nodes pending/approve/reject`)是一个单独的 Gateway 网关拥有的
节点配对存储;它**不会**限制 WS `connect` 握手。
## 远程节点主机(system.run)
当你的 Gateway 网关在一台机器上运行而你希望命令
在另一台机器上执行时,使用**节点主机**。模型仍然与 **Gateway 网关**通信;当选择 `host=node` 时,Gateway 网关
将 `exec` 调用转发到**节点主机**。
### 什么在哪里运行
* **Gateway 网关主机**:接收消息,运行模型,路由工具调用。
* **节点主机**:在节点机器上执行 `system.run`/`system.which`。
* **批准**:通过 `~/.openclaw/exec-approvals.json` 在节点主机上执行。
### 启动节点主机(前台)
在节点机器上:
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw node run --host <gateway-host> --port 18789 --display-name "Build Node"
通过 SSH 隧道访问远程 Gateway 网关(loopback 绑定)
如果 Gateway 网关绑定到 loopback(gateway.bind=loopback,本地模式下的默认值),
远程节点主机无法直接连接。创建 SSH 隧道并将
节点主机指向隧道的本地端。
示例(节点主机 -> Gateway 网关主机):
“`bash theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
终端 A(保持运行):转发本地 18790 -> Gateway 网关 127.0.0.1:18789
ssh -N -L 18790:127.0.0.1:18789 user@gateway-host
终端 B:导出 Gateway 网关令牌并通过隧道连接
export OPENCLAW_GATEWAY_TOKEN=””
openclaw node run –host 127.0.0.1 –port 18790 –display-name “Build Node”
注意事项:
* 令牌是 Gateway 网关配置中的 `gateway.auth.token`(Gateway 网关主机上的 `~/.openclaw/openclaw.json`)。
* `openclaw node run` 读取 `OPENCLAW_GATEWAY_TOKEN` 进行认证。
### 启动节点主机(服务)
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw node install --host <gateway-host> --port 18789 --display-name "Build Node"
openclaw node restart
配对 + 命名
在 Gateway 网关主机上:
“`bash theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
openclaw nodes pending
openclaw nodes approve
openclaw nodes list
命名选项:
* 在 `openclaw node run` / `openclaw node install` 上使用 `--display-name`(持久化在节点上的 `~/.openclaw/node.json` 中)。
* `openclaw nodes rename --node <id|name|ip> --name "Build Node"`(Gateway 网关覆盖)。
### 将命令加入允许列表
Exec 批准是**每个节点主机**的。从 Gateway 网关添加允许列表条目:
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw approvals allowlist add --node <id|name|ip> "/usr/bin/uname"
openclaw approvals allowlist add --node <id|name|ip> "/usr/bin/sw_vers"
批准存储在节点主机的 ~/.openclaw/exec-approvals.json 中。
将 exec 指向节点
配置默认值(Gateway 网关配置):
“`bash theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
openclaw config set tools.exec.host node
openclaw config set tools.exec.security allowlist
openclaw config set tools.exec.node “”
或按会话:
/exec host=node security=allowlist node=
设置后,任何带有 `host=node` 的 `exec` 调用都会在节点主机上运行(受
节点允许列表/批准约束)。
相关:
* [节点主机 CLI](/cli/node)
* [Exec 工具](/tools/exec)
* [Exec 批准](/tools/exec-approvals)
## 调用命令
低级(原始 RPC):
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw nodes invoke --node <idOrNameOrIp> --command canvas.eval --params '{"javaScript":"location.href"}'
对于常见的”给智能体一个 MEDIA 附件”工作流,存在更高级的辅助工具。
截图(canvas 快照)
如果节点正在显示 Canvas(WebView),canvas.snapshot 返回 { format, base64 }。
CLI 辅助工具(写入临时文件并打印 MEDIA:<path>):
“`bash theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
openclaw nodes canvas snapshot –node –format png
openclaw nodes canvas snapshot –node –format jpg –max-width 1200 –quality 0.9
### Canvas 控制
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw nodes canvas present --node <idOrNameOrIp> --target https://example.com
openclaw nodes canvas hide --node <idOrNameOrIp>
openclaw nodes canvas navigate https://example.com --node <idOrNameOrIp>
openclaw nodes canvas eval --node <idOrNameOrIp> --js "document.title"
注意事项:
canvas present接受 URL 或本地文件路径(--target),以及可选的--x/--y/--width/--height用于定位。canvas eval接受内联 JS(--js)或位置参数。
A2UI(Canvas)
“`bash theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
openclaw nodes canvas a2ui push –node –text “Hello”
openclaw nodes canvas a2ui push –node –jsonl ./payload.jsonl
openclaw nodes canvas a2ui reset –node
注意事项:
* 仅支持 A2UI v0.8 JSONL(v0.9/createSurface 被拒绝)。
## 照片 + 视频(节点相机)
照片(`jpg`):
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw nodes camera list --node <idOrNameOrIp>
openclaw nodes camera snap --node <idOrNameOrIp> # 默认:两个朝向(2 个 MEDIA 行)
openclaw nodes camera snap --node <idOrNameOrIp> --facing front
视频片段(mp4):
“`bash theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
openclaw nodes camera clip –node –duration 10s
openclaw nodes camera clip –node –duration 3000 –no-audio
注意事项:
* 节点必须处于**前台**才能使用 `canvas.*` 和 `camera.*`(后台调用返回 `NODE_BACKGROUND_UNAVAILABLE`)。
* 片段时长被限制(当前 `<= 60s`)以避免过大的 base64 负载。
* Android 会在可能时提示 `CAMERA`/`RECORD_AUDIO` 权限;权限被拒绝会以 `*_PERMISSION_REQUIRED` 失败。
## 屏幕录制(节点)
节点暴露 `screen.record`(mp4)。示例:
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw nodes screen record --node <idOrNameOrIp> --duration 10s --fps 10
openclaw nodes screen record --node <idOrNameOrIp> --duration 10s --fps 10 --no-audio
注意事项:
screen.record需要节点应用处于前台。- Android 会在录制前显示系统屏幕捕获提示。
- 屏幕录制被限制为
<= 60s。 --no-audio禁用麦克风捕获(iOS/Android 支持;macOS 使用系统捕获音频)。- 当有多个屏幕可用时,使用
--screen <index>选择显示器。
位置(节点)
当在设置中启用位置时,节点暴露 location.get。
CLI 辅助工具:
“`bash theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
openclaw nodes location get –node
openclaw nodes location get –node –accuracy precise –max-age 15000 –location-timeout 10000
注意事项:
* 位置**默认关闭**。
* "始终"需要系统权限;后台获取是尽力而为的。
* 响应包括纬度/经度、精度(米)和时间戳。
## 短信(Android 节点)
当用户授予 **SMS** 权限且设备支持电话功能时,Android 节点可以暴露 `sms.send`。
低级调用:
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw nodes invoke --node <idOrNameOrIp> --command sms.send --params '{"to":"+15555550123","message":"Hello from OpenClaw"}'
注意事项:
- 在能力被广播之前,必须在 Android 设备上接受权限提示。
- 没有电话功能的纯 Wi-Fi 设备不会广播
sms.send。
系统命令(节点主机 / mac 节点)
macOS 节点暴露 system.run、system.notify 和 system.execApprovals.get/set。
无头节点主机暴露 system.run、system.which 和 system.execApprovals.get/set。
示例:
“`bash theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
openclaw nodes run –node — echo “Hello from mac node”
openclaw nodes notify –node –title “Ping” –body “Gateway ready”
注意事项:
* `system.run` 在负载中返回 stdout/stderr/退出码。
* `system.notify` 遵守 macOS 应用上的通知权限状态。
* `system.run` 支持 `--cwd`、`--env KEY=VAL`、`--command-timeout` 和 `--needs-screen-recording`。
* `system.notify` 支持 `--priority <passive|active|timeSensitive>` 和 `--delivery <system|overlay|auto>`。
* macOS 节点会丢弃 `PATH` 覆盖;无头节点主机仅在 `PATH` 前置到节点主机 PATH 时才接受它。
* 在 macOS 节点模式下,`system.run` 受 macOS 应用中的 exec 批准限制(设置 → Exec 批准)。
Ask/allowlist/full 的行为与无头节点主机相同;被拒绝的提示返回 `SYSTEM_RUN_DENIED`。
* 在无头节点主机上,`system.run` 受 exec 批准限制(`~/.openclaw/exec-approvals.json`)。
## Exec 节点绑定
当有多个节点可用时,你可以将 exec 绑定到特定节点。
这设置了 `exec host=node` 的默认节点(可以按智能体覆盖)。
全局默认:
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw config set tools.exec.node "node-id-or-name"
按智能体覆盖:
“`bash theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
openclaw config get agents.list
openclaw config set agents.list[0].tools.exec.node “node-id-or-name”
取消设置以允许任何节点:
```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw config unset tools.exec.node
openclaw config unset agents.list[0].tools.exec.node
权限映射
节点可能在 node.list / node.describe 中包含 permissions 映射,按权限名称(例如 screenRecording、accessibility)键入,值为布尔值(true = 已授予)。
无头节点主机(跨平台)
OpenClaw 可以运行无头节点主机(无 UI),它连接到 Gateway 网关
WebSocket 并暴露 system.run / system.which。这在 Linux/Windows
上或在服务器旁运行最小节点时很有用。
启动它:
bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw node run --host <gateway-host> --port 18789
注意事项:
- 仍然需要配对(Gateway 网关会显示节点批准提示)。
- 节点主机将其节点 id、令牌、显示名称和 Gateway 网关连接信息存储在
~/.openclaw/node.json中。 - Exec 批准通过
~/.openclaw/exec-approvals.json在本地执行
(参见 Exec 批准)。 - 在 macOS 上,当配套应用 exec 主机可达时,无头节点主机优先使用它,
如果应用不可用则回退到本地执行。设置OPENCLAW_NODE_EXEC_HOST=app要求
使用应用,或设置OPENCLAW_NODE_EXEC_FALLBACK=0禁用回退。 - 当 Gateway 网关 WS 使用 TLS 时,添加
--tls/--tls-fingerprint。
Mac 节点模式
- macOS 菜单栏应用作为节点连接到 Gateway 网关 WS 服务器(因此
openclaw nodes …可以针对这台 Mac 工作)。 - 在远程模式下,应用为 Gateway 网关端口打开 SSH 隧道并连接到
localhost。