Spis/Docs

CLI command

spis docs-corpus

Expose read-only JSON views over the crawled documentation corpus in `$HOME/.spis/docs-corpus`.

Invocation#

bash
spis docs-corpus <status|search|show> [flags]

Expose read-only JSON views over the crawled documentation corpus in $HOME/.spis/docs-corpus.

Subcommands#

  • `status` — summarize every inventory and local crawl state.
  • `search` — scan archived page text and metadata.
  • `show` — return one exact archived URL.

Inputs and options#

  • Choose one public leaf: status, search, or show.
  • Leaf-specific required inputs and options are documented on the linked pages.

Output and state effects#

Every leaf prints exactly one JSON document and does not mutate the corpus.

Refusals#

These messages are emitted by the current Rust implementation:

  • No leaf is refused with usage: spis docs-corpus status | search --query T [--site S] [--limit N] | show --site S --url U.
  • Unknown input is refused as unknown argument: VALUE.