Command Reference
Reference documentation for all solr-benchmark subcommands and their flags.
| Command | Description |
|---|---|
| aggregate | Combine results from multiple benchmark runs |
| compare | Compare two benchmark runs side by side |
| convert-workload | Convert an OpenSearch Benchmark workload to Solr format |
| create-workload | Create a workload definition from an existing Solr collection |
| download | Download a Solr distribution without running a benchmark |
| generate-data | Generate synthetic data from an index schema or custom module |
| info | Show detailed information about a workload |
| install | Install a Solr node locally (for manual lifecycle control) |
| list | List available workloads, telemetry, pipelines, or past runs |
| run | Run a benchmark workload |
| start | Start a locally installed Solr node |
| stop | Stop a locally installed Solr node |
| visualize | Generate an HTML visualization for a completed run |
Daemon
The solr-benchmarkd binary manages worker daemon processes for distributed load generation. See solr-benchmarkd for the full reference.
Common options
The following flags are accepted by every solr-benchmark subcommand.
| Flag | Short | Description |
|---|---|---|
--help | -h | Display help text for the current command and exit |
--offline | — | Run without network access; disables workload repository fetching and any update checks |