CLI reference
CLI reference
Every chiltepin command at a glance.
Use this reference to look up commands and options. For setup, start with Installation.
Examples use chiltepin. Run it as pnpm exec chiltepin with a project
installation, or npx chiltepin@latest for an unpinned version.
Every command
| Command | What it does |
|---|---|
chiltepin init | Scaffold chiltepin.config.json and two starter docs (--force overwrites) |
chiltepin new [name] | Scaffold a whole doc (adr, runbook, …) or one block (-o writes a file) |
chiltepin check [globs] | Validate — schemas, refs, ids, density, prose, lens lints (--json for CI) |
chiltepin block [type] | The reference: every type on one line, or one type's fields, enums, terse forms, and example (--json) |
chiltepin demo [family] | Render the built-in showcase — every block, or one family (-s for a deck) |
chiltepin <file.md> | Render one doc and open it — the fastest preview |
chiltepin html / slides / pdf <file> | Render one doc to standalone HTML, a slide deck, or a PDF (-p opens, -o writes) |
chiltepin build | Build the full static site from all docs (--out <dir>) |
chiltepin studio | The local editor — a Home page of your docs, edit in place, present as slides |
chiltepin audit [path] | Audit a codebase and recommend which docs to write, with evidence |
chiltepin sync openapi <spec> | Generate an API doc from an OpenAPI spec (--check fails on drift) |
chiltepin sync csv <file> | Turn a CSV into a table, statustable, or chart block |
chiltepin sync sql / dbml / prisma <file> | Turn a schema file into an ERD document |
chiltepin skill | Print the authoring skill as a copy-paste system prompt |
By group
Create and validate
init · new · check · block · studio
Export and build
chiltepin <file> · html · slides · pdf · build
Preview and present
slides · demo
Agent reference
Schema lookup and skill export
Import and configure
sync openapi · csv · sql · dbml · prisma · colorScheme
Conventions
- Single-doc commands (
html,slides,pdf) take-o <path>to write a file, or-pto render to a temp file and open it. - Exit codes:
0clean ·1errors ·2wrong usage. CHILTEPIN_PLAIN=1forces plain output; CI gets it automatically.chiltepin <command> --helpshows the options for any command.