openregs coverage

The auditor-facing coverage report for one control mapping.

For every obligation in a release that binds an entity profile on a date, state whether the organisation’s controls.yaml maps it, waives it, or neither. Exports a JSON document and a self-contained HTML report — one file, no stylesheet, script or font fetched — stamped with the release tag, the commit, the as-of date and the generation time. Every gap is listed individually with its citation, and mapped plus waived plus unmapped equals applicable by construction. Applicability is decided from the release: an obligation a derogation in force disapplies for this entity type is reported as not applicable, with the derogating provision cited.

openregs coverage [-h] --map <controls.yaml> --entity-profile <profile>
                         [--release <regime>@<tag>] [--as-of <YYYY-MM-DD>] [--json <path>]
                         [--html <path>] [--generated-at <timestamp>] [--root <path>]

Option
--map <controls.yaml>	the organisation’s control mapping (required)
--entity-profile <profile>	the profile to report for: a path to a profile file, or a declared profile id (required)
--release <regime>@<tag>	the release to report against; defaults to the one the mapping pins
--as-of <YYYY-MM-DD>	the date to report as of; defaults to the release’s own as_of
--json <path>	write the JSON report here; - writes it to stdout
--html <path>	write the HTML report here
--generated-at <timestamp>	the generation time to stamp, instead of the wall clock — the one value in the report that is not a function of its inputs, so pinning it makes the bytes reproducible
--root <path>	repo root