sketchi 0.4.3 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -2
- package/chunks/869.e6d2df13ddd97607.js +1 -0
- package/package.json +1 -1
- package/sketchi.js +63 -58
- package/chunks/869.cacc093c4bbc5a04.js +0 -1
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
<p align="center">
|
|
8
8
|
<strong>Typed, deterministic diagrams from your terminal.</strong><br />
|
|
9
|
-
Create, inspect, revise, and export local flowcharts and
|
|
9
|
+
Create, inspect, revise, and export local flowcharts, mindmaps, and sequence diagrams—or turn one prompt into validated, editable Excalidraw.
|
|
10
10
|
</p>
|
|
11
11
|
|
|
12
12
|
<p align="center">
|
|
@@ -53,7 +53,7 @@ sketchi generate --prompt "Map release approval with pass and revise branches"
|
|
|
53
53
|
|
|
54
54
|
With no `--prompt`, Sketchi opens a short wizard only when both standard input
|
|
55
55
|
and standard output are human terminals, output is text, and CI is absent. It
|
|
56
|
-
asks for prompt text, flowchart (the default)
|
|
56
|
+
asks for prompt text, flowchart (the default), mind map, or sequence diagram, and where to save the
|
|
57
57
|
PNG. The choices are the current directory, a `diagrams/` folder under exactly
|
|
58
58
|
the directory where Sketchi was run, or a custom path with the same semantics as
|
|
59
59
|
`--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
|
|
|
64
64
|
Scripts, pipes, redirected streams, CI, and `--output json` never prompt or
|
|
65
65
|
block. They must pass `--prompt`; omitting it retains the deterministic usage
|
|
66
66
|
error. Passing `--prompt` is always direct and noninteractive.
|
|
67
|
+
Without `--type`, the generation model selects flowchart, mindmap, or sequence
|
|
68
|
+
from the request. An explicit supported `--type` remains authoritative.
|
|
69
|
+
Explicit ER, architecture, swimlane, and state-machine requests return a typed
|
|
70
|
+
unsupported-type error instead of being coerced into a flowchart.
|
|
67
71
|
|
|
68
72
|
The PNG is rendered locally from the returned validated artifacts and is not
|
|
69
73
|
written back into the record. Choose another artifact or destination explicitly:
|
|
70
74
|
|
|
71
75
|
```sh
|
|
72
76
|
sketchi generate --prompt "Organize launch readiness" --type mindmap --format excalidraw --dest launch.excalidraw
|
|
77
|
+
|
|
78
|
+
sketchi generate --prompt "Show Browser calling API and API returning success" --type sequence --dest request-sequence.png
|
|
73
79
|
sketchi generate --prompt "Map release approval" --dest - > release.png
|
|
74
80
|
sketchi generate --prompt "Map release approval" --output json
|
|
75
81
|
```
|