sketchi 0.12.0 → 0.14.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 +6 -4
- package/chunks/712.07b831238bbfd1b1.js +1 -0
- package/package.json +1 -1
- package/sketchi.js +38 -38
- package/chunks/712.34c01fab259d25d1.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, mindmaps,
|
|
9
|
+
Create, inspect, revise, and export local flowcharts, mindmaps, sequence diagrams, and timelines—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), mind map,
|
|
56
|
+
asks for prompt text, flowchart (the default), mind map, sequence diagram, or timeline, 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,7 +64,7 @@ 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
|
-
`--type` accepts only flowchart, mindmap, or
|
|
67
|
+
`--type` accepts only flowchart, mindmap, sequence, or timeline and is authoritative.
|
|
68
68
|
Without it, the generation model selects one of those from the request; a
|
|
69
69
|
request for any other kind of diagram returns a typed unsupported-type error
|
|
70
70
|
instead of being coerced into a supported one.
|
|
@@ -103,7 +103,7 @@ The endpoint defaults to
|
|
|
103
103
|
`https://playground.sketchi.app/api/v1/canvases/create`; use `--endpoint URL` or
|
|
104
104
|
`SKETCHI_CANVAS_ENDPOINT` only for preview and local testing. The existing
|
|
105
105
|
`create` command remains the separate, strictly offline command for accepted
|
|
106
|
-
flowchart, mindmap, and
|
|
106
|
+
flowchart, mindmap, sequence, and timeline documents.
|
|
107
107
|
|
|
108
108
|
## Create and work with a diagram offline
|
|
109
109
|
|
|
@@ -318,3 +318,5 @@ Source, issue tracking, and architecture documentation live in the
|
|
|
318
318
|
See the [changelog](https://github.com/shpitdev/sketchi/blob/main/apps/cli/CHANGELOG.md)
|
|
319
319
|
for everything that changed, or browse published versions on
|
|
320
320
|
[GitHub Releases](https://github.com/shpitdev/sketchi/releases).
|
|
321
|
+
|
|
322
|
+
Native timelines: use `buildTimeline` (Code Mode) or `generate --type timeline` (CLI). Supply events with unique IDs, labels, and ISO dates at the source's precision (year, month, day, or instant with Z or offset) or explicit numeric order; optional `end` (phase), `kind: "milestone"`, `lane`, `today`, and concise descriptions are preserved. Dates and order cannot be mixed. The renderer spaces events by elapsed time, humanizes dates, and wraps long chronologies. No dependency scheduling.
|