sketchi 0.4.3 → 0.6.0

package/README.md

@@ -6,7 +6,7 @@
 
 <p align="center">
   <strong>Typed, deterministic diagrams from your terminal.</strong><br />
-  Create, inspect, revise, and export local flowcharts and mindmaps—or turn one prompt into validated, editable Excalidraw.
+  Create, inspect, revise, and export local flowcharts, mindmaps, and sequence diagrams—or turn one prompt into validated, editable Excalidraw.
 </p>
 
 <p align="center">
@@ -17,7 +17,7 @@
 
 Sketchi stores canonical diagram documents and authoritative Excalidraw artifacts
 under `~/.sketchi/diagrams`. Its manual and recovery workflows stay local;
-generation and encrypted snapshot exchange are explicit, credential-free network
+generation, Universal Canvas compilation, and encrypted snapshot exchange are explicit, credential-free network
 commands.
 
 ## Install
@@ -53,7 +53,7 @@ sketchi generate --prompt "Map release approval with pass and revise branches"
 
 With no `--prompt`, Sketchi opens a short wizard only when both standard input
 and standard output are human terminals, output is text, and CI is absent. It
-asks for prompt text, flowchart (the default) or mind map, and where to save the
+asks for prompt text, flowchart (the default), mind map, or sequence diagram, and where to save the
 PNG. The choices are the current directory, a `diagrams/` folder under exactly
 the directory where Sketchi was run, or a custom path with the same semantics as
 `--dest`. Sketchi does not inspect Git, and it creates `diagrams/` only after
@@ -64,12 +64,18 @@ that wizard question. Explicit `--format png` may proceed; another format or
 Scripts, pipes, redirected streams, CI, and `--output json` never prompt or
 block. They must pass `--prompt`; omitting it retains the deterministic usage
 error. Passing `--prompt` is always direct and noninteractive.
+Without `--type`, the generation model selects flowchart, mindmap, or sequence
+from the request. An explicit supported `--type` remains authoritative.
+Explicit ER, architecture, swimlane, and state-machine requests return a typed
+unsupported-type error instead of being coerced into a flowchart.
 
 The PNG is rendered locally from the returned validated artifacts and is not
 written back into the record. Choose another artifact or destination explicitly:
 
 ```sh
 sketchi generate --prompt "Organize launch readiness" --type mindmap --format excalidraw --dest launch.excalidraw
+
+sketchi generate --prompt "Show Browser calling API and API returning success" --type sequence --dest request-sequence.png
 sketchi generate --prompt "Map release approval" --dest - > release.png
 sketchi generate --prompt "Map release approval" --output json
 ```
@@ -77,7 +83,27 @@ sketchi generate --prompt "Map release approval" --output json
 `--format` accepts `png`, `excalidraw`, or `scene`; their default names are
 `<id>.png`, `<id>.excalidraw`, and `<id>.scene.json`. With `--dest -`, stdout
 contains artifact bytes only and the text or JSON status envelope moves to
-stderr. Generation, sharing, and pulling are the CLI's three network commands.
+stderr. Generation, Universal Canvas compilation, sharing, and pulling are the CLI's four network commands.
+
+## Build a Universal CanvasSpec
+
+`canvas` sends an already-authored, typed CanvasSpec to Sketchi's public
+create-canvas API, validates the response, preserves the normalized scene and
+editable Excalidraw artifact in the local store, and exports PNG by default:
+
+```sh
+sketchi canvas --file canvas.json --output json
+printf '%s' "$CANVAS_SPEC" | sketchi canvas --file - --format excalidraw --dest canvas.excalidraw
+```
+
+The input is the CanvasSpec object itself—not a request wrapper and not raw
+Excalidraw JSON. The command never prompts, so files and piped stdin are safe for
+agents and scripts. `--format` and `--dest` have the same behavior as `generate`.
+The endpoint defaults to
+`https://playground.sketchi.app/api/v1/canvases/create`; use `--endpoint URL` or
+`SKETCHI_CANVAS_ENDPOINT` only for preview and local testing. The existing
+`create` command remains the separate, strictly offline command for accepted
+flowchart, mindmap, and sequence documents.
 
 ## Create and work with a diagram offline
 
@@ -253,7 +279,7 @@ to human text TTYs and is never enabled by JSON output, pipes, redirects, or CI.
 After exporting PNG to a file, agents can follow the returned hint to display
 that path as an inline Markdown image for the user.
 
-`generate`, `share`, and `pull` are deliberately separate, explicit network
+`generate`, `canvas`, `share`, and `pull` are deliberately separate, explicit network
 commands. They remain credential-free and each makes one HTTPS request. Share
 is randomized by its key and IV; pull depends on remote availability and
 untrusted input, so neither belongs to determinism claims.
@@ -273,6 +299,7 @@ sketchi docs
 sketchi create --help
 sketchi patch --help
 sketchi generate --help
+sketchi canvas --help
 sketchi share --help
 sketchi pull --help
 sketchi restore --help