+ {CLI_PACKAGE_NAME} is a real command-line tool, not a
+ wrapper around this website. It keeps your diagrams in{" "}
+ ~/.sketchi/diagrams, does its authoring, export, and
+ recovery work offline, and speaks --output json on
+ every command so an agent can drive it.
+
+ {option.command}
+
+ {option.detail}
+Then ask for a diagram:
+
+ {CLI_EXAMPLE_COMMAND}
+
+ Requires {CLI_NODE_REQUIREMENT}.
+Sketchi turns a plain-language prompt into a clean, editable diagram, - brand logos and all. You can use it two ways. + brand logos and all. You can use it three ways.
You describe it. Sketchi structures and validates the request before drawing, so the result stays consistent, not a best-guess sketch. - What differs between the two paths is where that happens and who + What differs between the three paths is where that happens and who keeps the file.
-You, in the playground
The terminal
+sketchi generate --prompt "…".
+
+ Your machine keeps the file, under{" "}
+ ~/.sketchi/diagrams. Install it{" "}
+ below.
+
+ {CLI_PACKAGE_NAME} is published on npm and authors
+ diagrams from your shell. Records live under{" "}
+ ~/.sketchi/diagrams with the canonical document, the
+ Excalidraw artifact, and every prior revision, so nothing you make
+ is trapped in a browser tab.
+
+ {option.command}
+
+ {option.detail}
+Requires {CLI_NODE_REQUIREMENT}.
+ +generate
+ create, edit, patch
+ show, list, restore
+ export
+ share, pull
+ --output json for a stable result
+ envelope. create, edit, and{" "}
+ patch take their JSON noninteractively through{" "}
+ --json or --file; generate{" "}
+ takes --prompt; and export --dest -{" "}
+ streams raw bytes to stdout. Shell completions ship for zsh, bash,
+ and fish.
+
+ @@ -155,6 +280,13 @@ export function DocsView({
{CLI_PACKAGE_NAME} on npm. See{" "}
+ the CLI section for install and commands.
+