Spis/Docs

CLI command

spis generate-example-catalogs

Validate every discovered catalog, full reference index, record, and retained evidence file, then optionally regenerate catalog indexes.

Invocation#

bash
spis generate-example-catalogs [--check]

Validate every discovered catalog, full reference index, record, and retained evidence file, then optionally regenerate catalog indexes.

Inputs and options#

  • --check is optional and makes the command validation-only. --help/-h prints usage.

Output and state effects#

--check prints per-catalog complete/partial/provenance summaries and writes nothing. Without it, the command writes each catalog README plus the root JSON/Markdown indexes from validated data.

Refusals#

These messages are emitted by the current Rust implementation:

  • Any unknown input is refused as unknown argument: VALUE.
  • An empty checkout is refused as no catalogs with measured references were found.
  • Schema, path, index, or evidence contradictions are refused by the corresponding source-grounded validation error before generation.