CLI Reference

Auto-generated reference for all rampa commands.

Command: rampa

Rampa — Python load testing framework.

Usage

usage: rampa [-h] [--version] {run,check,inspect,doctor} ...

Run Examples

$ rampa run load_test.py

$ rampa run load_test.py --vus 20 --duration 1m

$ rampa run load_test.py --scenario smoke

$ rampa run load_test.py --out results.json --quiet

Check Examples

$ rampa check load_test.py

Inspect Examples

$ rampa inspect load_test.py

$ rampa inspect load_test.py --format json

Doctor Examples

$ rampa doctor

Options

--version, -V

show program's version number and exit

Sub-commands

run

run a load test script

Execute a load test script.

Examples

$ rampa run load_test.py

$ rampa run load_test.py --vus 20 --duration 1m

$ rampa run load_test.py --scenario smoke

Output

$ rampa run load_test.py --out results.json --quiet

$ rampa run load_test.py --event-log events.jsonl

Usage

usage: rampa run [-h] [--vus VUS] [--duration DURATION] [--scenario SCENARIO]
                 [--out JSON_OUTPUT] [--event-log EVENT_LOG] [--quiet]
                 [--output EXTRA_OUTPUTS] [--progress] [--tui]
                 script

Positional Arguments

script

path to the test script

Default
None
Required

Options

--vus

override VU count

Default
None
Type
int
--duration

override duration (e.g. `30s`, `1m`)

Default
None
Type
str
--scenario

run a specific scenario only

Default
None
Type
str
--out

JSON output file path

Default
None
Type
str
--event-log

JSONL event log file path

Default
None
Type
str
--quiet

suppress console summary

Default
False
--output, -O

output backend (e.g. csv=results.csv, influxdb=http://...)

Default
None
--progress

show single-line progress during execution

Default
False
--tui

launch interactive TUI dashboard (requires rampa[tui])

Default
False

check

validate a test script without running it

Validate a test script without running it.

Examples

$ rampa check load_test.py

Usage

usage: rampa check [-h] script

Positional Arguments

script

path to the test script

Default
None
Required

inspect

show resolved test configuration

Show the fully resolved test configuration without running.

Examples

$ rampa inspect load_test.py

$ rampa inspect load_test.py --format json

Usage

usage: rampa inspect [-h] [--format {text,json}] script

Positional Arguments

script

path to the test script

Default
None
Required

Options

--format

output format (default: text)

Default
text
Choices
text, json

doctor

check the runtime environment

Check the runtime environment for rampa.

Examples

$ rampa doctor

Usage

usage: rampa doctor [-h]

Entry Points

rampa.cli.create_parser()
function
function
rampa.cli.create_parser()

Build the rampa CLI argument parser.

Returns:

Configured parser with run, check, and doctor subcommands.

Return type:

argparse.ArgumentParser

Examples

>>> parser = create_parser()
>>> parser.prog
'rampa'
rampa.cli.build_docs_parser()
function
function
rampa.cli.build_docs_parser()

Return the parser for sphinx-autodoc-argparse.

Returns:

The root parser.

Return type:

argparse.ArgumentParser

Examples

>>> parser = build_docs_parser()
>>> parser.prog
'rampa'
rampa.cli.main(argv=None)
function
function
rampa.cli.main(argv=None)

CLI entry point for rampa.

Parameters:

argv (list[str] | None) – Command-line arguments. None uses sys.argv.

Return type:

None

Examples

>>> import rampa.cli