Skip to main content
RELAMPO
Documentation
ENES

record

relampo record captures real HTTP(S) traffic from your app flow and writes a YAML script you can later correlate, debug, and run.

Purpose​

Use record when you need a realistic starting script instead of writing the scenario by hand.

Basic usage​

relampo record --port 8888 --responses --output my_script.yaml

How record works​

  1. Start the recorder (MITM proxy):
relampo record \
  --port 8888 \
  --base-url "http://www.testingyes.com/demo/" \
  --responses \
  --output my_script.yaml \
  --exclude "(?i).*\.(css|js|png|jpg|jpeg|gif|svg|ico|woff2?)(\?.*)?$"
Windows tip

On Windows, replace \ with PowerShell backtick (`) or CMD caret (^). You can also run this command in a single line.

  1. Configure your browser proxy:
  • Host: localhost
  • Port: 8888
  • Enable proxy for all protocols
  1. Navigate the app and execute the functional flow (example):
  • Home page
  • Click Login
  • Sign in
  • Select product
  • Add to cart
  • Checkout
  • Confirm order
  • Log off
  1. Stop recording with Ctrl + C.

Optional: interactive request naming with --prefix​

If you add --prefix, Relampo enables interactive prefix updates from terminal input while recording.

Example:

relampo record --port 8888 --responses --output my_script.yaml --prefix "Start"

Then type labels in the same terminal and press Enter (for example HomePage, Click Login, Checkout) before each user action.

Expected output​

  • Recorder startup messages in terminal.
  • Captured requests with the prefix before the request name (example: HomePage /demo/index.html).
  • Final output after Ctrl + C:
[record] YAML saved to: /path/to/my_script.yaml

Flags most used in docs​

  • --port <int>: local proxy port (default 8888).
  • --responses: includes response data for later correlation.
  • --output <file>: output YAML path.
  • --base-url <url>: base URL of the app under test.
  • --prefix <text>: enables prefix labeling for recorded request names.
  • --include <pattern>: records only matching URLs.
  • --exclude <pattern>: excludes matching URLs (repeatable).