Enhance documentation

enhance-dev canvas document save

Replace a canvas document. A stale base version exits 5 as CONFLICT; read, merge, and retry.

enhance-dev canvas document save

enhance-dev canvas document save [options]

Arguments

This command takes no positional arguments.

Options

Option	Required	Default	Meaning
`--canvas-id <string>`	Yes	None	Canvas id, from `enhance canvas list`.
`--base-version <number>`	Yes	None	Current version from `canvas document get`; a stale value exits 5 with CONFLICT.
`--document [json]`	No	None	Complete opaque JSON object; preserve fields you did not intend to change.
`--screen-ids [values...]`	No	“	Complete replacement manifest of screen UUIDs; omit to detach every screen.
`--json <json>`	No	None	Complete procedure input as JSON; do not combine it with field flags.
`--client-token <uuid>`	No	None	Stable UUID to reuse when retrying the exact same mutation.

Input

This command presents the capability canvas.document.save. It has write effect and single 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)$"},"baseVersion":{"type":"integer","minimum":1,"maximum":9007199254740991},"document":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"screenIds":{"type":"array","items":{"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","baseVersion","document","screenIds"]}

Output

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

Show complete output JSON Schema

{"$schema":"https://json-schema.org/draft/2020-12/schema","oneOf":[{"type":"object","properties":{"outcome":{"type":"string","const":"saved"},"version":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["outcome","version"],"additionalProperties":false},{"type":"object","properties":{"outcome":{"type":"string","const":"conflict"},"version":{"type":"integer","minimum":1,"maximum":9007199254740991},"document":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["outcome","version","document"],"additionalProperties":false}]}

Examples

enhance-dev canvas document save --canvas-id <string> --base-version <number>

Show example input

{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "baseVersion": 1,
 "document": {
  "version": 13,
  "nodes": {
   "root": {
    "id": "root",
    "label": "Canvas",
    "component": "root",
    "labelOrigin": "generated",
    "visible": true,
    "locked": false,
    "styles": {}
   }
  },
  "relationships": {},
  "tombstones": {}
 },
 "screenIds": []
}

Show example output

{
 "outcome": "saved",
 "version": 1
}

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.