Skip to main content
RELAMPO
Documentation
ENES

Relampo Docs

Relampo brings together two complementary experiences:

  • Relampo CLI: command-line tooling for recording, correlation, execution, and YAML-based test workflows.
  • Relampo Cloud: a visual layer for working with Relampo assets and workflows from a web interface. We are building this version now; more information and surprises are coming soon.

This documentation site is organized to help you move from onboarding to daily usage:

  • Getting Started: understand the core workflow and what each command is for.
  • Installation: install the CLI and verify your environment.
  • CLI Reference: command-by-command reference for record, correlate, run, distributed run, and studio.
  • YAML Spec: structure and conventions for Relampo YAML files.
  • Relampo Studio: visual authoring, Debug, and Run documentation.
  • Relampo Skill: guidance for using AI coding agents to create, refine, correlate, debug, and run Relampo tests.
  • WebApp Flow Under Test: end-to-end flow from recording to distributed execution.
  • Release Notes: version-facing changes and rollout notes.

Core workflow​

The standard Relampo lifecycle is:

  1. Capture or start from an initial YAML flow.
  2. Normalize or refine the YAML in Studio.
  3. Detect dynamic values and apply correlations.
  4. Use Studio Debug to inspect failures and iterate.
  5. Run the configured load locally or in distributed mode.

In practice, the commands align with that lifecycle like this:

  1. relampo record
  2. relampo correlate
  3. relampo studio
  4. relampo run

relampo distributed run complements this workflow when you need to execute tests at scale.

How to use this site​

  • Start with Getting Started if you are new to Relampo.
  • Go directly to CLI Reference if you already know the workflow and need command syntax.
  • Use YAML Spec when you need to understand or hand-edit the file format.
  • Use Relampo Studio to work visually with Tree, Code, Debug, Run, and the Studio interface.
  • Use Relampo Skill as support for creating, refining, and troubleshooting Relampo tests.
  • Use WebApp Flow Under Test if you want an end-to-end practical path.

Documentation scope​

This first iteration is intentionally practical:

  • It focuses on operational usage.
  • It avoids guessing undocumented flags or internal behavior.
  • It is designed to be expanded as the CLI and Studio evolve.