Skip to content
chiltepin
chiltepin docs
CLI

CLI reference

Every chiltepin command at a glance.

New here? The short version: give your agent the skill with npx skills add jdiejim/chiltepin -g, or run the CLI with nothing installed — npx chiltepin demo renders every block, npx chiltepin block sequence prints one block's contract, npx chiltepin check validates, and npx chiltepin docs/x.md renders and opens a doc. The pages here write chiltepin …; read it as npx chiltepin … if you did not install it globally.

Every command

CommandWhat it does
chiltepin initScaffold 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 buildBuild the full static site from all docs (--out <dir>)
chiltepin studioThe 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 skillPrint the authoring skill as a copy-paste system prompt

By group

Conventions

  • Single-doc commands (html, slides, pdf) take -o <path> to write a file, or -p to render to a temp file and open it.
  • Exit codes: 0 clean · 1 errors · 2 wrong usage.
  • AVO_PLAIN=1 forces plain output; CI gets it automatically.
  • chiltepin <command> --help shows the options for any command.