Quick Start¶

Prerequisites¶

• Node.js 18 or newer
• A benchmark config file in JSON or YAML

Install and build¶

npm install
npm run build

Generate a starter config¶

glockit example -o benchmark.json

Run a benchmark¶

glockit run -c benchmark.json

Save reports¶

glockit run -c benchmark.json --save --reporters json,csv,html,junit

Import existing API definitions¶

glockit import -i openapi.yaml --type openapi -o benchmark.imported.json
glockit import -i collection.json --type postman -o benchmark.imported.json
glockit import -i traffic.har --type har -o benchmark.imported.json

Common next steps¶

• Tune concurrency, duration, and request delay
• Add assertions and response checks
• Enable diagnostics and observability
• Move to distributed mode for large workloads

Practical examples¶

• Start with Examples Overview to pick a scenario by outcome.
• For HTTP smoke and load patterns, see HTTP Smoke and Load
• For WebSocket checks, see WebSocket Check
• For gRPC unary runs, see gRPC Unary
• For coordinator/worker distributed runs, see Distributed Coordinator and Workers
• For import-driven workflows, see Import OpenAPI to Benchmark
• For CI artifact publishing, see CI Reporting Workflow

Example¶

# First run (baseline)
glockit run --config benchmark.json --save

# Compare another run with saved baseline output
glockit run --config benchmark.json --compare-with ./benchmark-latest.json