Utility Commands

Tags reference cli

This page covers smaller utility commands for dependency checking, system profiling, benchmark discovery, and configuration validation.

check-deps - Check Dependencies

Check dependency status and provide installation guidance for different platforms.

Options

  • --platform TEXT: Check dependencies for specific platform

  • --verbose, -v: Show detailed dependency information

  • --matrix: Show installation matrix and exit

Usage Examples

# Overview of all platform dependencies
benchbox check-deps

# Check specific platform
benchbox check-deps --platform databricks

# Show detailed installation matrix
benchbox check-deps --matrix

# Verbose output with recommendations
benchbox check-deps --verbose

profile - System Profiling

Profile the current system to understand hardware capabilities and provide recommendations.

Usage

benchbox profile

This command analyzes:

  • CPU cores and architecture

  • Memory capacity and availability

  • Disk space

  • Operating system details

  • Python environment

Provides recommendations for:

  • Appropriate scale factors

  • Concurrency settings

  • Platform selection

benchmarks - Manage Benchmark Suites

Manage and browse available benchmark suites.

Subcommands

benchmarks list

Display all available benchmark suites with descriptions.

benchbox benchmarks list

Shows information about:

  • TPC-H, TPC-DS, TPC-DI (official TPC benchmarks)

  • ClickBench, H2ODB (industry benchmarks)

  • SSB, AMPLab (academic benchmarks)

  • ReadPrimitives, WritePrimitives, TPC-Havoc (testing benchmarks)

validate - Validate Configuration

Validate BenchBox configuration files for syntax and completeness.

Options

  • --config TEXT: Configuration file path (optional)

Usage Examples

# Validate default configuration
benchbox validate

# Validate specific configuration file
benchbox validate --config ./custom-config.yaml