Usage Overview

Tags beginner quickstart

BenchBox keeps everyday workflows concise. Use this page as the jumping-off point for the tasks you perform most often.

Essentials

• Getting started in 5 minutes — install the tool, profile your system, and execute a reproducible first run.

• CLI quick reference — most-used commands and flags for interactive and unattended runs.

• Configuration handbook — YAML layouts, environment overrides, and precedence rules.

• Examples & automation snippets — copyable scripts for Python and shell automation.

• Python API reference — when you need to orchestrate runs programmatically.

Extended Topics

• Dry-run previews — validate queries, seeds, and artifacts without executing them.

• Data generation & compression — storage footprint guidance and compression toggles.

• Intelligent guidance — how the CLI adapts recommendations to your hardware profile.

• Platform selection guide — compare adapter capabilities before running at scale.

• Troubleshooting — fix common environment and dependency issues fast.

Next Steps

1. Run uv run benchbox profile to capture a baseline system profile.

2. Pick a platform with uv run benchbox platforms list and enable it if required.

3. Execute a benchmark with uv run benchbox run --platform duckdb --benchmark tpch --scale 0.01.

4. Inspect results via uv run benchbox results --limit 1 or export JSON for CI with uv run benchbox export.

Bookmark this page to keep the most relevant references a single click away.