CLI reference

Every command of the openregs CLI, generated from the parser in tooling/openregs/cli/main.py at cbe9615 — never transcribed, so a flag cannot change without this page changing with it.

openregs [-h] [--version] <command> ...

Global option
--version	print the version, the schema majors this build reads, and the build commit (default ==SUPPRESS==)

Commands

Command
openregs validate	validate a document against its schema in spec/schemas/
openregs resolve	follow superseded_by pointers from a retired id to the current one
openregs ingest	poll sources, durably enqueue what they discover, then advance their cursors
openregs replay	re-run the transform over stored snapshots, rewriting only what changed
openregs fetch-expression	capture one sibling language Expression of a Work already in canon
openregs normalize	map a captured source document to Akoma Ntoso and report the mapping
openregs amendments	read an amending act’s instructions as structured operations
openregs quarantine	work the queue of documents a validation gate held for a person
openregs consolidate	apply an amending act to a base Expression and write the point-in-time text
openregs verify	check that stored artefacts still match the digests they are stored under
openregs index	work with cross-regime index combinations
openregs graph	work with a regime’s cross-reference graph
openregs defs	the defined terms that apply to a unit on a date, and what defines them
openregs atomize	propose obligation atoms from a unit, on a branch, for a human to review
openregs text	the text of a unit on a date, on either time axis
openregs review	the review workflow: protect a branch, approve, report checks, merge
openregs release	build a dated content release from the canon at one commit
openregs diff	what changed between two built releases of one regime
openregs coverage	the auditor-facing coverage report for one control mapping
openregs eval	score a release against the adversarial retrieval eval
openregs feed	the outbound release feed: subscriptions, webhooks, JSON and RSS
openregs serve	answer questions over a release, with citations, on HTTP
openregs pull	vendor a release from a registry, verifying it before it is unpacked
openregs backup	back up and restore the two stores that are not a function of a commit
openregs impact	what moving between two releases does to a control mapping
openregs bump	open the release-bump pull request in a consuming repository
openregs compile	code-generate typed constants from a release’s executable blocks