Documentation
surge is a load tester that tells you what happened, not just what the numbers were. Start with Getting started; the scenario reference is the page you will keep open.
Start here
What surge is
The shape of it in one page, and what it does that a number cannot.
Installing surge
Go, source, a container, Kubernetes, CI — and what it needs from the machine.
Getting started
Point it at something, read the first verdict, then write a real scenario.
Feature map
Everything surge does, in one table, with where each thing is written down.
Write a test
Scenario reference
Every field of a YAML scenario: load, flow, checks, extracts, feeders, thresholds, groups, WebSocket, hooks.
Go library
A scenario as a Go program, for when the thing you are testing is not HTTP.
Protocols & recipes
WebSocket, gRPC, databases, queues, SAP, mainframe, a real browser — and running them anywhere.
Run it
Command reference
Every subcommand and the flags that matter, with the three checks that come before the load.
Configuration
surge.conf, SURGE_* variables and flags — which wins, and where paths resolve from.
Dashboard & control UI
Watching a run as it goes, and starting one from a page that refuses by default.
Across several machines
Sharding with no coordinator, or a coordinator with agents and one merged verdict.
Running in CI
Exit codes instead of output parsing, what to keep, and what not to gate on.
Read the result
Reading the report
The verdict, the caveats, the failures with their evidence, and the eleven things to read in order.
Finding capacity
Search for the highest load that still meets an SLO, and read the knee honestly.
Catching regressions
A band built from several baselines, so the gate fires on a change and not on a Tuesday.
Also
The Claude Code plugin
Six skills and two agents that read the codebase, write the scenario and read the result back as findings.
Questions & fixes
Why the p95 is worse than users see, why every step gets a 401, and what surge does not do.
Design & analysis
How the engine, the histogram and the merge work, and why each is the way it is.
Intake & requirements
What surge set out to be, written before it was built.
Also
The source ships a
Claude Code plugin in plugin/: six skills that read a codebase,
write the scenario, rehearse it against the real system, run it and read
the result back as findings.