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, with a runnable example and the flags it accepts. Each flag is an API field: its type, allowed values and meaning are in the API reference. 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.

events

Bash

revenexx search events \
    --collection '' \
    --type click

Flags: --collection <collection> --type <type> --doc-id <doc-id> --position <position> --q <q> --query-id <query-id> --user-token <user-token>

gateway-facet-resync

Bash

revenexx search gateway-facet-resync

Flags: --app <app> --vendor <vendor>

get-collection

Bash

revenexx search get-collection \
    --collection categories

Flags: --collection <collection>

get-document

Bash

revenexx search get-document \
    --collection categories \
    --document-id ''

Flags: --collection <collection> --document-id <document-id>

list-collections

Bash

revenexx search list-collections

Flags: --filter <column=value>

multi-search

Bash

revenexx search multi-search \
    --searches one two three

Flags: --searches [searches...]

query

Bash

revenexx search query \
    --collection ''

Flags: --collection <collection> --filters <filters> --page <page> --per-page <per-page> --q <q> --sort <sort> --view <view>

search-documents

Bash

revenexx search search-documents \
    --collection categories

Flags: --collection <collection> --exclude-fields <exclude-fields> --facet-by <facet-by> --filter-by <filter-by> --group-by <group-by> --highlight-full-fields <highlight-full-fields> --include-fields <include-fields> --max-facet-values <max-facet-values> --num-typos <num-typos> --page <page> --per-page <per-page> --prefix <prefix> --q <q> --query-by <query-by> --sort-by <sort-by>

search-documents-get

Bash

revenexx search search-documents-get \
    --collection categories

Flags: --collection <collection> --q <q> --query-by <query-by> --filter-by <filter-by> --sort-by <sort-by> --facet-by <facet-by> --max-facet-values <max-facet-values> --group-by <group-by> --include-fields <include-fields> --exclude-fields <exclude-fields> --highlight-full-fields <highlight-full-fields> --num-typos <num-typos> --prefix <prefix> --page <page> --per-page <per-page>

suggest

Bash

revenexx search suggest \
    --q ''

Flags: --q <q> --collections [collections...] --per-page <per-page>

Was this page helpful?