Documents default values in the CLI

  Find more information at https://quickwit.io/docs



Usage: quickwit [OPTIONS] <COMMAND>

Commands:
  run     Starts a Quickwit node.
  index   Manages indexes: creates, deletes, ingests, searches, describes...
  source  Manages sources: creates, updates, deletes sources...
  split   Manages splits: lists, describes, marks for deletion...
  tool    Performs utility operations. Requires a node config.

Options:
      --no-color  Disable ANSI terminal codes (colors, etc...) being injected into the logging output [env: NO_COLOR=]
  -y, --yes       Assume "yes" as an answer to all prompts and run non-interactively.
  -h, --help      Print help
  -V, --version   Print version
➜  quickwit-dynajson cat ~/data/gharchive.json  | ./quickwit index ingest --index gharchive4  --v2  --help
Reads NDJSON documents from a file or streamed from stdin and sends them into ingest API.

Usage: quickwit index ingest [OPTIONS] --index <INDEX>

Options:
      --no-color
          Disable ANSI terminal codes (colors, etc...) being injected into the logging output
          
          [env: NO_COLOR=]

      --endpoint <QW_CLUSTER_ENDPOINT>
          Quickwit cluster endpoint.
          
          [env: QW_CLUSTER_ENDPOINT=]
          [default: http://127.0.0.1:7280]

      --index <INDEX>
          ID of the target index

      --input-path <INPUT_PATH>
          Location of the input file.

  -y, --yes
          Assume "yes" as an answer to all prompts and run non-interactively.

      --batch-size-limit <BATCH_SIZE_LIMIT>
          Size limit of each submitted document batch.

      --timeout <timeout>
          Duration of the timeout.

      --connect-timeout <connect-timeout>
          Duration of the connect timeout.

  -w, --wait
          Wait for all documents to be commited and available for search before exiting

  -f, --force
          Force a commit after the last document is sent, and wait for all documents to be committed and available for search before exiting

      --commit-timeout <commit-timeout>
          Duration of the commit timeout operation.

  -h, --help
          Print help (see a summary with '-h')

In the help we don't tell what are the default values for timeout batch-size-limit etc.

Start from the option definitions behind quickwit index ingest --help, focusing on timeout, batch-size-limit, and the other options with defaults. Update the generated CLI help to show those defaults, then rerun the displayed command and verify that the relevant default values appear.