Quickstart
This guide gets you from zero to a Valinor-governed repo: install the CLI, propagate the doctrine, and run the gates locally.
Install
Valinor is published to GitHub Packages under the @cmbrcreative scope. You can run it ad hoc with npx, or add it as a dev dependency.
Install
npx @cmbrcreative/valinor <command> [path]
GitHub Packages requires an .npmrc that authenticates @cmbrcreative against
npm.pkg.github.com. The scaffolded valinor-gates workflow wires that up in CI
using a short-lived GitHub App token. The org-side prerequisites for that (the
Valinor App, the VALINOR_APP_ID + VALINOR_APP_PRIVATE_KEY credentials, and a
connected Greptile) are the
Prerequisites.
Scaffold governance into a repo
init propagates the versioned doctrine into the target repo's AGENTS.md≡CLAUDE.md and scaffolds the minimum to run the gates — governance.config.yml, a starter claims.yml, a README.md, .greptile/config.json (the review rubrics), and the valinor-gates workflow.
Scaffold
npx @cmbrcreative/valinor init ./my-repo \
--profile library --maturity greenfield --mode strict --stack node-ts
See the init reference for every flag and the exact scaffold contents.
Run the gates
Each gate is offline, deterministic, and fails closed. The path-agnostic gates scan the working directory; the config-driven gates read your claims.yml / governance.config.yml.
Run gates
npx @cmbrcreative/valinor claims-verify claims.yml
npx @cmbrcreative/valinor check-doc-freshness
npx @cmbrcreative/valinor check-docs-coverage