2.6 KiB
summary, read_when
| summary | read_when | ||
|---|---|---|---|
| CLI reference for `clawdbot node` (headless node host) |
|
clawdbot node
Run a headless node host that connects to the Gateway WebSocket and exposes
system.run / system.which on this machine.
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:
- 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 per‑agent allowlists on the node host, so you can keep command access scoped and explicit.
Run (foreground)
clawdbot node run --host <gateway-host> --port 18789
Options:
--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
Service (background)
Install a headless node host as a user service.
clawdbot node install --host <gateway-host> --port 18789
Options:
--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 (nodeorbun)--force: Reinstall/overwrite if already installed
Manage the service:
clawdbot node status
clawdbot node run
clawdbot node stop
clawdbot node restart
clawdbot node uninstall
Service commands accept --json for machine-readable output.
Pairing
The first connection creates a pending node pair request on the Gateway. Approve it via:
clawdbot nodes pending
clawdbot nodes approve <requestId>
The node host stores its node id, token, display name, and gateway connection info in
~/.clawdbot/node.json.
Exec approvals
system.run is gated by local exec approvals:
~/.clawdbot/exec-approvals.json- Exec approvals
clawdbot approvals --node <id|name|ip>(edit from the Gateway)