Skip to content

visualize.md

Latest commit

 

History

History
65 lines (43 loc) · 2.08 KB

visualize.md

File metadata and controls

65 lines (43 loc) · 2.08 KB
Raw

(cli-visualize)=

visualize - Generate Charts

Generate ASCII charts from benchmark result files directly in the terminal.

Basic Syntax

benchbox visualize [SOURCES...] [OPTIONS]

Arguments

  • SOURCES: One or more paths to benchmark result JSON files. If omitted, auto-discovers the 5 most recent results from benchmark_runs/results/.

Options

  • --chart-type TEXT: Chart type to render (default: auto). Can be specified multiple times.
    • auto or all: Render all applicable chart types
    • Specific types: performance_bar, query_time_histogram, speedup, comparison, and others
  • --template TEXT: Named template that defines a preset combination of chart types (overrides --chart-type)
  • --theme [light|dark]: Color theme (default: light)
  • --no-color: Disable ANSI colors in output (useful for piping to files)
  • --no-unicode: Use ASCII-only characters (for terminals without Unicode support)

Usage Examples

benchbox visualize

benchbox visualize benchmark_runs/results/duckdb_tpch_sf01.json

benchbox visualize result_a.json result_b.json --chart-type speedup

benchbox visualize result.json --chart-type performance_bar

benchbox visualize result.json --template overview

benchbox visualize result.json --no-color --no-unicode > charts.txt

benchbox visualize result.json --theme dark

In order, the commands:

  • Auto-discover recent results and render all applicable charts.
  • Visualize a specific result file.
  • Compare two results side by side.
  • Render a specific chart type.
  • Use a named template.
  • Produce pipe-friendly output (no color, no unicode).
  • Use a dark theme for dark terminal backgrounds.

Notes

  • Pairwise comparison charts (e.g., speedup) require exactly 2 result files when specified explicitly. When using auto or all, pairwise charts are skipped if the input count doesn't match.
  • Chart types can be listed with benchbox visualize --help.

Related

  • run - Run benchmarks to generate result files
  • results - View and export benchmark results