Metadata-Version: 2.4
Name: rtl_buddy
Version: 3.3.1
Summary: Python CLI for Verilog and SystemVerilog RTL testing, randomized regressions, coverage, and simulator workflow automation.
Project-URL: Source, https://github.com/rtl-buddy/rtl_buddy
Project-URL: Documentation, https://rtl-buddy.github.io/rtl_buddy/
Project-URL: Tracker, https://github.com/rtl-buddy/rtl_buddy/issues
Author: Zhi-Hern Loh, Xie Jiacheng
License-Expression: BSD-3-Clause
License-File: LICENSE
Keywords: ASIC,EDA,FPGA,RTL,SystemVerilog,VCS,Verilator,Verilog,coverage,regression testing,verification
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
Requires-Python: >=3.11
Requires-Dist: click>=8.3.0
Requires-Dist: pyserde[yaml]>=0.27.0
Requires-Dist: rich>=14.0.0
Requires-Dist: ruamel-yaml>=0.18.15
Requires-Dist: typer>=0.19.2
Description-Content-Type: text/markdown

# `rtl_buddy`

[![PyPI](https://img.shields.io/pypi/v/rtl_buddy)](https://pypi.org/project/rtl_buddy/)
[![Python](https://img.shields.io/pypi/pyversions/rtl_buddy)](https://pypi.org/project/rtl_buddy/)
[![License](https://img.shields.io/badge/license-BSD--3--Clause-blue)](LICENSE)
[![Docs](https://img.shields.io/badge/docs-rtl--buddy.github.io-blue)](https://rtl-buddy.github.io/rtl_buddy/)

`rtl_buddy` is a Python CLI for running Verilog and SystemVerilog RTL tests, randomized regressions, filelist generation, Verilator/VCS simulator workflows, Yosys synthesis flows, coverage, and adjacent verification automation. It is designed to work well for both humans and AI agents.

It is built to sit on top of the tools your project already uses, while giving you a cleaner, more repeatable interface for day-to-day verification work. The primary supported simulation flows are Verilator and VCS-based compile, simulation, test, regression, as well as Yosys-based synthesis. Basic Verible command integration exists, while broader first-class Verible and PeakRDL workflows are on the roadmap.

Typical commands look like:

```bash
uv run rb test basic
uv run rb test smoke --repeat 20
uv run rb regression
uv run rb regression --coverage-merge
```

## Why `rtl_buddy`

`rtl_buddy` gives RTL projects a lightweight control plane for common verification tasks:

- Run a single test or a full regression from YAML config instead of ad hoc shell scripts
- Keep simulator invocation, seeds, logs, and result handling consistent across runs
- Manage filelists easily with project model definitions
- Add sweep generation, preprocessing, and postprocessing hooks without rewriting the main flow
- Export machine-readable logs that work well in CI and AI-agent-driven workflows

## Features

- **Test and regression commands**: run one test, many tests, or whole suites with a consistent CLI
- **Randomized testing support**: create new seeds, repeat runs, and replay previous randomized iterations
- **Structured config model**: describe suites, regressions, platforms, builders, and models in readable YAML
- **Filelist generation**: build simulator-ready filelists from `models.yaml`
- **Synthesis flows**: run Yosys synthesis from `synth.yaml`, including optional Liberty-mapped runs and synthesis regressions
- **Coverage workflows**: collect, merge, summarize, and export Verilator coverage
- **Hookable execution flow**: plug in your own sweep generation, test preprocessing, and postprocessing scripts
- **Verible integration**: invoke lint, syntax, formatting, and preprocessing commands through the same project config
- **Rich outputs for humans**: displays pretty formatted for easy reading
- **Structured logging for machines**: emits JSONL logs for interpretation by CI systems, automation, and coding agents
- **Cross-project reuse**: keep one tool interface while adapting it to different RTL repo layouts and builder setups

## Installation

`rtl_buddy` is available on [PyPI](https://pypi.org/project/rtl_buddy/) and installed into your project environment with `uv`:

```bash
uv add rtl_buddy
```

For local development in this repo, install the composite `dev` group:

```bash
uv sync --group dev
uv run ruff check
uv run ruff format --check
uv run pytest
```

Prerequisites:

- Python 3.11+
- `uv`
- A simulator on `PATH`
  - Verilator is the recommended open-source starting point
  - VCS is also supported as a first-class flow
- Optional: the [rtl-buddy fork of Yosys](https://github.com/rtl-buddy/yosys) if you want to use `uv run rb synth ...`
- Optional: Verible if you want to use `uv run rb verible ...` — e.g. `brew tap chipsalliance/verible && brew install verible` on macOS, or see [Verible releases](https://github.com/chipsalliance/verible/releases) for other platforms
- Optional system-level coverage tools:
  - `lcov` for LCOV and HTML coverage export
  - [Coverview](https://github.com/antmicro/coverview) for Coverview package generation

## Documentation

Full documentation is at **[rtl-buddy.github.io/rtl_buddy](https://rtl-buddy.github.io/rtl_buddy/)**.

## Quick Start

The fastest way to get started is the **[rtl-buddy project template](https://github.com/rtl-buddy/rtl-buddy-project-template)** — a ready-to-run RTL project with example designs, tests, and full `rtl_buddy` integration.

Once you have a project set up, the basic commands are:

```bash
uv run rb test basic      # run a single test
uv run rb regression      # run the full regression
uv run rb synth -c synth/sandbox/synth.yaml
```

For full usage, see the [Quick Start guide](https://rtl-buddy.github.io/rtl_buddy/latest/quickstart/).

Runtime artefacts are stored under `artefacts/{sanitized_test_name}/`. Single runs write files such as `test.log`, `test.err`, `test.randseed`, and `coverage.dat` there directly, while repeated runs use nested directories such as `artefacts/{sanitized_test_name}/run-0001/`. The suite root always keeps `test.log`, `test.err`, and `test.randseed` symlinked to the latest run for convenience.

## Known Issues

See the [known issues page](https://rtl-buddy.github.io/rtl_buddy/latest/known-issues/).
