Package Exports
- @decantr/cli
- @decantr/cli/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@decantr/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@decantr/cli
Support status: core-supported
Release channel: stable
Decantr’s main local operator surface for scaffolding, auditing, inspecting, and maintaining Decantr projects.
Install
npm install -D @decantr/cliOr run it without installing:
npx @decantr/cli new my-app --blueprint=agent-marketplaceUse decantr new for a greenfield workspace in a fresh directory.
Use decantr analyze first when you already have an app and want Decantr governance without adopting a blueprint.
Use decantr init to attach Decantr contract/context files to an existing project or to create a contract-only workspace.
Current starter adapter availability:
react-viteis the runnable bootstrap adapter in this wave- other contract targets remain valid Decantr targets, but
decantr newwill keep them in contract-only mode until their adapters land
What It Does
- scaffolds Decantr projects from blueprints, archetypes, or prompts
- supports three workflow lanes: greenfield blueprint, brownfield adoption, and hybrid composition
- generates execution-pack context files for AI coding assistants
- audits projects against Decantr contracts
- searches the registry and showcase benchmark corpus
- validates, refreshes, and maintains
decantr.essence.json
Common Commands
decantr new my-app --blueprint=agent-marketplace
decantr analyze
decantr init --existing --yes
decantr init --existing --blueprint=agent-marketplace
decantr magic "AI-native analytics workspace"
decantr audit
decantr check
decantr registry summary --namespace @official --json
decantr showcase verification --jsonGreenfield Certification
Use the built-in certification harness before releases when you want to prove that representative blueprints still scaffold into runnable starter projects:
pnpm --filter @decantr/cli certify:blueprintsBy default it certifies portfolio, producer-studio, and agent-marketplace by:
- running
decantr newin fresh temp directories - seeding offline content from
DECANTR_CONTENT_DIRor a siblingdecantr-contentcheckout - verifying the starter runtime files and router mode match the generated essence
- running
npm run buildin each scaffolded project
Override the matrix or emit JSON when needed:
pnpm --filter @decantr/cli certify:blueprints -- --blueprints=portfolio,legal-research --jsonOffline blueprint scaffolding expects a real local content source:
DECANTR_CONTENT_DIR=/path/to/decantr-content decantr new my-app --blueprint=agent-marketplace --offlineIf a requested offline blueprint, archetype, or theme cannot be resolved from local cache/custom content or DECANTR_CONTENT_DIR, the CLI now stops explicitly instead of silently falling back to the default scaffold.
Workflow Certification
The broader workflow matrix now has its own certification entrypoint:
pnpm --filter @decantr/cli certify:workflowsIt covers:
- greenfield blueprint bootstrap
- brownfield
analyze -> init --existing - hybrid follow-up composition via Decantr mutation commands
Generated Context
Scaffolded projects include compiled execution packs under .decantr/context/, including:
scaffold-pack.md/scaffold-pack.jsonsection-*-pack.md/section-*-pack.jsonpage-*-pack.md/page-*-pack.jsonreview-pack.md/review-pack.jsonpack-manifest.json
Those files are the compact task contracts meant for AI assistants and downstream tooling.
Recommended read order for AI-assisted scaffolding:
DECANTR.mdfor the design spec, CSS approach, and guard rules.decantr/context/scaffold-pack.mdas the primary compiled shell, theme, feature, and route contract.decantr/context/scaffold.mdas the broader app overview and topology guide- matching
section-*-pack.mdandsection-*.mdfiles before section work - matching
page-*-pack.mdfiles before route work
Treat the compiled execution packs as the source of truth. Use the narrative docs as secondary explanation, start with the shell and route structure first, and run decantr check plus decantr audit after implementation.
For cold-start harness or certification runs, use only the scaffolded workspace files as the contract. If local scaffold files disagree, stop and report the mismatch rather than relying on repo-global Decantr assumptions.
Related Packages
@decantr/essence-specfor schema and guard validation@decantr/registryfor registry contracts and API access@decantr/verifierfor audit and critique
Docs
License
MIT