index.md

Reference Documentation

Complete reference documentation for BenchBox APIs, CLI, and data formats.

Command Line Interface

• CLI Reference - Complete command-line interface documentation
  • run - Primary benchmark execution command
  • convert - Convert data to Parquet, Vortex, Delta Lake, or Iceberg
  • shell - Interactive SQL shell
  • platforms - Platform management
  • results - Export, view, and compare results
  • tuning - Tuning configuration commands
  • utilities - Utility commands

Python API

• API Reference - Python API overview
• Python API Documentation - Detailed API reference
• Public Contracts and Support Taxonomy - Compatibility tiers, support status vocabulary, and source-of-truth map

Integrations

• MCP Server Reference - Model Context Protocol server for AI assistants

Data Formats & Schemas

• Result Export Formats - Comprehensive guide to JSON, CSV, HTML exports
• Tuning Platform Support - Which tuning types each platform applies and which can reach applied_verified
• Result Schema v1.0 - Benchmark result JSON schema specification
• Backward Compatibility Registry - Lifecycle policy and shim tracking process

Related Documentation

• Usage Guides - Practical usage examples
• How-To Guides - Task-oriented guides
• Platform Documentation - Platform-specific reference

:maxdepth: 2

cli/index
cli
api-reference
public-contracts
mcp
result-formats
tuning-platform-support
result-schema-v1
backward-compatibility
python-api/index
python-api/platforms