CLI/docs: mention canvas.* alias
This commit is contained in:
@@ -123,6 +123,9 @@ These are values for `node.invoke.command`:
|
|||||||
- `screen.snapshot` with `{ maxWidth?, quality?, format? }`
|
- `screen.snapshot` with `{ maxWidth?, quality?, format? }`
|
||||||
- `screen.setMode` with `{ mode: "canvas" | "web" }`
|
- `screen.setMode` with `{ mode: "canvas" | "web" }`
|
||||||
|
|
||||||
|
Alias:
|
||||||
|
- `canvas.*` is accepted as a synonym for `screen.*` (e.g. `canvas.eval` → `screen.eval`).
|
||||||
|
|
||||||
Result pattern:
|
Result pattern:
|
||||||
- Request is a standard `req/res` with `ok` / `error`.
|
- Request is a standard `req/res` with `ok` / `error`.
|
||||||
- Long operations (loads, streaming drawing, etc.) may also emit `node.event` progress.
|
- Long operations (loads, streaming drawing, etc.) may also emit `node.event` progress.
|
||||||
|
|||||||
@@ -345,7 +345,10 @@ export function registerNodesCli(program: Command) {
|
|||||||
.command("invoke")
|
.command("invoke")
|
||||||
.description("Invoke a command on a paired node")
|
.description("Invoke a command on a paired node")
|
||||||
.requiredOption("--node <idOrNameOrIp>", "Node id, name, or IP")
|
.requiredOption("--node <idOrNameOrIp>", "Node id, name, or IP")
|
||||||
.requiredOption("--command <command>", "Command (e.g. screen.eval)")
|
.requiredOption(
|
||||||
|
"--command <command>",
|
||||||
|
"Command (e.g. screen.eval or canvas.eval)",
|
||||||
|
)
|
||||||
.option("--params <json>", "JSON object string for params", "{}")
|
.option("--params <json>", "JSON object string for params", "{}")
|
||||||
.option(
|
.option(
|
||||||
"--invoke-timeout <ms>",
|
"--invoke-timeout <ms>",
|
||||||
|
|||||||
Reference in New Issue
Block a user