enhancedocs
For agentsOpen Enhance ↗
CLI commands / enhance-dev canvas tree

Enhance documentation

enhance-dev canvas tree

List stable node ids, hierarchy, kinds, and world-space boxes for one canvas.

↓ Markdown

enhance-dev canvas tree

enhance-dev canvas tree [options]

Arguments

This command takes no positional arguments.

Options

OptionRequiredDefaultMeaning
--canvas-id <string>NoNoneCanvas id, from enhance canvas list.
--json <json>NoNoneComplete procedure input as JSON; do not combine it with field flags.
--canvas <url-or-id>Yes, unless --canvas-idNonePasted 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.tree. 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.tree 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)$"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"nodes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"label":{"type":"string","maxLength":500},"kind":{"type":"string","minLength":1,"maxLength":100},"parentId":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"childCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"box":{"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"}]},"propertySections":{"type":"array","items":{"type":"string","enum":["position","layout","clip","cornerRadius","blending","typography","nativeControl","textDecoration","fill","outline","textStroke","border","outerShadow","innerShadow","filters","additionalStyles","vector","export","source"]}}},"required":["id","label","kind","parentId","childCount","box","propertySections"],"additionalProperties":false}}},"required":["canvasId","version","nodes"],"additionalProperties":false}

Examples

enhance-dev canvas tree --canvas <url-or-id>
Show example input
{
 "canvasId": "00000000-0000-4000-8000-000000000010"
}
Show example output
{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "version": 1,
 "nodes": []
}

Exit behaviour

Exit codeMeaning
0The command succeeded.
1The command failed for another reason (INTERNAL). A write may have an unknown outcome.
2The command line was malformed. Nothing ran.
3The API refused the input (BAD_REQUEST).
4The credential is missing or expired (UNAUTHORIZED).
5The API refused the request (FORBIDDEN, NOT_FOUND, CONFLICT, RATE_LIMITED).
6A 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.