Relampo CLI

Relampo CLI records, correlates, and executes performance tests described in YAML. Relampo Studio is the visual workspace for refining, debugging, and running those scripts.

Typical workflow

relampo record -> relampo correlate -> relampo studio -> Debug -> Run -> relampo distributed run

If you start from an existing API collection or another source format, use the Relampo Skill to prepare a YAML script before opening it in Studio.

What you can do

• record HTTP traffic into a YAML script
• detect and apply dynamic correlations
• author and validate a script in Relampo Studio
• inspect a flow with visual Debug using one or two VUs
• execute configured load with Studio Run or relampo run
• export local reports and scale execution with distributed mode

Step-by-step

1. Verify installation

relampo --help

2. Record a starting flow

relampo record --port 8888 --responses --output my-test.yaml

Stop recording with Ctrl+C. Recorded responses are useful when the flow needs correlation.

3. Review dynamic values

relampo correlate my-test.yaml
relampo correlate my-test.yaml --apply

4. Open Relampo Studio

relampo studio my-test.yaml

Use Studio to refine requests, variables, assertions, extractors, controllers, and load configuration. You can save or download the modified YAML with or without the recorded request responses.

5. Debug visually

Run Debug in Studio with one or two VUs. Inspect failed requests in Overview, Request, Response, Assertions, Variables, and Logs; use search and filters to locate a text, regular expression, or specific criterion.

6. Run the configured load

Use Run in Studio for visual execution, or use the CLI to keep local report files:

relampo run my-test.yaml --json results.json --html results.html --csv results.csv --text results.txt

7. Scale with distributed execution

When the script is ready, use relampo distributed run to execute it across GitHub Actions nodes and collect aggregated results.

Quick reference

Goal	Command or workspace
Capture traffic	relampo record
Detect dynamic values	relampo correlate
Edit, save, Debug, and Run visually	relampo studio [script.yaml]
Run locally and export reports	relampo run
Run at scale	relampo distributed run