Spis
Spis
Spis/Docs

CLI command

spis reference-record add

Add one numbered, honestly partial reference scaffold to a managed catalog.

Invocation#

bash
spis reference-record add <catalog> --name <name> --source-url <url> --category <category> --selection-note <text> --visual <file> [--owner <url>]

Add one numbered, honestly partial reference scaffold to a managed catalog.

Inputs and options#

  • Required: catalog positional plus --name, --source-url, --category, --selection-note, and --visual.
  • --owner <url> is optional and becomes upstream ownership/source-image provenance; otherwise the source URL is used.

Output and state effects#

Copies the supplied visual into the catalog, measures its dimensions and SHA-256, adds an example plus a seven-gap partial reference.json, updates counts/indexes, regenerates the root index, and prints added CATALOG/NN-slug: NAME (7 named gaps, status partial).

Refusals#

These messages are emitted by the current Rust implementation:

  • Missing inputs use reference: the following arguments are required: ....
  • reference: CATALOG-examples does not exist
  • reference: --visual PATH is not a file or reference: cannot read image dimensions: PATH
  • reference: a record named "NAME" already exists
  • Unknown flags are refused as reference: unrecognized argument FLAG.