perfscale documentation

perfscale is a single CLI for running load tests with k6, locust, or perfscale's own native step engine — plus a tiny local dev server for collecting results.

Start here

• Getting started — install, first run, first results
• YAML reference — the test.yaml / config.yaml formats

CLI (perfscale binary)

• Commands — run, serve, lint, and schema reference
• Recipes — copy-paste examples for common workflows
• Benchmarks — engine comparison methodology & CI runs
• MCP server — drive perfscale from AI agents over the Model Context Protocol

Core (perfscale-core library)

• Architecture — how the pieces fit together
• Runners — k6, locust, and the native engine
• Actions — std/http, std/tcp, std/udp, std/ws* (WebSocket), std/grpc* (gRPC), std/check, std/sleep, std/log, std/file-*
• WebSocket guide — sessions, live connections, message RTT, assertions
• gRPC guide — dynamic schemas (reflection / descriptor sets), unary calls, streams

For contributors

• Repository README — layout, local development, release builds
• Examples — runnable sample files for each engine
• JSON Schemas — generated schemas for editor autocomplete