CLI reference
Spis command-line interface
One source-grounded page for every public top-level command and every public leaf subcommand in the maintained Rust dispatcher.
Invocation#
spis <subcommand> [flags]The maintained entry point is the Rust binary built from src/main.rs. Top-level help is spis --help; a successful command exits 0, an ordinary command error exits 1, and a usage error exits 2: an unknown top-level command (unknown subcommand: NAME and the usage), a subcommand's usage line, an unknown argument or action, a flag that needs a value and has none, and a value out of range such as --limit must be between 1 and 10000.
Crawlers#
Corpus and catalog commands#
- `docs-corpus`: `status`, `search`, `show`
- `discover`
- `crawl`: `start`, `status`, `resume`, `import`
- `reference-record`: `add`, `get`, `remove`
- `catalog-type`: `add`, `edit`, `remove`
- `verify-reference-evidence`
- `check-upstream-drift`
- `generate-example-catalogs`
- `analyze-example-structures`
- `collect-example-images`
Capture and audit commands#
- `capture-widths`
- `audit-reference-accessibility`
- `capture-cli-references`
- `serve`: the loopback backend Spis Desktop runs