Files
openclaw/docs/cli/nodes.md

69 lines
2.4 KiB
Markdown
Raw Normal View History

2026-01-15 06:12:54 +00:00
---
summary: "CLI reference for `clawdbot nodes` (list/status/approve/invoke, camera/canvas/screen)"
read_when:
- Youre managing paired nodes (cameras, screen, canvas)
- You need to approve requests or invoke node commands
---
# `clawdbot nodes`
Manage paired nodes (devices) and invoke node capabilities.
Related:
- Nodes overview: [Nodes](/nodes)
- Camera: [Camera nodes](/nodes/camera)
- Images: [Image nodes](/nodes/images)
Common options:
- `--url`, `--token`, `--timeout`, `--json`
2026-01-15 06:12:54 +00:00
## Common commands
```bash
clawdbot nodes list
2026-01-21 04:39:11 +00:00
clawdbot nodes list --connected
clawdbot nodes list --last-connected 24h
2026-01-15 06:12:54 +00:00
clawdbot nodes pending
clawdbot nodes approve <requestId>
clawdbot nodes status
2026-01-21 04:39:11 +00:00
clawdbot nodes status --connected
clawdbot nodes status --last-connected 24h
2026-01-15 06:12:54 +00:00
```
`nodes list` prints pending/paired tables. Paired rows include the most recent connect age (Last Connect).
2026-01-21 04:39:11 +00:00
Use `--connected` to only show currently-connected nodes. Use `--last-connected <duration>` to
filter to nodes that connected within a duration (e.g. `24h`, `7d`).
2026-01-15 06:12:54 +00:00
## Invoke / run
```bash
clawdbot nodes invoke --node <id|name|ip> --command <command> --params <json>
clawdbot nodes run --node <id|name|ip> <command...>
2026-01-21 20:24:12 +00:00
clawdbot nodes run --raw "git status"
clawdbot nodes run --agent main --node <id|name|ip> --raw "git status"
2026-01-15 06:12:54 +00:00
```
2026-01-21 20:24:12 +00:00
Invoke flags:
- `--params <json>`: JSON object string (default `{}`).
- `--invoke-timeout <ms>`: node invoke timeout (default `15000`).
- `--idempotency-key <key>`: optional idempotency key.
2026-01-21 20:24:12 +00:00
### Exec-style defaults
`nodes run` mirrors the models exec behavior (defaults + approvals):
- Reads `tools.exec.*` (plus `agents.list[].tools.exec.*` overrides).
- Uses exec approvals (`exec.approval.request`) before invoking `system.run`.
- `--node` can be omitted when `tools.exec.node` is set.
- Requires a node that advertises `system.run` (macOS companion app or headless node host).
2026-01-21 20:24:12 +00:00
Flags:
- `--cwd <path>`: working directory.
- `--env <key=val>`: env override (repeatable).
- `--command-timeout <ms>`: command timeout.
- `--invoke-timeout <ms>`: node invoke timeout (default `30000`).
- `--needs-screen-recording`: require screen recording permission.
2026-01-21 20:24:12 +00:00
- `--raw <command>`: run a shell string (`/bin/sh -lc` or `cmd.exe /c`).
- `--agent <id>`: agent-scoped approvals/allowlists (defaults to configured agent).
- `--ask <off|on-miss|always>`, `--security <deny|allowlist|full>`: overrides.