sketchi 0.4.0 → 0.4.2
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 +27 -0
- package/THIRD_PARTY_NOTICES +61 -0
- package/package.json +1 -1
- package/sketchi.js +109 -55
package/README.md
CHANGED
|
@@ -45,9 +45,26 @@ persists the editable result, then writes `<generated-id>.png` in the current
|
|
|
45
45
|
directory:
|
|
46
46
|
|
|
47
47
|
```sh
|
|
48
|
+
sketchi generate
|
|
49
|
+
|
|
50
|
+
# Direct and noninteractive:
|
|
48
51
|
sketchi generate --prompt "Map release approval with pass and revise branches"
|
|
49
52
|
```
|
|
50
53
|
|
|
54
|
+
With no `--prompt`, Sketchi opens a short wizard only when both standard input
|
|
55
|
+
and standard output are human terminals, output is text, and CI is absent. It
|
|
56
|
+
asks for prompt text, flowchart (the default) or mind map, and where to save the
|
|
57
|
+
PNG. The choices are the current directory, a `diagrams/` folder under exactly
|
|
58
|
+
the directory where Sketchi was run, or a custom path with the same semantics as
|
|
59
|
+
`--dest`. Sketchi does not inspect Git, and it creates `diagrams/` only after
|
|
60
|
+
generation succeeds. An explicit `--type` or file `--dest` presets and skips
|
|
61
|
+
that wizard question. Explicit `--format png` may proceed; another format or
|
|
62
|
+
`--dest -` requires `--prompt` because the interactive wizard writes PNG files.
|
|
63
|
+
|
|
64
|
+
Scripts, pipes, redirected streams, CI, and `--output json` never prompt or
|
|
65
|
+
block. They must pass `--prompt`; omitting it retains the deterministic usage
|
|
66
|
+
error. Passing `--prompt` is always direct and noninteractive.
|
|
67
|
+
|
|
51
68
|
The PNG is rendered locally from the returned validated artifacts and is not
|
|
52
69
|
written back into the record. Choose another artifact or destination explicitly:
|
|
53
70
|
|
|
@@ -230,6 +247,9 @@ Agents can use
|
|
|
230
247
|
`--output json`, complete noninteractive input through `--json` or `--file`, and
|
|
231
248
|
raw artifact output through `export --dest -` without prompts.
|
|
232
249
|
|
|
250
|
+
Agents must pass `--prompt` to `generate`. Interactive prompting is restricted
|
|
251
|
+
to human text TTYs and is never enabled by JSON output, pipes, redirects, or CI.
|
|
252
|
+
|
|
233
253
|
After exporting PNG to a file, agents can follow the returned hint to display
|
|
234
254
|
that path as an inline Markdown image for the user.
|
|
235
255
|
|
|
@@ -258,6 +278,13 @@ sketchi pull --help
|
|
|
258
278
|
sketchi restore --help
|
|
259
279
|
```
|
|
260
280
|
|
|
281
|
+
The root screen is deliberately progressive: it leads with `generate`, one
|
|
282
|
+
copyable prompt, and the few commands used to continue working with a diagram.
|
|
283
|
+
`sketchi docs` is the complete command and automation map; targeted
|
|
284
|
+
`COMMAND --help` pages retain every flag and example. Interactive terminals get
|
|
285
|
+
the Sketchi pencil lockup and restrained brand color. Pipes, `NO_COLOR`, and
|
|
286
|
+
JSON output remain plain and contain no ANSI control sequences.
|
|
287
|
+
|
|
261
288
|
Source, issue tracking, and architecture documentation live in the
|
|
262
289
|
[Sketchi repository](https://github.com/shpitdev/sketchi).
|
|
263
290
|
|
package/THIRD_PARTY_NOTICES
CHANGED
|
@@ -41,6 +41,67 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
41
41
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
42
42
|
SOFTWARE.
|
|
43
43
|
|
|
44
|
+
Terminal presentation dependency tree
|
|
45
|
+
-------------------------------------
|
|
46
|
+
|
|
47
|
+
The CLI bundles the following terminal presentation packages under the MIT
|
|
48
|
+
License:
|
|
49
|
+
|
|
50
|
+
- @clack/prompts 1.7.0 and @clack/core 1.4.3
|
|
51
|
+
- fast-string-width 3.0.2, fast-wrap-ansi 0.2.2, and sisteransi 1.0.5
|
|
52
|
+
- chalk 6.0.0
|
|
53
|
+
- string-width 8.2.2, get-east-asian-width 1.6.0, and strip-ansi 7.2.0
|
|
54
|
+
- wrap-ansi 10.0.0 and ansi-styles 6.2.3
|
|
55
|
+
|
|
56
|
+
Copyright (c) 2025-Present Bombshell contributors
|
|
57
|
+
Copyright (c) 2024-present Fabio Spampinato
|
|
58
|
+
Copyright (c) 2025 James Garbutt
|
|
59
|
+
Copyright (c) 2018 Terkel Gjervig Nielsen
|
|
60
|
+
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com>
|
|
61
|
+
|
|
62
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
63
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
64
|
+
in the Software without restriction, including without limitation the rights
|
|
65
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
66
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
67
|
+
furnished to do so, subject to the following conditions:
|
|
68
|
+
|
|
69
|
+
The above copyright notice and this permission notice shall be included in all
|
|
70
|
+
copies or substantial portions of the Software.
|
|
71
|
+
|
|
72
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
73
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
74
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
75
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
76
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
77
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
78
|
+
SOFTWARE.
|
|
79
|
+
|
|
80
|
+
CI detection dependency tree
|
|
81
|
+
----------------------------
|
|
82
|
+
|
|
83
|
+
The CLI bundles is-ci 4.1.0 and ci-info 4.4.0 under the MIT License.
|
|
84
|
+
|
|
85
|
+
Copyright (c) Thomas Watson Steen <w@tson.dk> (https://twitter.com/wa7son)
|
|
86
|
+
|
|
87
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
88
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
89
|
+
in the Software without restriction, including without limitation the rights
|
|
90
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
91
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
92
|
+
furnished to do so, subject to the following conditions:
|
|
93
|
+
|
|
94
|
+
The above copyright notice and this permission notice shall be included in all
|
|
95
|
+
copies or substantial portions of the Software.
|
|
96
|
+
|
|
97
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
98
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
99
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
100
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
101
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
102
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
103
|
+
SOFTWARE.
|
|
104
|
+
|
|
44
105
|
pako 2.0.3
|
|
45
106
|
-----------
|
|
46
107
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "sketchi",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.2",
|
|
4
4
|
"description": "Local Sketchi authoring CLI with six offline authoring and recovery commands plus three credential-free network commands for generation and encrypted Excalidraw sharing.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"sketchi",
|