Files
openclaw/docs/cli/nodes.md
T

67 lines
2.1 KiB
Markdown
Raw Normal View History

2026-01-15 06:12:54 +00:00
---
summary: "CLI reference for `openclaw nodes` (status, pairing, invoke, camera/canvas/screen)"
2026-01-15 06:12:54 +00:00
read_when:
- Youre managing paired nodes (cameras, screen, canvas)
- You need to approve requests or invoke node commands
2026-01-31 16:04:03 -05:00
title: "nodes"
2026-01-15 06:12:54 +00:00
---
2026-01-30 03:15:10 +01:00
# `openclaw nodes`
2026-01-15 06:12:54 +00:00
Manage paired nodes (devices) and invoke node capabilities.
Related:
2026-01-31 21:13:13 +09:00
2026-01-15 06:12:54 +00:00
- Nodes overview: [Nodes](/nodes)
- Camera: [Camera nodes](/nodes/camera)
- Images: [Image nodes](/nodes/images)
2026-01-22 23:07:58 +00:00
Common options:
2026-01-31 21:13:13 +09:00
2026-01-22 23:07:58 +00:00
- `--url`, `--token`, `--timeout`, `--json`
2026-01-15 06:12:54 +00:00
## Common commands
```bash
2026-01-30 03:15:10 +01:00
openclaw nodes list
openclaw nodes list --connected
openclaw nodes list --last-connected 24h
openclaw nodes pending
openclaw nodes approve <requestId>
openclaw nodes reject <requestId>
openclaw nodes rename --node <id|name|ip> --name <displayName>
2026-01-30 03:15:10 +01:00
openclaw nodes status
openclaw nodes status --connected
openclaw 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-04-04 11:22:00 +01:00
Approval note:
- `openclaw nodes pending` only needs pairing scope.
- `openclaw nodes approve <requestId>` inherits extra scope requirements from the
pending request:
- commandless request: pairing only
- non-exec node commands: pairing + write
- `system.run` / `system.run.prepare` / `system.which`: pairing + admin
2026-03-30 00:40:41 +01:00
## Invoke
2026-01-15 06:12:54 +00:00
```bash
2026-01-30 03:15:10 +01:00
openclaw nodes invoke --node <id|name|ip> --command <command> --params <json>
2026-01-15 06:12:54 +00:00
```
2026-01-21 20:24:12 +00:00
2026-01-22 23:07:58 +00:00
Invoke flags:
2026-01-31 21:13:13 +09:00
2026-01-22 23:07:58 +00:00
- `--params <json>`: JSON object string (default `{}`).
- `--invoke-timeout <ms>`: node invoke timeout (default `15000`).
- `--idempotency-key <key>`: optional idempotency key.
2026-03-30 00:40:41 +01:00
- `system.run` and `system.run.prepare` are blocked here; use the `exec` tool with `host=node` for shell execution.
2026-01-22 23:07:58 +00:00
2026-03-30 00:40:41 +01:00
For shell execution on a node, use the `exec` tool with `host=node` instead of `openclaw nodes run`.
The `nodes` CLI is now capability-focused: direct RPC via `nodes invoke`, plus pairing, camera,
screen, location, canvas, and notifications.