Skip to content

spatialpack benchmark

Terminal window
spatialpack benchmark <command> [options]

Pack quality benchmark commands.

Run quality benchmarks against built PMTiles files with configurable metrics and pass/fail gates. Suitable for CI regression testing.

CommandDescription
benchmark runRun a benchmark against a PMTiles file.
Terminal window
# Inspect an existing PMTiles file
spatialpack benchmark run pipelines/wa-road-z10.benchmark.yaml
# Build pipeline first, then inspect output
spatialpack benchmark run pipelines/wa-road-z10.benchmark.yaml --build
# Custom result output directory
spatialpack benchmark run spec.yaml --output ./benchmark-results/

Run a benchmark against a PMTiles file.

SPEC_PATH is the path to a .benchmark.yaml file.

Exit codes: 0 — all gates passed 1 — one or more gates failed 2 — runtime error (missing file, load failure, infrastructure error)

Terminal window
spatialpack benchmark run SPEC_PATH [options]

SPEC_PATH — path (required)

Options:

OptionTypeDefaultDescription
--buildflagfalseRun pipeline build (from spec’s pipeline_spec field) before inspecting
--outputpath-Override default result output directory (default: benchmarks/results/)
Terminal window
# Inspect existing PMTiles
spatialpack benchmark run pipelines/wa-road-z10.benchmark.yaml
# Build pipeline first
spatialpack benchmark run pipelines/wa-road-z10.benchmark.yaml --build
# Custom output directory
spatialpack benchmark run spec.yaml --output ./ci-results/