Search commands

Reference for the `revenexx search` commands — every subcommand with a runnable example.

Auto-generated. This page is generated from the revenexx CLI by tools/sync-cli-reference.mjs. Don't edit it by hand — your changes will be overwritten.

Every revenexx search subcommand. The example shows the required arguments; the options table lists every flag the command accepts, with a ✓ marking required flags. Some flag names carry a -_ (e.g. --attribute-_values) — that is the exact token the CLI accepts, so copy them verbatim. Run revenexx search <command> --help for the live options.

get-document

Bash
revenexx search get-document \
    --collection '' \
    --document-id ''
FlagRequiredDescription
--collection <collection>Collection key (one the tenant has installed).
--document-id <document-id>Document id within the collection.

list-collections

Bash
revenexx search list-collections
FlagRequiredDescription
--filter <column=value>Filter rows by column equality (repeatable).
Bash
revenexx search multi-search \
    --searches one two three
FlagRequiredDescription
--searches [searches...]

search-documents

Bash
revenexx search search-documents \
    --collection ''
FlagRequiredDescription
--collection <collection>Collection key (one the tenant has installed).
--facet-by <facet-by>Comma-separated fields to facet on.
--filter-by <filter-by>Filter expression, e.g. \
--page <page>
--per-page <per-page>
--q <q>Query text. Use \
--query-by <query-by>Comma-separated fields to search.
--sort-by <sort-by>Sort expression, e.g. \

search-documents-get

Bash
revenexx search search-documents-get \
    --collection ''
FlagRequiredDescription
--collection <collection>Collection key (one the tenant has installed).
--q <q>Query text. Use \
--query-by <query-by>Comma-separated fields to search.
--filter-by <filter-by>Filter expression.
--sort-by <sort-by>Sort expression.
--page <page>1-based page.
--per-page <per-page>Hits per page (max 250).
Was this page helpful?