Files

113 lines
3.0 KiB
Markdown
Raw Permalink Normal View History

---
2026-01-30 03:15:10 +01:00
summary: "CLI reference for `openclaw node` (headless node host)"
read_when:
- Running the headless node host
- Pairing a non-macOS node for system.run
title: "node"
---
2026-01-30 03:15:10 +01:00
# `openclaw node`
Run a **headless node host** that connects to the Gateway WebSocket and exposes
`system.run` / `system.which` on this machine.
2026-01-18 07:58:59 +00:00
## Why use a node host?
Use a node host when you want agents to **run commands on other machines** in your
network without installing a full macOS companion app there.
Common use cases:
2026-01-31 21:13:13 +09:00
2026-01-18 07:58:59 +00:00
- Run commands on remote Linux/Windows boxes (build servers, lab machines, NAS).
- Keep exec **sandboxed** on the gateway, but delegate approved runs to other hosts.
- Provide a lightweight, headless execution target for automation or CI nodes.
Execution is still guarded by **exec approvals** and peragent allowlists on the
node host, so you can keep command access scoped and explicit.
2026-01-24 04:19:43 +00:00
## Browser proxy (zero-config)
Node hosts automatically advertise a browser proxy if `browser.enabled` is not
disabled on the node. This lets the agent use browser automation on that node
without extra configuration.
Disable it on the node if needed:
```json5
{
nodeHost: {
browserProxy: {
2026-01-31 21:13:13 +09:00
enabled: false,
},
},
2026-01-24 04:19:43 +00:00
}
```
2026-01-21 16:48:31 +00:00
## Run (foreground)
```bash
2026-01-30 03:15:10 +01:00
openclaw node run --host <gateway-host> --port 18789
```
Options:
2026-01-31 21:13:13 +09:00
- `--host <host>`: Gateway WebSocket host (default: `127.0.0.1`)
- `--port <port>`: Gateway WebSocket port (default: `18789`)
- `--tls`: Use TLS for the gateway connection
- `--tls-fingerprint <sha256>`: Expected TLS certificate fingerprint (sha256)
- `--node-id <id>`: Override node id (clears pairing token)
- `--display-name <name>`: Override the node display name
2026-01-18 15:33:22 +00:00
## Service (background)
Install a headless node host as a user service.
```bash
2026-01-30 03:15:10 +01:00
openclaw node install --host <gateway-host> --port 18789
```
Options:
2026-01-31 21:13:13 +09:00
- `--host <host>`: Gateway WebSocket host (default: `127.0.0.1`)
- `--port <port>`: Gateway WebSocket port (default: `18789`)
- `--tls`: Use TLS for the gateway connection
- `--tls-fingerprint <sha256>`: Expected TLS certificate fingerprint (sha256)
- `--node-id <id>`: Override node id (clears pairing token)
- `--display-name <name>`: Override the node display name
- `--runtime <runtime>`: Service runtime (`node` or `bun`)
- `--force`: Reinstall/overwrite if already installed
Manage the service:
```bash
2026-01-30 03:15:10 +01:00
openclaw node status
openclaw node stop
openclaw node restart
openclaw node uninstall
```
2026-01-30 03:15:10 +01:00
Use `openclaw node run` for a foreground node host (no service).
2026-01-22 23:19:55 +00:00
Service commands accept `--json` for machine-readable output.
## Pairing
The first connection creates a pending node pair request on the Gateway.
Approve it via:
```bash
2026-01-30 03:15:10 +01:00
openclaw nodes pending
openclaw nodes approve <requestId>
```
The node host stores its node id, token, display name, and gateway connection info in
2026-01-30 03:15:10 +01:00
`~/.openclaw/node.json`.
## Exec approvals
`system.run` is gated by local exec approvals:
2026-01-30 03:15:10 +01:00
- `~/.openclaw/exec-approvals.json`
- [Exec approvals](/tools/exec-approvals)
2026-01-30 03:15:10 +01:00
- `openclaw approvals --node <id|name|ip>` (edit from the Gateway)