sketchi 0.3.0 → 0.4.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 +26 -15
- package/THIRD_PARTY_NOTICES +1 -0
- package/chunks/{869.1a34851ea988ddca.js → 869.cacc093c4bbc5a04.js} +1 -1
- package/package.json +1 -1
- package/sketchi.js +53 -37
package/README.md
CHANGED
|
@@ -38,7 +38,31 @@ sketchi --version
|
|
|
38
38
|
|
|
39
39
|
Sketchi requires Node.js 24.13.0 or newer.
|
|
40
40
|
|
|
41
|
-
##
|
|
41
|
+
## Generate a PNG from a prompt
|
|
42
|
+
|
|
43
|
+
`generate` sends one prompt to Sketchi's public generation API, validates and
|
|
44
|
+
persists the editable result, then writes `<generated-id>.png` in the current
|
|
45
|
+
directory:
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
sketchi generate --prompt "Map release approval with pass and revise branches"
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
The PNG is rendered locally from the returned validated artifacts and is not
|
|
52
|
+
written back into the record. Choose another artifact or destination explicitly:
|
|
53
|
+
|
|
54
|
+
```sh
|
|
55
|
+
sketchi generate --prompt "Organize launch readiness" --type mindmap --format excalidraw --dest launch.excalidraw
|
|
56
|
+
sketchi generate --prompt "Map release approval" --dest - > release.png
|
|
57
|
+
sketchi generate --prompt "Map release approval" --output json
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
`--format` accepts `png`, `excalidraw`, or `scene`; their default names are
|
|
61
|
+
`<id>.png`, `<id>.excalidraw`, and `<id>.scene.json`. With `--dest -`, stdout
|
|
62
|
+
contains artifact bytes only and the text or JSON status envelope moves to
|
|
63
|
+
stderr. Generation, sharing, and pulling are the CLI's three network commands.
|
|
64
|
+
|
|
65
|
+
## Create and work with a diagram offline
|
|
42
66
|
|
|
43
67
|
Create a canonical flowchart from inline JSON:
|
|
44
68
|
|
|
@@ -92,20 +116,6 @@ only artifact bytes to stdout; a PNG file export also includes one generic
|
|
|
92
116
|
inline-Markdown display hint for calling agents. Its destination is enclosed
|
|
93
117
|
in CommonMark angle brackets so local paths containing spaces remain valid.
|
|
94
118
|
|
|
95
|
-
## Generate from a prompt
|
|
96
|
-
|
|
97
|
-
`generate` sends one prompt to Sketchi's public generation API, validates the
|
|
98
|
-
result server-side, and commits the same local record shape used by `create`:
|
|
99
|
-
|
|
100
|
-
```sh
|
|
101
|
-
sketchi generate --prompt "Map release approval with pass and revise branches"
|
|
102
|
-
sketchi generate --prompt "Organize launch readiness" --type mindmap --output json
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
It requires no API key, token, account, or login. `generate`, `share`, and
|
|
106
|
-
`pull` are the CLI's three explicit network commands; each makes one HTTPS
|
|
107
|
-
request.
|
|
108
|
-
|
|
109
119
|
## Share, pull, and restore browser edits
|
|
110
120
|
|
|
111
121
|
Create an immutable encrypted Excalidraw snapshot link from the record's current
|
|
@@ -239,6 +249,7 @@ availability details.
|
|
|
239
249
|
|
|
240
250
|
```sh
|
|
241
251
|
sketchi --help
|
|
252
|
+
sketchi docs
|
|
242
253
|
sketchi create --help
|
|
243
254
|
sketchi patch --help
|
|
244
255
|
sketchi generate --help
|
package/THIRD_PARTY_NOTICES
CHANGED
|
@@ -70,6 +70,7 @@ Excalifont
|
|
|
70
70
|
-----------
|
|
71
71
|
|
|
72
72
|
Copyright (c) 2024 by Excalidraw. All rights reserved.
|
|
73
|
+
Trademark: Excalifont is a trademark of Excalidraw.
|
|
73
74
|
Manufacturer and designer: Your Own Font Foundry (Virgil); Jan Filipek /
|
|
74
75
|
DizajnDesign (Excalifont, modifications)
|
|
75
76
|
|