title: Command Reference parent: Reference nav_order: 50 has_children: true

Command Reference

Reference documentation for all solr-orbit subcommands and their flags.

CommandDescription
aggregateCombine results from multiple benchmark runs
compareCompare two benchmark runs side by side
convert-workloadConvert an OpenSearch Benchmark workload to Solr format
create-workloadCreate a workload definition from an existing Solr collection
downloadDownload a Solr distribution without running a benchmark
generate-dataGenerate synthetic data from an index schema or custom module
infoShow detailed information about a workload
installInstall a Solr node locally (for manual lifecycle control)
listList available workloads, telemetry, pipelines, or past runs
runRun a benchmark workload
startStart a locally installed Solr node
stopStop a locally installed Solr node
visualizeGenerate an HTML visualization for a completed run

Daemon

The solr-orbitd binary manages worker daemon processes for distributed load generation. See solr-orbitd for the full reference.

Common options

The following flags are accepted by every solr-orbit subcommand.

FlagShortDescription
--help-hDisplay help text for the current command and exit
--offlineRun without network access; disables workload repository fetching and any update checks