chiltepin 0.47.4 → 0.47.6
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
CHANGED
|
@@ -34,7 +34,7 @@ Written in Markdown. Drawn by code. Checked in CI.</p>
|
|
|
34
34
|
**Your agent writes the content. Chiltepin handles the layout.** Compose prose and typed YAML blocks in a `.md` file. Get consistent diagrams, a document you can share, and a source diff you can review.
|
|
35
35
|
|
|
36
36
|
```bash
|
|
37
|
-
npx -y chiltepin demo
|
|
37
|
+
npx -y chiltepin@latest demo
|
|
38
38
|
```
|
|
39
39
|
|
|
40
40
|
Explore the built-in examples without creating a project. **Node.js 20+ required.**
|
|
@@ -144,10 +144,10 @@ The skill guides block selection, schema lookup, composition, and validation. Yo
|
|
|
144
144
|
Run these commands in your project directory:
|
|
145
145
|
|
|
146
146
|
```bash
|
|
147
|
-
npx -y chiltepin init
|
|
148
|
-
npx -y chiltepin check
|
|
149
|
-
npx -y chiltepin html docs/getting-started.md -p
|
|
150
|
-
npx -y chiltepin studio
|
|
147
|
+
npx -y chiltepin@latest init
|
|
148
|
+
npx -y chiltepin@latest check
|
|
149
|
+
npx -y chiltepin@latest html docs/getting-started.md -p
|
|
150
|
+
npx -y chiltepin@latest studio
|
|
151
151
|
```
|
|
152
152
|
|
|
153
153
|
`init` creates a config and two starter documents, skipping existing files. `html -p` opens the rendered page. `studio` opens the local visual editor.
|
|
@@ -156,7 +156,7 @@ To pin the CLI in your project:
|
|
|
156
156
|
|
|
157
157
|
```bash
|
|
158
158
|
npm install --save-dev chiltepin
|
|
159
|
-
npx chiltepin check
|
|
159
|
+
npx chiltepin@latest check
|
|
160
160
|
```
|
|
161
161
|
|
|
162
162
|
See the [getting started guide](https://github.com/jdiejim/chiltepin/blob/main/docs/guides/getting-started.md) for the full workflow. `chiltepin skill` also prints the guide for tools with a system-prompt field.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "chiltepin",
|
|
3
|
-
"version": "0.47.
|
|
3
|
+
"version": "0.47.6",
|
|
4
4
|
"description": "Documentation-as-code CLI: write Markdown with typed YAML blocks for API docs, architecture & system design (C4, ERDs, sequence diagrams), frontend & design systems, ADRs and decision records, planning, and slide presentations. Validate like code with `chiltepin check`, export to HTML, slides, or PDF. AI-native — one-command agent skill (npx skills add jdiejim/chiltepin -g -y) and a visual Studio.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -26,8 +26,8 @@
|
|
|
26
26
|
"react": "^18.3.1",
|
|
27
27
|
"yaml": "^2.6.1",
|
|
28
28
|
"chiltepin-core": "0.24.0",
|
|
29
|
-
"chiltepin-render": "0.33.
|
|
30
|
-
"chiltepin-studio": "0.16.
|
|
29
|
+
"chiltepin-render": "0.33.3",
|
|
30
|
+
"chiltepin-studio": "0.16.3"
|
|
31
31
|
},
|
|
32
32
|
"optionalDependencies": {
|
|
33
33
|
"playwright": "^1.49.0"
|
package/templates/skill/SKILL.md
CHANGED
|
@@ -31,7 +31,7 @@ messages:
|
|
|
31
31
|
## Fast path
|
|
32
32
|
|
|
33
33
|
Use the project's installed CLI (`pnpm exec chiltepin` or `npx --no-install chiltepin`)
|
|
34
|
-
to match its dependency version. Otherwise, `npx -y chiltepin …` downloads and
|
|
34
|
+
to match its dependency version. Otherwise, `npx -y chiltepin@latest …` downloads and
|
|
35
35
|
runs the published CLI. In the Chiltepin source repo, use the built
|
|
36
36
|
`node packages/cli/dist/bin.js`. The commands below show the fallback form.
|
|
37
37
|
|
|
@@ -42,28 +42,28 @@ at the end explains which reference each task needs.
|
|
|
42
42
|
request. Use the table below. For a full doc, two to five structural blocks
|
|
43
43
|
often suffice. A single diagram request needs only that diagram. Use prose
|
|
44
44
|
when a small list communicates the same information more clearly.
|
|
45
|
-
Unsure which block exists: `npx -y chiltepin block` lists all 107 block types.
|
|
46
|
-
2. **Look up each block you will write**: `npx -y chiltepin block <type>`.
|
|
45
|
+
Unsure which block exists: `npx -y chiltepin@latest block` lists all 107 block types.
|
|
46
|
+
2. **Look up each block you will write**: `npx -y chiltepin@latest block <type>`.
|
|
47
47
|
It prints the fields, enums, terse one-line forms, and a validating
|
|
48
48
|
example. Read a family selection sheet only when the choice remains unclear.
|
|
49
49
|
3. **Write the doc.** For a full doc, put `meta` first (title, subtitle, tag). A `##` heading
|
|
50
50
|
above a block is its title. Prose carries why and consequence, never a
|
|
51
51
|
description of the block below it. Rules in the two sections after the
|
|
52
52
|
table.
|
|
53
|
-
4. **Check**: `npx -y chiltepin check <file> --json`. Every diagnostic carries
|
|
53
|
+
4. **Check**: `npx -y chiltepin@latest check <file> --json`. Every diagnostic carries
|
|
54
54
|
a stable code and the failing value; `reference/check.md` maps each code
|
|
55
55
|
to its fix. Fix errors and rerun while you make progress. Stop and report
|
|
56
56
|
the blocker if a diagnostic repeats without a new fix or needs missing facts.
|
|
57
57
|
Warnings do not fail the check by default; review them and report relevant ones.
|
|
58
58
|
A non-zero exit is never "done". If the CLI is unavailable, report validation
|
|
59
59
|
as unverified. Never invent a successful check.
|
|
60
|
-
5. **Render**: after a clean check, `npx -y chiltepin html <file>` writes
|
|
60
|
+
5. **Render**: after a clean check, `npx -y chiltepin@latest html <file>` writes
|
|
61
61
|
`<file>.html` next to the source, so the reader gets the page as well as
|
|
62
62
|
the Markdown. Add `-p` to open it. For a deck, `slides <file>` instead.
|
|
63
63
|
|
|
64
64
|
Handoff: the `.md` and `.html` paths, the actual check result, and any
|
|
65
65
|
unresolved diagnostics. Then one line on what to do next: open the `.html`
|
|
66
|
-
in a browser, or run `npx -y chiltepin studio` to edit the document visually.
|
|
66
|
+
in a browser, or run `npx -y chiltepin@latest studio` to edit the document visually.
|
|
67
67
|
Explain block selection only when the user asks or a tradeoff needs explanation.
|
|
68
68
|
|
|
69
69
|
Editing an existing doc: read it whole first. Change the one block, and
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Part of the **chiltepin** skill (the hub is `SKILL.md`, two folders up). One
|
|
4
4
|
line per block, mapped to the family file that holds its selection guidance.
|
|
5
|
-
For a block's fields and a validating example, run `npx -y chiltepin block
|
|
5
|
+
For a block's fields and a validating example, run `npx -y chiltepin@latest block
|
|
6
6
|
<type>`; bare `chiltepin block` prints this same list. Twelve old block names
|
|
7
7
|
remain valid as permanent aliases — see the table at the bottom.
|
|
8
8
|
|
|
@@ -15,7 +15,7 @@ chiltepin build # static site (index + nav + cross-doc lin
|
|
|
15
15
|
chiltepin sync openapi spec.yaml --out docs/api.md # doc from an OpenAPI spec
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
Prefix every command with `npx -y chiltepin` when `chiltepin` is not on PATH.
|
|
18
|
+
Prefix every command with `npx -y chiltepin@latest` when `chiltepin` is not on PATH.
|
|
19
19
|
|
|
20
20
|
`chiltepin check` exits non-zero on any error and names the file, line, and
|
|
21
21
|
offending value. Warnings never fail the check, but read each one: most name a
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Read this file when a YAML question is not answered by `chiltepin block <type>`.
|
|
4
4
|
It holds the block grammar, the full terse-item table, the YAML traps, the
|
|
5
5
|
reference scheme, and the naming rules. The field contract and an example
|
|
6
|
-
for every block come from `npx -y chiltepin block <type>`.
|
|
6
|
+
for every block come from `npx -y chiltepin@latest block <type>`.
|
|
7
7
|
|
|
8
8
|
## How a block looks
|
|
9
9
|
|