sketchi 0.2.0 → 0.4.0

package/README.md

@@ -38,7 +38,31 @@ sketchi --version
 
 Sketchi requires Node.js 24.13.0 or newer.
 
-## Create and work with a diagram
+## Generate a PNG from a prompt
+
+`generate` sends one prompt to Sketchi's public generation API, validates and
+persists the editable result, then writes `<generated-id>.png` in the current
+directory:
+
+```sh
+sketchi generate --prompt "Map release approval with pass and revise branches"
+```
+
+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 "Map release approval" --dest - > release.png
+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.
+
+## Create and work with a diagram offline
 
 Create a canonical flowchart from inline JSON:
 
@@ -54,9 +78,20 @@ sketchi show release-flow
 
 sketchi edit release-flow --json '{"type":"flowchart","spec":{"id":"release-flow","title":"Release approval revised","nodes":[{"id":"start","label":"Change proposed","kind":"start"},{"id":"review","label":"Review complete evidence","kind":"process"},{"id":"end","label":"Release approved","kind":"end"}],"edges":[{"source":"start","target":"review"},{"source":"review","target":"end"}]}}'
 
+sketchi patch release-flow --json '{"operations":[{"op":"setStyle","selector":{"nodeIds":["review"]},"style":{"fillColor":"#dbeafe","strokeColor":"#2563eb"}}]}'
+
 sketchi list
 ```
 
+`patch` reuses Sketchi's semantic selectors and operations (`setStyle`,
+`setDefaultStyle`, `setShape`, `translate`, `replaceText`, and
+`rerouteEdges`) without exposing raw Excalidraw mutation. It is fully offline,
+preserves the prior full revision, retains `document.json` unchanged as
+provenance, makes `scene.json` authoritative, and removes any stale stored PNG.
+Patched records report `authority: "patched"` and
+`documentAuthoritative: false`; restore a canonical revision before using
+`edit` again.
+
 Export the stored editable artifact:
 
 ```sh
@@ -81,20 +116,6 @@ only artifact bytes to stdout; a PNG file export also includes one generic
 inline-Markdown display hint for calling agents. Its destination is enclosed
 in CommonMark angle brackets so local paths containing spaces remain valid.
 
-## Generate from a prompt
-
-`generate` sends one prompt to Sketchi's public generation API, validates the
-result server-side, and commits the same local record shape used by `create`:
-
-```sh
-sketchi generate --prompt "Map release approval with pass and revise branches"
-sketchi generate --prompt "Organize launch readiness" --type mindmap --output json
-```
-
-It requires no API key, token, account, or login. `generate`, `share`, and
-`pull` are the CLI's three explicit network commands; each makes one HTTPS
-request.
-
 ## Share, pull, and restore browser edits
 
 Create an immutable encrypted Excalidraw snapshot link from the record's current
@@ -201,9 +222,10 @@ source ~/.sketchi/completions/sketchi.fish
 
 ## For AI agents
 
-The six deterministic commands—`create`, `show`, `edit`, `list`, `export`, and
-`restore`—are fully offline and require no credentials, account, browser, model,
-or MCP server. Those six commands never send stored records to a provider.
+The seven deterministic commands—`create`, `patch`, `show`, `edit`, `list`,
+`export`, and `restore`—are fully offline and require no credentials, account,
+browser, model, or MCP server. Those seven commands never send stored records
+to a provider.
 Agents can use
 `--output json`, complete noninteractive input through `--json` or `--file`, and
 raw artifact output through `export --dest -` without prompts.
@@ -227,7 +249,9 @@ availability details.
 
 ```sh
 sketchi --help
+sketchi docs
 sketchi create --help
+sketchi patch --help
 sketchi generate --help
 sketchi share --help
 sketchi pull --help

package/THIRD_PARTY_NOTICES

@@ -70,6 +70,7 @@ Excalifont
 -----------
 
 Copyright (c) 2024 by Excalidraw. All rights reserved.
+Trademark: Excalifont is a trademark of Excalidraw.
 Manufacturer and designer: Your Own Font Foundry (Virgil); Jan Filipek /
 DizajnDesign (Excalifont, modifications)