Skip to content
chiltepin
chiltepin docs
CLI reference

Create and validate

Set up a project, scaffold content, validate docs, look a block up, and open the visual editor.

The everyday loop: chiltepin init once, then edit → chiltepin check → preview. chiltepin block is the reference, chiltepin new gives you a valid starting point, and chiltepin studio opens the visual editor.

chiltepin init

Scaffold a project. No prompts:

chiltepin init          # chiltepin.config.json + two starter docs under docs/
chiltepin init --force  # overwrite the starter files

See Configuration for the config keys.

chiltepin new

Create from a template — a full doc or a single block.

chiltepin new                                     # pick a doc template or block scaffold interactively
chiltepin new adr -o docs/decisions/001-queue.md  # scaffold an ADR into a file
chiltepin new sequence                            # print a sequence-block scaffold to paste

Use chiltepin new to see the templates available in your installed version. Browse Templates for rendered examples.

chiltepin check

Validate every doc — block schemas, doc#id references, duplicate ids, density caps, prose lints, and lens lints (an unlabelled c4 arrow, a third callout in one document). Exits with an error code when something fails, so CI can gate on it.

chiltepin check                    # docs/**/*.md
chiltepin check docs/orders.md     # one file or glob
chiltepin check --json             # { code, file, line, column, message, hint, suggestions }
chiltepin check --strict-prose     # treat W_PROSE_* warnings as errors

For diagnostic codes and suggested fixes, see Validation.

chiltepin block

Read the fields and examples from the installed package:

chiltepin block                    # every block type, one line each, by family
chiltepin block sequence           # fields, enums, terse forms, and a validating example
chiltepin block erd --json         # the same contract as JSON

This is the command the authoring skill tells an agent to run before writing any block. The web version of the list is /blocks.

chiltepin studio

Open the visual editor in your browser. It starts on a Home page of your docs; open one and edit it in place — click a block, change it as a form or as YAML, and watch the page update. Your .md files stay the source of truth.

chiltepin studio                   # opens the browser (--port, --no-open)

The details are in the Studio guide.