Spis
Spis
Spis/Docs

CLI command

spis docs-corpus show

Return the archived JSON record for one exact URL in one documentation corpus.

Invocation#

bash
spis docs-corpus show --site <slug> --url <exact-url>

Return the archived JSON record for one exact URL in one documentation corpus.

Inputs and options#

  • --site <slug> and --url <exact-url> are both required; URL matching is exact.

Output and state effects#

Reads $HOME/.spis/docs-corpus/<slug>/pages.jsonl.gz and prints the matching stored JSON object unchanged. It does not mutate state.

Refusals#

These messages are emitted by the current Rust implementation:

  • show needs --site <slug>
  • show needs --url <url>
  • no corpus file for SLUG
  • url not found in the SLUG corpus (or archive still being written)
  • Unknown input is refused as unknown argument: VALUE.