This section provides comprehensive documentation for all BenchBox command-line interface (CLI) commands and options.
These options are available for all BenchBox commands:
--version: Show version information and exit--help: Show help message and exit
BenchBox provides the following commands:
| Command | Purpose | Documentation |
|---|---|---|
run |
Execute benchmarks with full configuration control | run |
convert |
Convert data to Parquet, Vortex, Delta Lake, or Iceberg | convert |
shell |
Launch interactive SQL shell for database | shell |
platforms |
Manage database platform adapters | platforms |
check-deps |
Check dependency status and installation guidance | utilities |
profile |
Profile system resources | utilities |
benchmarks |
Manage benchmark suites | utilities |
validate |
Validate configuration files | utilities |
tuning init |
Generate sample tuning configurations | tuning |
tuning (DataFrame) |
DataFrame tuning via unified tuning commands | tuning |
export |
Export benchmark results to various formats | results |
submit |
Package results for PR contribution or hosted API upload | submit |
auth |
Manage hosted submission credentials | auth |
results |
Display exported benchmark results | results |
compare |
Compare benchmark results for regression detection | results |
visualize |
Generate ASCII charts from benchmark results | visualize |
report |
Historical analysis, rankings, and regressions | report |
metrics |
Calculate TPC performance metrics (QphH) | metrics |
aggregate |
Aggregate results into CSV performance trends | aggregate |
datagen |
Generate benchmark data without running queries | datagen |
setup |
Interactive cloud platform credential setup | setup |
show-plan |
Display query plan as ASCII tree | query-plans |
plan-history |
Show query plan evolution across runs | query-plans |
download-answers |
Pre-download TPC answer files for validation | download-answers |
# Run a simple TPC-H benchmark on DuckDB
benchbox run --platform duckdb --benchmark tpch --scale 0.01
# Get help for any command
benchbox run --help
benchbox run --help-topic all # All options including advanced
benchbox run --help-topic examples # Categorized usage examples:maxdepth: 1
:caption: CLI Commands
run
convert
shell
platforms
utilities
tuning
results
submit
auth
visualize
report
metrics
aggregate
datagen
setup
query-plans
download-answers
configuration
workflows