Skip to main content

Quick Start

Run these commands from a project where RTL Buddy is installed. If uv run rb --version fails, see Installation.

Run tests​

From a suite directory containing tests.yaml:

uv run rb test --list     # list tests
uv run rb test basic      # run one test
uv run rb test            # run every test

From another directory, name the suite:

uv run rb test basic --test-config path/to/tests.yaml

Outputs land beside tests.yaml, not in the directory you ran from. See Execution Context.

Run a regression​

uv run rb regression

The manifest is ./regression.yaml when present, otherwise the path set in root_config.yaml. To choose one:

uv run rb regression --reg-config path/to/regression.yaml

See Regressions for level filtering and parallel dispatch.

Run randomized tests​

uv run rb test basic --rnd-new         # one run with a new seed
uv run rb randtest basic 5             # five distinct iterations
uv run rb randtest basic 5 --rnd-rpt 3 # replay iteration 3

Seeds are recorded with the test artefacts.

Run synthesis​

uv run rb synth --list --synth-config path/to/synth.yaml
uv run rb synth smoke_synth --synth-config path/to/synth.yaml

Backend and library configuration is in Synthesis.

Inspect results​

Each suite writes orchestration output to rtl_buddy.log and per-test output to artefacts/<test>/. A randtest iteration writes to artefacts/<test>/run-NNNN/, and latest-run symlinks stay at the test artefact root.

For JSON output:

uv run rb --machine test basic

See Agent Use for the JSON contract and Tests for verdicts and exit codes.

Configure a project​