Skip to main content

Relampo Docs

Relampo provides two complementary products:

  • Relampo CLI: command-line tooling for recording, correlation, execution, debugging, and YAML-based test workflows.
  • Relampo E2E UI: a visual layer for working with Relampo assets and workflows from a browser-based interface. We are actively working on this version; more details 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, debug, run, distributed run, converter, and editor.
  • YAML Spec: structure and conventions for Relampo YAML files.
  • WebApp Flow Under Test: end-to-end flow from recording to distributed execution.
  • Release Notes: version-facing changes and rollout notes.
  • Relampo E2E UI: high-level product documentation for the UI experience.

Core workflow

The standard Relampo lifecycle is:

  1. Capture or import an initial flow.
  2. Normalize or refine the generated YAML.
  3. Detect dynamic values and apply correlations.
  4. Validate and run the scenario.
  5. Debug failures and iterate.

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

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

converter, editor, and distributed run complement this by helping you import, refine, and 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 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 the E2E UI evolve.