Spis
Spis
Spis/Docs

CLI command

spis reference-record get

Read one reference by one-based number or normalized name/slug.

Invocation#

bash
spis reference-record get <catalog> <NN|slug>

Read one reference by one-based number or normalized name/slug.

Inputs and options#

  • Both <catalog> and <NN|slug> are required. A catalog name may omit the -examples suffix.

Output and state effects#

Prints one pretty JSON object containing the catalog example, index entry, and full record. No files are changed.

Refusals#

These messages are emitted by the current Rust implementation:

  • Missing positionals use reference: the following arguments are required: catalog identifier (or the remaining name).
  • reference: CATALOG-examples does not exist
  • reference: record "IDENTIFIER" not found in CATALOG-examples
  • Unknown flags are refused as reference: unrecognized argument FLAG.