CLI command
spis docs-corpus search
Search crawled documentation titles, URLs, and extracted text.
Invocation#
spis docs-corpus search --query <text> [--site <slug>] [--limit <n>]Search crawled documentation titles, URLs, and extracted text.
Inputs and options#
--query <text>is required and must be non-empty.--limit <n>stops the search once it holds n hits; without it the search answers every hit. Spis chooses no default.--site <slug>searches only the site with that slug; without it every site with a selected corpus is searched.
Output and state effects#
Streams local gzip JSONL archives, then prints one pretty JSON object with hits, scanned, and limit; limit is null when none was given.
Refusals#
These messages are emitted by the current Rust implementation:
- A missing flag value is refused as
--query needs a value,--site needs a value, or--limit needs a value. - An absent or empty query is refused as
--query required. - Unknown input is refused as
unknown argument: VALUE; a limit that is not a positive whole number, zero included, is refused as--limit: "VALUE" is not valid: REASON.