Spis/Docs

CLI command

spis catalog-type add

Create an empty managed catalog scaffold.

Invocation#

bash
spis catalog-type add <slug> --title <title> --description <text>

Create an empty managed catalog scaffold.

Inputs and options#

  • <slug>, non-empty --title <title> and non-empty --description <text> are required; the corpus refuses a catalog without a description, so add refuses before creating anything (--description is required for add).

Output and state effects#

Creates <slug>-examples/, its references/ directory, sources.json, and references.json with zero records and scaffolded status; regenerates indexes; then prints added PATH (TITLE); scaffolded with zero records.

Refusals#

These messages are emitted by the current Rust implementation:

  • the following arguments are required: slug
  • --title is required for add
  • slug must be lowercase kebab-case, got "SLUG"
  • PATH already exists
  • Unsupported or extra input is unrecognized argument: VALUE; a failed generator is index regeneration refused the change: ....