Enhance documentation

enhance-dev canvas inspect

Read the canonical browser URL for a canvas, its exact document version, kind counts, bounds, and next inspection commands.

↓ Markdown

enhance-dev canvas inspect

enhance-dev canvas inspect [options]

Arguments

This command takes no positional arguments.

Options

Option	Required	Default	Meaning
`--canvas-id <string>`	No	None	Canvas id, from `enhance canvas list`.
`--json <json>`	No	None	Complete procedure input as JSON; do not combine it with field flags.
`--canvas <url-or-id>`	Yes, unless `--canvas-id`	None	Pasted canvas URL or UUID. Selection links limit reads and edits to the linked subtree. Required unless `--canvas-id` is given.

Input

This command presents the capability canvas.inspect. It has read effect and none idempotency.

Show complete input JSON Schema

{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["canvasId"]}

Output

This command writes JSON records to standard output. Returns a typed canvas.inspect result from the Enhance API without transport-specific prose.

Show complete output JSON Schema

{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"openUrl":{"type":"string","format":"uri"},"title":{"type":"string","minLength":1},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"nodeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"rootChildCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"bounds":{"anyOf":[{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number","exclusiveMinimum":0},"height":{"type":"number","exclusiveMinimum":0}},"required":["x","y","width","height"],"additionalProperties":false},{"type":"null"}]},"kinds":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"integer","minimum":0,"maximum":9007199254740991}},"next":{"type":"array","items":{"type":"string","minLength":1}}},"required":["canvasId","openUrl","title","version","nodeCount","rootChildCount","bounds","kinds","next"],"additionalProperties":false}

Examples

enhance-dev canvas inspect --canvas <url-or-id>

Show example input

{
 "canvasId": "00000000-0000-4000-8000-000000000010"
}

Show example output

{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "openUrl": "https://example.test/path",
 "title": "x",
 "version": 1,
 "nodeCount": 0,
 "rootChildCount": 0,
 "bounds": {
  "x": 0,
  "y": 0,
  "width": 1,
  "height": 1
 },
 "kinds": {},
 "next": []
}

Exit behaviour

Exit code	Meaning
`0`	The command succeeded.
`1`	The command failed for another reason (`INTERNAL`). A write may have an unknown outcome.
`2`	The command line was malformed. Nothing ran.
`3`	The API refused the input (`BAD_REQUEST`).
`4`	The credential is missing or expired (`UNAUTHORIZED`).
`5`	The API refused the request (`FORBIDDEN`, `NOT_FOUND`, `CONFLICT`, `RATE_LIMITED`).
`6`	A batch finished only in part. Retry with the same `--client-token`.

Versions

Minimum tested versions: Enhance CLI and MCP runtime 0.1.40, plugin 1.0.38, Node.js 24. No older floor is published.