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.
gateway-facet-resync
Bash
revenexx search gateway-facet-resync
| Flag | Required | Description |
|---|---|---|
--app <app> | — | |
--vendor <vendor> | — |
get-collection
Bash
revenexx search get-collection \
--collection products
| Flag | Required | Description |
|---|---|---|
--collection <collection> | A collection the tenant owns (see \ |
get-document
Bash
revenexx search get-document \
--collection products \
--document-id ''
| Flag | Required | Description |
|---|---|---|
--collection <collection> | A collection the tenant owns (see \ | |
--document-id <document-id> | The document's \ |
list-collections
Bash
revenexx search list-collections
| Flag | Required | Description |
|---|---|---|
--filter <column=value> | Filter rows by column equality (repeatable). |
multi-search
Bash
revenexx search multi-search \
--searches one two three
| Flag | Required | Description |
|---|---|---|
--searches [searches...] | The searches to run, in order. Must not be empty. |
search-documents
Bash
revenexx search search-documents \
--collection products
| Flag | Required | Description |
|---|---|---|
--collection <collection> | A collection the tenant owns (see \ | |
--exclude-fields <exclude-fields> | Comma-separated document fields to omit. | |
--facet-by <facet-by> | Comma-separated fields to facet on. | |
--filter-by <filter-by> | Filter expression, e.g. \ | |
--group-by <group-by> | Comma-separated fields to group results by. | |
--highlight-full-fields <highlight-full-fields> | Comma-separated fields to highlight in full. | |
--include-fields <include-fields> | Comma-separated document fields to return. | |
--max-facet-values <max-facet-values> | Facet values to return per field. | |
--num-typos <num-typos> | Typos tolerated per query token. | |
--page <page> | 1-based page number. | |
--per-page <per-page> | Hits per page. | |
--prefix <prefix> | Whether the last token is a prefix; per-field when comma-separated. | |
--q <q> | Query text. Use \ | |
--query-by <query-by> | Comma-separated fields to search, in weight order. | |
--sort-by <sort-by> | Sort expression, e.g. \ |
search-documents-get
Bash
revenexx search search-documents-get \
--collection products
| Flag | Required | Description |
|---|---|---|
--collection <collection> | A collection the tenant owns (see \ | |
--q <q> | Query text. Use \ | |
--query-by <query-by> | Comma-separated fields to search, in weight order. | |
--filter-by <filter-by> | Filter expression, e.g. \ | |
--sort-by <sort-by> | Sort expression, e.g. \ | |
--facet-by <facet-by> | Comma-separated fields to facet on. | |
--max-facet-values <max-facet-values> | Facet values to return per field. | |
--group-by <group-by> | Comma-separated fields to group results by. | |
--include-fields <include-fields> | Comma-separated document fields to return. | |
--exclude-fields <exclude-fields> | Comma-separated document fields to omit. | |
--highlight-full-fields <highlight-full-fields> | Comma-separated fields to highlight in full. | |
--num-typos <num-typos> | Typos tolerated per query token. | |
--prefix <prefix> | Whether the last token is a prefix; per-field when comma-separated. | |
--page <page> | 1-based page number. | |
--per-page <per-page> | Hits per page. |