Quick Start
Reach your first CELLAS certification PASS in about ten minutes.
Goal: first successful certification — not reading every page.
Happy path = 5 commands. Target: ≤ 10 minutes from install start to PASS.
The five commands
pnpm create cellas my-docs
cd my-docs
pnpm install
pnpm exec cellas verify
pnpm exec cellas certifyExpected:
verify→SUCCESScertify→ PASS
No extra flags. Defaults come from cellas.config.yaml and examples/.
Minute-by-minute
| Minutes | What you do |
|---|---|
| 0–2 | Create the project |
| 2–5 | pnpm install |
| 5–8 | cellas verify |
| 8–10 | cellas certify → PASS |
If you finish early, open README.md in the generated project and make one doc edit, then re-run pnpm run validate.
Choose a starter
pnpm create cellas my-docs # documentation (default)
pnpm create cellas my-plugin --template plugin
pnpm create cellas my-blog --template blog
pnpm create cellas my-lib --template library
pnpm create cellas my-ext --template runtime-extensionEvery official starter reaches PASS with the same five-command shape.
If something fails
| Symptom | Next step |
|---|---|
create cellas not found | Use Node 22+ and pnpm 9; see Install. If packages are not on npm yet, use local rehearsal |
pnpm install cannot find @cellas/conformance-cli | Publish is ready in-repo (tools/npm-release/); until the registry has 1.1.0, use local rehearsal |
verify fails | Re-run with explicit paths (below) |
| Unsure what to do next | Read the generated project README.md — it always lists the next command |
Explicit paths (recovery):
pnpm exec cellas verify --input examples/execution-record.json --type execution
pnpm exec cellas certify --target examples/target.json --profile referenceLocal rehearsal (monorepo)
Until create-cellas and @cellas/conformance-cli are on npm, rehearse from a CELLAS checkout:
pnpm install
pnpm build
node packages/create-cellas/dist/bin.js my-docs --yes --no-install
cd my-docs
node ../apps/conformance-cli/dist/index.js verify
node ../apps/conformance-cli/dist/index.js certifySame fixtures, same PASS. The public five-command path is the product; this block is for contributors measuring DX before publish.