Spis/Docs

CLI command

spis catalog-type edit

Edit catalog metadata and optionally rename the catalog directory.

Invocation#

bash
spis catalog-type edit <slug> [--title <title>] [--description <text>] [--status <status>] [--rename <slug>]

Edit catalog metadata and optionally rename the catalog directory.

Inputs and options#

  • <slug> is required. At least one of --title, --description, --status, or --rename must be supplied.

Output and state effects#

Updates sources.json; --rename also changes its slug/catalog fields and renames the directory. It regenerates indexes and prints the changed fields. This is mutating.

Refusals#

These messages are emitted by the current Rust implementation:

  • the following arguments are required: slug
  • PATH does not exist
  • nothing to edit: pass --title, --description, --status, or --rename
  • A conflicting rename target is TARGET already exists; invalid slugs and unmanaged/invalid sources.json have explicit catalog-type: refusals.
  • Unsupported or extra input is unrecognized argument: VALUE.