chiltepin 0.47.0 → 0.47.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 +176 -128
- package/dist/bin.js +2 -2
- package/dist/bin.js.map +1 -1
- package/package.json +8 -3
- package/templates/docs/getting-started.md +1 -1
- package/templates/docs/tutorial.md +1 -1
package/README.md
CHANGED
|
@@ -1,115 +1,147 @@
|
|
|
1
1
|
<!-- Generated from the repo README by scripts/sync-readme.mjs — edit the root README.md. -->
|
|
2
2
|
<p align="center">
|
|
3
|
-
<img src="https://raw.githubusercontent.com/jdiejim/chiltepin/main/assets/brand/mark-256.png" alt="Chiltepin" width="
|
|
3
|
+
<img src="https://raw.githubusercontent.com/jdiejim/chiltepin/main/assets/brand/mark-256.png" alt="Chiltepin" width="80" />
|
|
4
4
|
</p>
|
|
5
5
|
|
|
6
6
|
<h1 align="center">Chiltepin</h1>
|
|
7
7
|
|
|
8
|
-
<p align="center"><strong>
|
|
8
|
+
<p align="center"><strong>Technical docs, made visual.</strong><br/>
|
|
9
|
+
AI systems, architecture, graphs, and the documents that connect them.<br/>
|
|
10
|
+
Written in Markdown. Drawn by code. Checked in CI.</p>
|
|
11
|
+
|
|
12
|
+
<p align="center"><sub>Open-source docs as code: an AI documentation generator that lives in your repo. Your agent writes the docs, <code>chiltepin check</code> validates them, the renderer draws them.</sub></p>
|
|
9
13
|
|
|
10
14
|
<p align="center">
|
|
11
|
-
<a href="https://www.npmjs.com/package/chiltepin"><img src="https://img.shields.io/npm/v/chiltepin?label=chiltepin&color=e4744c" alt="npm" /></a>
|
|
15
|
+
<a href="https://www.npmjs.com/package/chiltepin"><img src="https://img.shields.io/npm/v/chiltepin?label=chiltepin&color=e4744c" alt="npm version" /></a>
|
|
12
16
|
<a href="https://github.com/jdiejim/chiltepin/actions/workflows/ci.yml"><img src="https://github.com/jdiejim/chiltepin/actions/workflows/ci.yml/badge.svg" alt="CI status" /></a>
|
|
13
|
-
<a href="https://github.com/jdiejim/chiltepin/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" alt="license" /></a>
|
|
14
|
-
<a href="https://nodejs.org"><img src="https://img.shields.io/node/v/chiltepin" alt="
|
|
15
|
-
<a href="https://github.com/jdiejim/chiltepin/tree/main/skills/chiltepin"><img src="https://img.shields.io/badge/skills-npx%20skills%20add%20jdiejim%2Fchiltepin-111" alt="skill" /></a>
|
|
17
|
+
<a href="https://github.com/jdiejim/chiltepin/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" alt="MIT license" /></a>
|
|
18
|
+
<a href="https://nodejs.org"><img src="https://img.shields.io/node/v/chiltepin" alt="Supported Node.js version" /></a>
|
|
16
19
|
</p>
|
|
17
20
|
|
|
18
21
|
<p align="center">
|
|
19
|
-
<a href="https://chiltepin.dev">Website</a> ·
|
|
20
22
|
<a href="#quick-start">Quick start</a> ·
|
|
21
|
-
<a href="#
|
|
23
|
+
<a href="#agents-architectures-and-graphs">See the results</a> ·
|
|
24
|
+
<a href="#how-chiltepin-works">Architecture</a> ·
|
|
22
25
|
<a href="https://github.com/jdiejim/chiltepin/blob/main/skills/chiltepin/SKILL.md">Agent skill</a> ·
|
|
23
|
-
<a href="https://
|
|
26
|
+
<a href="https://chiltepin.dev">Website</a>
|
|
24
27
|
</p>
|
|
25
28
|
|
|
26
29
|
<p align="center">
|
|
27
|
-
<img src="https://raw.githubusercontent.com/jdiejim/chiltepin/main/assets/examples/
|
|
30
|
+
<a href="https://github.com/jdiejim/chiltepin/blob/main/docs/examples/platform-architecture.md"><img src="https://raw.githubusercontent.com/jdiejim/chiltepin/main/assets/examples/platform.png" alt="System design of a marketplace platform: clients through a CDN, WAF, and load balancer into replicated services, a Kafka event backbone, sharded Postgres with read replicas, a Redis cache, search, object storage, a warehouse, and Stripe and Twilio at the edge" width="960" /></a>
|
|
28
31
|
</p>
|
|
32
|
+
<p align="center"><sub>A platform on one page: 20 nodes, 21 flows, one <code>block</code> in <a href="https://github.com/jdiejim/chiltepin/blob/main/docs/examples/platform-architecture.md">typed YAML</a>. Shapes, routing, numbering, and the legend come from the renderer.</sub></p>
|
|
29
33
|
|
|
30
|
-
**Your agent writes the content. Chiltepin handles the layout.**
|
|
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.
|
|
31
35
|
|
|
32
36
|
```bash
|
|
33
|
-
npx -y chiltepin demo
|
|
37
|
+
npx -y chiltepin demo
|
|
34
38
|
```
|
|
35
39
|
|
|
36
|
-
|
|
40
|
+
Explore the built-in examples without creating a project. **Node.js 20+ required.**
|
|
37
41
|
|
|
38
|
-
##
|
|
42
|
+
## Agents, architectures, and graphs
|
|
39
43
|
|
|
40
|
-
|
|
44
|
+
Show how an agent acts, where a system begins and ends, or how a graph connects. Chiltepin gives each question its own visual form.
|
|
41
45
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
+
**A transport platform, in context.** Riders, operators, maps, and live fleet data around one system boundary.
|
|
47
|
+
|
|
48
|
+
[](https://github.com/jdiejim/chiltepin/blob/main/assets/examples/transport.png)
|
|
49
|
+
|
|
50
|
+
**Then zoom into the network.** A weighted graph makes connections and alternative routes explicit.
|
|
51
|
+
|
|
52
|
+
[](https://github.com/jdiejim/chiltepin/blob/main/assets/examples/graph.png)
|
|
53
|
+
|
|
54
|
+
<p align="center"><sub>Two views of one transport design. <a href="https://github.com/jdiejim/chiltepin/blob/main/docs/examples/transport-network.md">Read the C4 and graph source.</a> Travel times are illustrative.</sub></p>
|
|
55
|
+
|
|
56
|
+
<details>
|
|
57
|
+
<summary><strong>Inside the AI document: a budget for the next tool call</strong></summary>
|
|
58
|
+
|
|
59
|
+
[](https://github.com/jdiejim/chiltepin/blob/main/assets/examples/agent-context.png)
|
|
60
|
+
|
|
61
|
+
The [full research agent document](https://github.com/jdiejim/chiltepin/blob/main/docs/examples/research-agent.md) includes the agent loop, a C4 container view, and this illustrative context budget.
|
|
46
62
|
|
|
47
|
-
|
|
63
|
+
</details>
|
|
64
|
+
|
|
65
|
+
## One document. The whole design.
|
|
66
|
+
|
|
67
|
+
An architecture review needs the boundaries, the failure paths, the data, and the release plan. Keep them together.
|
|
68
|
+
|
|
69
|
+
The [checkout example](https://github.com/jdiejim/chiltepin/blob/main/docs/examples/checkout-design.md) brings these figures together with architecture and prose in one Markdown file:
|
|
70
|
+
|
|
71
|
+
| What happens when a payment fails? | How do orders and events stay consistent? |
|
|
48
72
|
| --- | --- |
|
|
49
|
-
| [](https://github.com/jdiejim/chiltepin/blob/main/assets/examples/sequence.png) | [](https://github.com/jdiejim/chiltepin/blob/main/assets/examples/data-model.png) |
|
|
74
|
+
| An explicit failure path, alongside the successful request. | A transactional outbox, with the constraints visible. |
|
|
51
75
|
|
|
52
|
-
|
|
76
|
+
[](https://github.com/jdiejim/chiltepin/blob/main/assets/examples/rollout.png)
|
|
77
|
+
|
|
78
|
+
<p align="center"><sub>The release plan is part of the design: traffic, gates, and rollback in one figure.</sub></p>
|
|
53
79
|
|
|
54
80
|
<details>
|
|
55
|
-
<summary><strong>
|
|
81
|
+
<summary><strong>Read the complete checkout document</strong></summary>
|
|
56
82
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
83
|
+
[](https://github.com/jdiejim/chiltepin/blob/main/assets/examples/document.png)
|
|
84
|
+
|
|
85
|
+
[Open the Markdown source](https://github.com/jdiejim/chiltepin/blob/main/docs/examples/checkout-design.md) to reproduce the document.
|
|
60
86
|
|
|
61
87
|
</details>
|
|
62
88
|
|
|
63
|
-
|
|
89
|
+
**Go deeper on architecture.** Describe regions, availability zones, subnets, replicas, and the connections between them.
|
|
90
|
+
|
|
91
|
+
[](https://github.com/jdiejim/chiltepin/blob/main/assets/examples/deployment.png)
|
|
64
92
|
|
|
65
|
-
|
|
66
|
-
- **Layout you can reproduce.** Typed content goes through deterministic renderers; the agent does not need to draw the output.
|
|
67
|
-
- **Validation you can automate.** `chiltepin check` fails on invalid fields and broken references. Style and density warnings help authors improve the result.
|
|
68
|
-
- **Several outputs from one source.** Export HTML, slides, PDF, or a static docs site. Edit the same files in Studio or your editor.
|
|
93
|
+
<p align="center"><sub><a href="https://github.com/jdiejim/chiltepin/blob/main/docs/examples/deployment-topology.md">Read the deployment source</a> · Includes a second view of the service on Kubernetes.</sub></p>
|
|
69
94
|
|
|
70
|
-
|
|
95
|
+
More complete examples: [system context](https://github.com/jdiejim/chiltepin/blob/main/docs/examples/system-overview.md) · [API reference](https://github.com/jdiejim/chiltepin/blob/main/docs/examples/api.md) · [ADR](https://github.com/jdiejim/chiltepin/blob/main/docs/examples/adr.md) · [runbook](https://github.com/jdiejim/chiltepin/blob/main/docs/examples/runbook.md) · [agent system](https://github.com/jdiejim/chiltepin/blob/main/docs/systems/agent-system.md) · [slide deck](https://github.com/jdiejim/chiltepin/blob/main/docs/examples/presentation.md).
|
|
96
|
+
|
|
97
|
+
## Small source. Finished figures.
|
|
98
|
+
|
|
99
|
+
This is the agent loop in the opening image. The block type selects the renderer; the YAML describes the content.
|
|
71
100
|
|
|
72
101
|
````markdown
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
-
|
|
83
|
-
-
|
|
84
|
-
-
|
|
85
|
-
|
|
86
|
-
-
|
|
87
|
-
-
|
|
88
|
-
-
|
|
89
|
-
|
|
90
|
-
- end
|
|
102
|
+
```agentloop
|
|
103
|
+
id: research-agent-loop
|
|
104
|
+
title: Research. Verify. Answer.
|
|
105
|
+
agent:
|
|
106
|
+
name: Research agent
|
|
107
|
+
model: Tool-calling LLM
|
|
108
|
+
note: "Build a cited answer. Keep uncertainty visible."
|
|
109
|
+
env: Researcher
|
|
110
|
+
tools:
|
|
111
|
+
- { name: search_sources, desc: "Find relevant sources" }
|
|
112
|
+
- { name: read_source, desc: "Read the original text" }
|
|
113
|
+
- { name: compare_claims, desc: "Find gaps and conflicts" }
|
|
114
|
+
memory:
|
|
115
|
+
- research question
|
|
116
|
+
- source links + excerpts
|
|
117
|
+
- unresolved claims
|
|
118
|
+
stop: "Return a cited answer after verification, or report gaps after eight tool rounds."
|
|
91
119
|
```
|
|
92
120
|
````
|
|
93
121
|
|
|
94
|
-
|
|
122
|
+
**No coordinates, drawing instructions, or generated SVG to maintain.** Chiltepin owns the geometry, typography, and spacing. Change a tool or a stopping rule in the source and render again.
|
|
123
|
+
|
|
124
|
+
Every block has a strict schema. Look up its fields and a working example with `chiltepin block agentloop`.
|
|
95
125
|
|
|
96
126
|
## Quick start
|
|
97
127
|
|
|
98
|
-
|
|
128
|
+
**With your AI agent**
|
|
99
129
|
|
|
100
|
-
|
|
130
|
+
Install the [authoring skill](https://github.com/jdiejim/chiltepin/blob/main/skills/chiltepin/SKILL.md):
|
|
101
131
|
|
|
102
132
|
```bash
|
|
103
|
-
npx skills add jdiejim/chiltepin -g
|
|
133
|
+
npx skills add jdiejim/chiltepin -g -y
|
|
104
134
|
```
|
|
105
135
|
|
|
106
|
-
Then ask:
|
|
136
|
+
Then ask your agent:
|
|
107
137
|
|
|
108
|
-
> Use Chiltepin to document this project's
|
|
138
|
+
> Use Chiltepin to document this project's architecture. Read the code, show the system boundaries and request flow, include the failure path, and validate the document. Export it to HTML.
|
|
109
139
|
|
|
110
|
-
The
|
|
140
|
+
The skill guides block selection, schema lookup, composition, and validation. You review the technical facts; Chiltepin checks the structure.
|
|
111
141
|
|
|
112
|
-
**
|
|
142
|
+
**In your terminal**
|
|
143
|
+
|
|
144
|
+
Run these commands in your project directory:
|
|
113
145
|
|
|
114
146
|
```bash
|
|
115
147
|
npx -y chiltepin init
|
|
@@ -118,23 +150,93 @@ npx -y chiltepin html docs/getting-started.md -p
|
|
|
118
150
|
npx -y chiltepin studio
|
|
119
151
|
```
|
|
120
152
|
|
|
121
|
-
`init`
|
|
153
|
+
`init` creates a config and two starter documents, skipping existing files. `html -p` opens the rendered page. `studio` opens the local visual editor.
|
|
154
|
+
|
|
155
|
+
To pin the CLI in your project:
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
npm install --save-dev chiltepin
|
|
159
|
+
npx chiltepin check
|
|
160
|
+
```
|
|
161
|
+
|
|
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.
|
|
122
163
|
|
|
123
|
-
|
|
164
|
+
## One source, several ways to share
|
|
124
165
|
|
|
125
|
-
|
|
166
|
+
| You need… | Run | You get |
|
|
167
|
+
| --- | --- | --- |
|
|
168
|
+
| A document to send | `chiltepin html docs/design.md` | A standalone page with inline CSS and SVG |
|
|
169
|
+
| A design review deck | `chiltepin slides docs/design.md` | A self-contained slide deck organized by headings |
|
|
170
|
+
| A printable handoff | `chiltepin pdf docs/design.md` | A PDF; Chromium downloads once on first use |
|
|
171
|
+
| A documentation site | `chiltepin build` | A static site with navigation and cross-document links |
|
|
172
|
+
| A place to edit | `chiltepin studio` | A local visual editor for the same Markdown files |
|
|
126
173
|
|
|
127
|
-
|
|
174
|
+
Dark by default. Set `"colorScheme": "light"` or `"system"` in `chiltepin.config.json` to change the page appearance. Print and PDF use the light palette.
|
|
128
175
|
|
|
129
|
-
|
|
176
|
+
<details>
|
|
177
|
+
<summary><strong>See the same document in light mode</strong></summary>
|
|
178
|
+
|
|
179
|
+
[](https://github.com/jdiejim/chiltepin/blob/main/assets/examples/agent-document-light.png)
|
|
180
|
+
|
|
181
|
+
The same source and layout, with a light palette for reading and print.
|
|
182
|
+
|
|
183
|
+
</details>
|
|
184
|
+
|
|
185
|
+
## How Chiltepin works
|
|
186
|
+
|
|
187
|
+
**Geometry is code, never prompt.** An agent produces structured content; the same parser and renderers serve the CLI and Studio.
|
|
188
|
+
|
|
189
|
+
[](https://github.com/jdiejim/chiltepin/blob/main/assets/examples/pipeline.png)
|
|
190
|
+
|
|
191
|
+
<p align="center"><sub>Chiltepin's architecture, drawn with Chiltepin. <a href="https://github.com/jdiejim/chiltepin/blob/main/docs/examples/chiltepin-pipeline.md">Read the figure source.</a></sub></p>
|
|
192
|
+
|
|
193
|
+
| Layer | Responsibility |
|
|
194
|
+
| --- | --- |
|
|
195
|
+
| [`chiltepin-core`](https://github.com/jdiejim/chiltepin/tree/main/packages/core) | Parse Markdown, validate typed blocks, resolve references, and return diagnostics. Pure: no I/O or DOM. |
|
|
196
|
+
| [`chiltepin-render`](https://github.com/jdiejim/chiltepin/tree/main/packages/render) | Turn the parsed document into deterministic HTML and SVG. Own all layout and visual tokens. |
|
|
197
|
+
| [`chiltepin-studio`](https://github.com/jdiejim/chiltepin/tree/main/packages/studio) | Run the shared pipeline in the browser; edit source files through the local server. |
|
|
198
|
+
| [`chiltepin`](https://github.com/jdiejim/chiltepin/tree/main/packages/cli) | Read and write files, run checks, export documents, build sites, and serve Studio. |
|
|
199
|
+
|
|
200
|
+
The block registry connects each type to its schema. Exhaustive TypeScript registries make missing renderers a compile error. Files remain the source of truth across editors and exports.
|
|
201
|
+
|
|
202
|
+
Read the [architecture guide](https://github.com/jdiejim/chiltepin/blob/main/ARCHITECTURE.md) and [renderer design rules](https://github.com/jdiejim/chiltepin/blob/main/packages/render/DESIGN.md) for the implementation details.
|
|
203
|
+
|
|
204
|
+
## Review the diff. Check the document.
|
|
205
|
+
|
|
206
|
+
Put the CLI in your project's development dependencies, then add this step after dependency installation in CI:
|
|
207
|
+
|
|
208
|
+
```yaml
|
|
209
|
+
- name: Validate documentation
|
|
210
|
+
run: npx --no-install chiltepin check
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
`chiltepin check` validates the configured docs directory. It catches invalid fields, duplicate IDs, and broken references across documents. Errors fail the command.
|
|
130
214
|
|
|
131
215
|
```bash
|
|
132
|
-
|
|
216
|
+
chiltepin check --json # diagnostics for tooling and agents
|
|
217
|
+
chiltepin check --strict-prose # also fail on prose warnings
|
|
133
218
|
```
|
|
134
219
|
|
|
135
|
-
|
|
220
|
+
Density and style warnings flag crowded diagrams and unclear prose. Validation checks structure and references; it cannot verify your system's technical facts.
|
|
221
|
+
|
|
222
|
+
## Pick the block that answers the question
|
|
136
223
|
|
|
137
|
-
|
|
224
|
+
**107 block types across 13 families.** Architecture and flows are only the start.
|
|
225
|
+
|
|
226
|
+
| Reader's question | Reach for |
|
|
227
|
+
| --- | --- |
|
|
228
|
+
| What runs where? | `c4`, `block`, `cluster`, `archmap` |
|
|
229
|
+
| What happens next, or when it fails? | `sequence`, `flow`, `state`, `saga` |
|
|
230
|
+
| What do we store or expose? | `erd`, `endpoint`, `eventcontract` |
|
|
231
|
+
| Why this decision? | `options`, `scqa`, `scorecard`, `proscons` |
|
|
232
|
+
| How does this ship? | `rollout`, `roadmap`, `gantt`, `steps` |
|
|
233
|
+
| What did the measurements show? | `chart`, `percentiles`, `benchmark`, `slo` |
|
|
234
|
+
| How does the agent behave? | `agentloop`, `trace`, `prompt`, `context` |
|
|
235
|
+
|
|
236
|
+
Run `chiltepin block` to browse the catalog, or `chiltepin demo architecture` to render one family.
|
|
237
|
+
|
|
238
|
+
<details>
|
|
239
|
+
<summary><strong>Browse all block families</strong></summary>
|
|
138
240
|
|
|
139
241
|
| For… | Blocks |
|
|
140
242
|
|---|---|
|
|
@@ -151,47 +253,9 @@ Errors fail the command. Warnings are non-blocking by default; `--strict-prose`
|
|
|
151
253
|
| AI & ML | `agentloop` `trace` `prompt` `context` `neuralnet` `modelcard` |
|
|
152
254
|
| Prose structure | `callout` `list` `glossary` `faq` `steps` `spec` `layers` `gallery` `mindmap` `tree` `fishbone` |
|
|
153
255
|
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
## Outputs
|
|
157
|
-
|
|
158
|
-
| Command | Result |
|
|
159
|
-
|---|---|
|
|
160
|
-
| `chiltepin html docs/x.md` | A standalone page with inline CSS + SVG; size depends on content |
|
|
161
|
-
| `chiltepin slides docs/x.md` | A self-contained deck, one slide per heading |
|
|
162
|
-
| `chiltepin pdf docs/x.md` | Print-ready PDF (Chromium fetched once on first use) |
|
|
163
|
-
| `chiltepin build` | A static docs site: index, sidebar, cross-doc links |
|
|
164
|
-
| `chiltepin studio` | Local editor: Home page of your docs, edit in place, Present, Export |
|
|
165
|
-
|
|
166
|
-
One look, dark by default. `"colorScheme": "light"` or `"system"` in `chiltepin.config.json` switches it; print and PDF are always light.
|
|
256
|
+
Typed blocks across 13 families. Every field, enum, and terse form: `chiltepin block <type>`. Twelve old names (`infra` `event` `ddd` `network` `belogic` `dag` `waterfall` `funnel` `diff` `terminal` `mece` `tracker`) remain permanent aliases.
|
|
167
257
|
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
```bash
|
|
171
|
-
chiltepin check # docs/**/*.md
|
|
172
|
-
chiltepin check --json # { code, file, line, column, message, hint, suggestions }
|
|
173
|
-
```
|
|
174
|
-
|
|
175
|
-
Strict schemas (an unknown field is an error, with "did you mean"), repo-global unique ids, `doc#id` references resolved across files, density caps that say how to split a crowded diagram, prose lints for long sentences and filler, and lens lints: an unlabelled `c4` arrow, a third block of the same type. The parser also repairs the one YAML trap agents hit most — an unquoted comma inside an inline map — so `label: Hold as BACKORDERED, email ETA` means what the author meant.
|
|
176
|
-
|
|
177
|
-
## Cross-references
|
|
178
|
-
|
|
179
|
-
```yaml
|
|
180
|
-
links:
|
|
181
|
-
- { ref: orders-api#seq-place-order, label: Request flow }
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
Any block with a top-level `id:` can be referenced as `doc#id` (or `#id` in the same doc). Duplicates and dangling refs fail the check with both locations.
|
|
185
|
-
|
|
186
|
-
## Packages
|
|
187
|
-
|
|
188
|
-
| Package | Purpose |
|
|
189
|
-
|---|---|
|
|
190
|
-
| [`chiltepin`](https://github.com/jdiejim/chiltepin/tree/main/packages/cli) | The `chiltepin` CLI: `check · block · demo · html · slides · pdf · build · studio · init · new · audit · sync · skill` |
|
|
191
|
-
| [`chiltepin-core`](https://github.com/jdiejim/chiltepin/tree/main/packages/core) | Parser, block registry, Zod schemas, terse grammars, diagnostics. Pure, no I/O |
|
|
192
|
-
| [`chiltepin-render`](https://github.com/jdiejim/chiltepin/tree/main/packages/render) | Deterministic renderers; HTML + SVG, one editorial skin |
|
|
193
|
-
| [`chiltepin-studio`](https://github.com/jdiejim/chiltepin/tree/main/packages/studio) | The local visual editor served by `chiltepin studio` |
|
|
194
|
-
| [`skills/chiltepin`](https://github.com/jdiejim/chiltepin/tree/main/skills/chiltepin) | The agent skill: block selection, validation, and references loaded on demand |
|
|
258
|
+
</details>
|
|
195
259
|
|
|
196
260
|
<details>
|
|
197
261
|
<summary><strong>Full CLI reference</strong></summary>
|
|
@@ -215,34 +279,18 @@ Exit codes: `0` clean · `1` errors · `2` usage error. `CHILTEPIN_PLAIN=1` forc
|
|
|
215
279
|
|
|
216
280
|
</details>
|
|
217
281
|
|
|
218
|
-
##
|
|
219
|
-
|
|
220
|
-
The [generation evaluation](https://github.com/jdiejim/chiltepin/tree/main/evals/generate) records 40 plain-language requests: a selection score of 39.5/40, 33 first drafts without errors, and 40 documents validated and rendered at handoff. These are maintainer-reported development runs, including rescoring after fixes. Raw run artifacts are local, so this is not an independently reproducible benchmark result yet. See the [case set](https://github.com/jdiejim/chiltepin/blob/main/evals/generate/cases.yaml) and [method](https://github.com/jdiejim/chiltepin/blob/main/evals/generate/README.md).
|
|
221
|
-
|
|
222
|
-
## Design rules
|
|
223
|
-
|
|
224
|
-
- **Geometry is code, never prompt.** If a fix tempts you to teach the model coordinates, the fix belongs in the renderer.
|
|
225
|
-
- **Registries are exhaustive.** A block type exists only when it has a schema, a renderer, a skill entry, a catalog example, and a test.
|
|
226
|
-
- **One look.** Tokens only, no literal colours; one accent per diagram, spent on the one thing the reader must see.
|
|
227
|
-
- **Files are the truth.** Studio, the CLI, and agents write the same `.md`; nothing else holds state.
|
|
228
|
-
|
|
229
|
-
See [`ARCHITECTURE.md`](https://github.com/jdiejim/chiltepin/blob/main/ARCHITECTURE.md) and the renderer's [`DESIGN.md`](https://github.com/jdiejim/chiltepin/blob/main/packages/render/DESIGN.md).
|
|
230
|
-
|
|
231
|
-
## Development
|
|
282
|
+
## Contribute
|
|
232
283
|
|
|
233
284
|
```bash
|
|
234
285
|
pnpm install
|
|
235
|
-
pnpm
|
|
236
|
-
node packages/cli/dist/bin.js check # the repo's own docs
|
|
286
|
+
pnpm verify
|
|
237
287
|
```
|
|
238
288
|
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
## Contribute and get help
|
|
289
|
+
Read [CONTRIBUTING.md](https://github.com/jdiejim/chiltepin/blob/main/CONTRIBUTING.md) to add a block, improve a renderer, or contribute an example. [Report a bug](https://github.com/jdiejim/chiltepin/issues/new?template=bug.yml) with a small Markdown file that reproduces it, or [request a block](https://github.com/jdiejim/chiltepin/issues/new?template=block.yml).
|
|
242
290
|
|
|
243
|
-
|
|
291
|
+
The figures in this README come from checked-in source documents. Run `pnpm build` followed by `pnpm screenshots` to regenerate them with Playwright and Chromium. The CLI build also syncs the npm README and converts its image and document links to absolute URLs.
|
|
244
292
|
|
|
245
|
-
|
|
293
|
+
[Generation evaluations](https://github.com/jdiejim/chiltepin/tree/main/evals/generate) track block selection, validation, and rendering across 40 requests. The results are maintainer-reported development runs; see the method and its reproducibility limits there.
|
|
246
294
|
|
|
247
295
|
## License
|
|
248
296
|
|
package/dist/bin.js
CHANGED
|
@@ -2921,7 +2921,7 @@ function examples() {
|
|
|
2921
2921
|
...rows,
|
|
2922
2922
|
"",
|
|
2923
2923
|
` ${cyan("chiltepin <file.md>")} ${dim("renders + opens a doc \u2014 the fastest preview")}`,
|
|
2924
|
-
` ${cyan("npx skills add jdiejim/chiltepin")} ${dim("installs the authoring skill into your AI agent")}`,
|
|
2924
|
+
` ${cyan("npx skills add jdiejim/chiltepin -g -y")} ${dim("installs the authoring skill into your AI agent")}`,
|
|
2925
2925
|
` ${dim("Docs:")} https://github.com/jdiejim/chiltepin`,
|
|
2926
2926
|
""
|
|
2927
2927
|
].join("\n");
|
|
@@ -3022,7 +3022,7 @@ Created ${result.created.length} file(s), skipped ${result.skipped.length}.`)
|
|
|
3022
3022
|
`Next: ${pc5.cyan("chiltepin check")} ${pc5.dim("\xB7")} ${pc5.cyan("chiltepin docs/getting-started.md")} ${pc5.dim("(render + open)")}`
|
|
3023
3023
|
);
|
|
3024
3024
|
console.log(
|
|
3025
|
-
`AI: ${pc5.cyan("npx skills add jdiejim/chiltepin")} ${pc5.dim("installs the authoring skill into Claude Code, Cursor, Codex, and 70+ agents")}`
|
|
3025
|
+
`AI: ${pc5.cyan("npx skills add jdiejim/chiltepin -g -y")} ${pc5.dim("installs the authoring skill into Claude Code, Cursor, Codex, and 70+ agents")}`
|
|
3026
3026
|
);
|
|
3027
3027
|
}
|
|
3028
3028
|
async function main(argv) {
|