rtl-buddy 3.2.2__tar.gz → 3.2.4__tar.gz

{rtl_buddy-3.2.2 → rtl_buddy-3.2.4}/.agents/skills/audit-bundled-skill/SKILL.md

@@ -9,26 +9,31 @@ You are reviewing `src/rtl_buddy/skill/SKILL.md` — the agent skill that ships
 
 ## Design principles
 
-The bundled skill must stay lean. Its purpose is agent workflow guidance, not documentation. Anything that belongs in the docs site should cite the docs site instead.
+The bundled skill must stay lean. Its purpose is agent workflow guidance, not documentation. It may include brief operational orientation when that helps agents find files, run commands, interpret results, or inspect outputs without reading docs first. Anything deeper belongs in the docs site and should be cited instead.
 
 **The skill should:**
 - Stay at or under 60 lines
 - Cover agent-specific conventions that are not obvious from the docs: `--machine` flag requirement, JSONL log format, CWD rules for `test` vs `regression`, artefact paths
+- Include the local docs commands so agents know how to reach bundled references
+- Include a brief YAML type overview so agents can find config files and understand their role quickly
+- Include concise pass/fail detection guidance for UVM, cocotb, and default stdout parsing
+- Include concise artefact/log locations needed for debugging and summaries
 - Reference docs via `rtl-buddy docs show <page>` rather than restating content inline
 - Give the agent enough to run correctly without reading the docs first
 - Include the version check instruction (`rtl-buddy --version` at top of every run)
 
 **The skill must not:**
-- Restate YAML schemas, field references, or flag descriptions — those live in `docs/reference/`
+- Restate YAML schemas, field references, examples, option lists, or flag descriptions — those live in `docs/reference/`
 - Grow feature-by-feature as rtl_buddy adds commands — only add lines when agent behavior would otherwise be wrong
-- Duplicate content between the skill and the docs site
+- Duplicate docs-site content beyond brief operational orientation
 
 ## How to audit
 
 1. Count lines. If over 60, identify what can be moved to a docs cite.
-2. Read each section. For every paragraph, ask: does an agent need this to run correctly, or would it be equally served by `rtl-buddy docs show <page>`?
-3. Check the current CLI (`rtl-buddy --help` and per-command `--help`) against what the skill describes. Flag anything stale.
-4. Check that the skill cites the docs site for all feature-specific content rather than embedding it.
+2. Read each section. For every paragraph, ask: does an agent need this to act correctly or debug quickly without opening docs first?
+3. Distinguish concise orientation from reference duplication. Keep short file-purpose, pass/fail, and artefact guidance; trim field tables, examples, option details, and command-specific feature docs.
+4. Check the current CLI (`rtl-buddy --help` and per-command `--help`) against what the skill describes. Flag anything stale.
+5. Check that the skill cites the docs site for all feature-specific content rather than embedding it.
 
 ## Output format
 

rtl_buddy-3.2.4/.github/workflows/lint.yml

@@ -0,0 +1,50 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - '.github/workflows/lint.yml'
+      - 'pyproject.toml'
+      - 'uv.lock'
+      - 'src/**/*.py'
+      - 'tests/**/*.py'
+  pull_request:
+    branches: [main]
+    paths:
+      - '.github/workflows/lint.yml'
+      - 'pyproject.toml'
+      - 'uv.lock'
+      - 'src/**/*.py'
+      - 'tests/**/*.py'
+
+jobs:
+  ruff-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: uv.lock
+
+      - name: Install lint dependencies
+        run: uv sync --group lint
+
+      - name: Run Ruff
+        run: uv run ruff check
+
+      - name: Check Ruff formatting
+        run: uv run ruff format --check
+
+      - name: Hint — install pre-commit to catch this locally
+        if: failure()
+        run: |
+          echo ""
+          echo "Ruff check or format failed. Catch this before pushing by installing the pre-commit hook:"
+          echo ""
+          echo "  uv tool install pre-commit"
+          echo "  pre-commit install"
+          echo ""
+          echo "After that, every commit will run Ruff automatically."

{rtl_buddy-3.2.2 → rtl_buddy-3.2.4}/.github/workflows/release.yml

@@ -1,5 +1,10 @@
 name: Release
 
+run-name: >-
+  ${{ github.event_name == 'workflow_dispatch'
+    && format('Release ({0}{1}) from {2}', inputs.bump, inputs.pre_release == 'true' && ', pre-release' || '', github.ref_name)
+    || format('Release from PR #{0} ({1})', github.event.pull_request.number, github.head_ref) }}
+
 on:
   pull_request:
     types: [closed]
@@ -100,6 +105,12 @@ jobs:
           echo "is_prerelease=${IS_PRERELEASE}" >> "$GITHUB_OUTPUT"
           echo "Bumping ${LATEST} -> ${NEW_TAG}"
 
+      - name: Log release parameters
+        run: |
+          echo "Version : ${{ steps.version.outputs.new_tag || '(none — no version label on PR)' }}"
+          echo "Branch  : ${{ github.event_name == 'workflow_dispatch' && github.ref_name || github.head_ref }}"
+          echo "Trigger : ${{ github.event_name }}"
+
       - name: Require release token
         if: steps.version.outputs.new_tag != ''
         env:

rtl_buddy-3.2.4/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

{rtl_buddy-3.2.2 → rtl_buddy-3.2.4}/AGENTS.md

@@ -64,6 +64,31 @@ cd design/example_block/verif
 
 If validating the dev checkout directly, install this repo into the target venv and confirm with `./venv/bin/python -m rtl_buddy --version`.
 
+## Code Quality
+
+This repo uses [Ruff](https://docs.astral.sh/ruff/) for linting and formatting. CI enforces both on every PR via `.github/workflows/lint.yml`.
+
+Install the pre-commit hook once after cloning so Ruff runs automatically on every commit:
+
+```bash
+uv tool install pre-commit
+pre-commit install
+```
+
+To run Ruff manually:
+
+```bash
+uv run ruff check          # lint
+uv run ruff format         # format in place
+uv run ruff format --check # check only (what CI does)
+```
+
+To update the pre-commit hook version:
+
+```bash
+pre-commit autoupdate
+```
+
 ## Logging Practices
 
 All runtime logging goes through `log_event()` in `src/rtl_buddy/logging_utils.py`. Do not use `logger.info(f"...")` directly — use `log_event(logger, level, "event.name", key=value, ...)` so that both human and machine modes produce correct output.

{rtl_buddy-3.2.2 → rtl_buddy-3.2.4}/PKG-INFO

@@ -1,14 +1,14 @@
 Metadata-Version: 2.4
 Name: rtl_buddy
-Version: 3.2.2
-Summary: RTL Buddy is a build-system with testplan, regression, workflow support for Verilog RTL codebases.
+Version: 3.2.4
+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,FPGA,SystemVerilog,Verilog
+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
@@ -32,10 +32,19 @@ Description-Content-Type: text/markdown
 [![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 CLI for running RTL tests, regressions, filelist generation, and adjacent workflow automation in Verilog and SystemVerilog projects. It is designed to work well for both humans and AI agents.
+`rtl_buddy` is a Python CLI for running Verilog and SystemVerilog RTL tests, randomized regressions, filelist generation, Verilator/VCS simulator workflows, 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 flows are Verilator and VCS-based compile, simulation, and regression workflows. 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:
@@ -67,6 +76,15 @@ It is built to sit on top of the tools your project already uses, while giving y
 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+
@@ -74,7 +92,7 @@ Prerequisites:
 - A simulator on `PATH`
   - Verilator is the recommended open-source starting point
   - VCS is also supported as a first-class flow
-- Optional Verible binaries if you want to use `uv run rb verible ...`
+- 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

{rtl_buddy-3.2.2 → rtl_buddy-3.2.4}/README.md

@@ -5,10 +5,19 @@
 [![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 CLI for running RTL tests, regressions, filelist generation, and adjacent workflow automation in Verilog and SystemVerilog projects. It is designed to work well for both humans and AI agents.
+`rtl_buddy` is a Python CLI for running Verilog and SystemVerilog RTL tests, randomized regressions, filelist generation, Verilator/VCS simulator workflows, 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 flows are Verilator and VCS-based compile, simulation, and regression workflows. 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:
@@ -40,6 +49,15 @@ It is built to sit on top of the tools your project already uses, while giving y
 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+
@@ -47,7 +65,7 @@ Prerequisites:
 - A simulator on `PATH`
   - Verilator is the recommended open-source starting point
   - VCS is also supported as a first-class flow
-- Optional Verible binaries if you want to use `uv run rb verible ...`
+- 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

{rtl_buddy-3.2.2 → rtl_buddy-3.2.4}/docs/concepts/plugins.md

@@ -31,6 +31,8 @@ The sweep hook runs before the test flow and expands a single test entry into mu
 | `logger` | Logger | Use this for all logging so output goes through `rtl_buddy`'s log system |
 | `test_cfg` | TestConfig (immutable) | The original test entry from `tests.yaml` |
 | `root_cfg` | RootConfig (mutable) | The loaded root config |
+| `suite_dir` | string | Absolute path to the directory containing `tests.yaml` |
+| `artifact_dir` | string | Artifact root for the incoming test name under `suite_dir/artefacts/` |
 | `out_test_cfgs` | list | **Assign** the expanded list of `TestConfig` objects here |
 | `__file__` | string | Absolute path to the current sweep script |
 
@@ -74,14 +76,21 @@ The pre-processing hook runs after sweep expansion but before the compilation st
 | `logger` | Logger | Use for all logging |
 | `test_cfg` | TestConfig (mutable) | Modify this to change compile/sim parameters |
 | `root_cfg` | RootConfig (mutable) | The loaded root config |
+| `suite_dir` | string | Absolute path to the directory containing `tests.yaml` |
+| `artifact_dir` | string | Artifact root for this test under `suite_dir/artefacts/` |
 | `__file__` | string | Absolute path to the current pre-processing script |
 
+Plusargs are still passed through verbatim. If a plusarg value should reference a suite-local file, resolve it explicitly against `suite_dir` in preproc. Output filenames that should land in the per-test artefact tree can remain relative to `artifact_dir`.
+
 **Example:**
 
 ```python
 # my_preproc.py
 import os
+from pathlib import Path
+
 test_cfg.plusargs["BUILD_ID"] = os.environ.get("CI_BUILD_ID", "local")
+test_cfg.plusargs["stimulus"] = str(Path(suite_dir) / "vectors" / "streaming_contract.txt")
 ```
 
 If a pre-processing script raises an exception, the affected test is marked as a setup failure and the rest of the run continues.

{rtl_buddy-3.2.2 → rtl_buddy-3.2.4}/docs/concepts/root-config.md

@@ -37,7 +37,7 @@ cfg-rtl-builder:
 
 cfg-verible:
   - name: "verible-macos"
-    path: "tools/verible/macos/active/bin"
+    path: "/opt/homebrew/bin"
     extra_args:
       lint:
         - "--rules=-module-filename"
@@ -63,18 +63,7 @@ Defines simulation tool configurations. Each entry has:
 
 **`cfg-verible`**
 
-Defines Verible tool configurations for lint and syntax checks.
-
-**`cfg-surfer`** *(optional)*
-
-Configures the Surfer waveform viewer for `rb wave`. Fields:
-
-- `path`: bare executable name (resolved via PATH, e.g. `"surfer"`) or a relative/absolute path to the binary
-- `wcp-port`: TCP port rtl-buddy listens on; Surfer connects with `--wcp-initiate` (default: `0` — OS auto-assigns a free port)
-- `editor-cmd`: command template with `%f` (file path) and `%l` (line number) placeholders — e.g. `"vim +%l %f"`, `"code --goto %f:%l"`
-- `editor-terminal`: how to open terminal editors — `tmux` (new tmux window), `iterm2`, `terminal` (macOS Terminal.app), or `""` to run the command directly (for GUI editors)
-
-`rb wave <test>` looks for a signal layout file at `<test>.surfer` in the same directory as `tests.yaml` (e.g. `verif/sandbox/basic.surfer`). If found it is passed to Surfer via `-c`; if not, Surfer opens with no pre-loaded signals. If no FST exists for the test, `rb wave` runs a debug sim automatically before launching Surfer.
+Defines Verible tool configurations for lint and syntax checks. `path` is the directory containing Verible executables — absolute or relative to `root_config.yaml`.
 
 **`cfg-rtl-reg`**
 

{rtl_buddy-3.2.2 → rtl_buddy-3.2.4}/docs/concepts/tests.md

@@ -167,6 +167,8 @@ For machine-readable logs (JSON Lines), use `--machine`. See [For Agents](../age
 
 Paths in `tests.yaml` (such as `model_path`) are resolved relative to the suite file's directory, not the invocation directory.
 
+Plusargs are passed to the simulator verbatim. If a plusarg should reference a suite-local file, resolve it explicitly in preproc using `suite_dir`. Bare output filenames can remain artifact-relative so they land under `artefacts/{test_name}/`.
+
 ## Full schema
 
 See [YAML Formats: tests.yaml](../reference/yaml.md#testsyaml) for the complete field reference.

rtl_buddy-3.2.4/docs/index.md

@@ -0,0 +1,40 @@
+---
+description: RTL Buddy is a Python CLI for Verilog and SystemVerilog regression testing, Verilator and VCS simulation workflows, coverage, and YAML-based RTL verification automation.
+---
+
+# RTL Buddy
+
+RTL Buddy is a Python CLI for Verilog and SystemVerilog RTL verification workflows, including test execution, randomized regression testing, Verilator and VCS simulation, coverage collection, and YAML-based automation.
+
+It wraps simulation tools and project scripts to provide a structured, config-driven test and regression system for ASIC and FPGA projects. The primary supported flows are Verilator on macOS/Linux and VCS on Linux.
+
+## Features
+
+- Run individual Verilog/SystemVerilog tests or full regressions from YAML config files
+- Randomized seed testing with repeat and replay support
+- Plugin hooks for sweep generation, test pre-processing, and post-processing
+- Filelist generation from `models.yaml`
+- Verilator coverage collection, merge, summary, and export workflows
+- Basic Verible command integration for lint, syntax, formatting, and preprocessing
+- Machine-readable JSONL logging for use with AI agents and CI pipelines
+
+`rtl_buddy` can be adapted to different project toolchains, but the primary supported flows are Verilator and VCS. Broader first-class Verible and PeakRDL workflows are on the roadmap.
+
+## SystemVerilog Regression Testing
+
+RTL Buddy keeps simulator invocation, seeds, logs, result handling, and regression selection consistent across repeated verification runs. Projects describe suites, tests, platforms, builders, and models in readable YAML files instead of scattering that logic across ad hoc shell scripts.
+
+## Verilator and VCS Simulation Workflows
+
+The CLI gives RTL projects one command surface for open-source Verilator flows and Linux VCS flows, with optional hooks for project-specific compile, simulation, sweep, and post-processing behavior.
+
+## Getting Started
+
+- [Installation](install.md) — how to add `rtl_buddy` to your project
+- [Quick Start](quickstart.md) — run your first test in minutes
+- [Concepts](concepts/root-config.md) — understand the config model
+
+## Reference
+
+- [CLI Reference](reference/cli.md) — all subcommands and options
+- [YAML Formats](reference/yaml.md) — full schema for all config files

{rtl_buddy-3.2.2 → rtl_buddy-3.2.4}/docs/install.md

@@ -11,7 +11,7 @@ description: How to install rtl_buddy into a project using uv, including prerequ
 - Python 3.11 or later
 - `uv`
 - Simulation tool on `PATH`: Verilator (macOS/Linux) or VCS (Linux)
-- Optional Verible binaries if you want to use `uv run rb verible ...`
+- 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 `.info` export and HTML reports
   - Antmicro `coverview` for Coverview package generation
@@ -66,7 +66,7 @@ This works without any `--pre` flag because the exact version is specified.
 `rtl_buddy` ships an agent skill for Claude Code and Codex. After installing `rtl_buddy`, run once per machine:
 
 ```bash
-uv run rtl-buddy skill install
+uv run rb skill install
 ```
 
 This writes `SKILL.md` to `~/.claude/skills/rtl_buddy/` and `~/.codex/skills/rtl_buddy/`. Agents pick it up automatically. Re-run after upgrading `rtl_buddy` to refresh the content.
@@ -74,7 +74,7 @@ This writes `SKILL.md` to `~/.claude/skills/rtl_buddy/` and `~/.codex/skills/rtl
 To install at project scope instead (overrides the user-level copy for that project):
 
 ```bash
-uv run rtl-buddy skill install --project
+uv run rb skill install --project
 ```
 
 See [For Agents](agents.md) for scope semantics and `.gitignore` guidance.

{rtl_buddy-3.2.2 → rtl_buddy-3.2.4}/docs/migrations/v2-to-v3.md

@@ -31,6 +31,8 @@ artefacts/{test_name}/run-0001/coverage.dat
 
 Compile outputs (`compile.log`, `run.f`) remain at `artefacts/{test_name}/` — they are shared across all iterations of the same test.
 
+Hook scripts that previously relied on suite-relative file paths resolving from the simulator working directory must now resolve those paths explicitly. Use the preproc hook's `suite_dir` variable for suite-local inputs; keep output filenames artifact-relative when they should land under `artefacts/{test_name}/`.
+
 ### Symlinks
 
 The convenience symlinks `test.log`, `test.err`, and `test.randseed` at the suite root still exist and still point to the latest run.

{rtl_buddy-3.2.2 → rtl_buddy-3.2.4}/docs/reference/cli.md

@@ -47,7 +47,6 @@ Usage: rtl-buddy [OPTIONS] COMMAND [ARGS]...
 │ regression  run rtl regression                                                       │
 │ filelist    generate filelists using models.yaml                                     │
 │ verible     run verible cmd                                                          │
-│ wave        open waveform viewer for a test                                          │
 │ skill       manage the rtl_buddy agent skill                                         │
 │ docs        browse bundled documentation                                             │
 │ spec        spec traceability commands                                               │
@@ -188,24 +187,6 @@ Usage: rtl-buddy verible [OPTIONS] CMD [VERIBLE_ARGS]...
 ╰──────────────────────────────────────────────────────────────────────────────────────╯
 ```
 
-## wave
-
-```text
-Usage: rtl-buddy wave [OPTIONS] TEST_NAME                                              
-                                                                                        
- open waveform viewer for a test                                                        
-                                                                                        
-╭─ Arguments ──────────────────────────────────────────────────────────────────────────╮
-│ *    test_name      TEXT  name of test to open waveform for [required]               │
-╰──────────────────────────────────────────────────────────────────────────────────────╯
-╭─ Options ────────────────────────────────────────────────────────────────────────────╮
-│ --test-config  -c      TEXT  tests.yaml to use [default: tests.yaml]                 │
-│ --surfer               TEXT  cfg-surfer entry name [default: surfer-default]         │
-│ --resim                      force re-run of debug sim even if FST exists            │
-│ --help                       Show this message and exit.                             │
-╰──────────────────────────────────────────────────────────────────────────────────────╯
-```
-
 ## skill
 
 ```text

{rtl_buddy-3.2.2 → rtl_buddy-3.2.4}/docs/reference/yaml.md

@@ -45,7 +45,7 @@ cfg-rtl-builder:
 
 cfg-verible:
   - name: "verible-macos"
-    path: "tools/verible/macos/active/bin"
+    path: "/opt/homebrew/bin"
     extra_args:
       lint:
         - "--rules=-module-filename"
@@ -60,13 +60,6 @@ cfg-coverview:
     config:
       # inline Coverview JSON configuration values
 
-cfg-surfer:
-  - name: "surfer-default"
-    path: "surfer"              # bare name → found via PATH; or relative/absolute path
-    wcp-port: 0         # 0 = OS auto-assigns a free port
-    editor-cmd: "vim +%l %f"   # %f = file path, %l = line number
-    editor-terminal: "tmux"    # tmux | iterm2 | terminal | "" (empty = run cmd directly)
-
 cfg-rtl-reg:
   reg-cfg-path: "design/regression.yaml"
 ```
@@ -78,8 +71,8 @@ cfg-rtl-reg:
 - `--builder-mode` selects which named `builder-opts` entry to use for compile-time and run-time flags.
 - `cfg-coverage` is keyed by simulator family (e.g. `verilator`). `use-lcov: true` enables `.info` export and LCOV HTML generation when `--coverage-html` is used.
 - `cfg-coverview` is keyed by simulator family. `generate-tables` sets the coverage type for Coverview tables. `config` is a dict of inline Coverview JSON configuration values.
-- `cfg-surfer` configures the Surfer waveform viewer used by `rb wave`. `path` is a bare executable name (resolved via PATH) or a relative/absolute path to the binary. `editor-cmd` supports `%f` (file path) and `%l` (line number) placeholders. `editor-terminal` controls how the editor is launched: `tmux` opens a new tmux window, `iterm2` and `terminal` use AppleScript, empty string runs the command directly (suitable for GUI editors like VS Code).
 - `cfg-rtl-reg.reg-cfg-path` is the fallback regression file for `rtl-buddy regression` when no `./regression.yaml` exists in the cwd.
+- `cfg-verible[].path` is the directory containing Verible executables. Absolute paths are used as-is; relative paths are resolved from the directory containing `root_config.yaml`.
 
 ---
 
@@ -255,7 +248,7 @@ cocotb writes a JUnit XML results file (`cocotb_results.xml`) instead of `PASS`/
 - `plusargs`: converted to `+KEY` (no value) or `+KEY=VALUE`.
 - `sim_timeout`: applies per test run, not per iteration in `randtest`.
 - `sweep.path`: Python script that expands one test entry into a list of `TestConfig` objects. See [Plugins](../concepts/plugins.md).
-- `preproc.path`: Python script executed before compile; can mutate `test_cfg` and `root_cfg`. See [Plugins](../concepts/plugins.md).
+- `preproc.path`: Python script executed before compile; can mutate `test_cfg` and `root_cfg`, and receives `suite_dir` plus `artifact_dir` in its execution namespace. See [Plugins](../concepts/plugins.md).
 
 ## Path semantics and cwd
 
@@ -263,6 +256,7 @@ cocotb writes a JUnit XML results file (`cocotb_results.xml`) instead of `PASS`/
 - Per-test artifacts are written to `artefacts/{test_name}/` under the suite root. Single runs write `test.log`, `test.err`, `test.randseed`, `compile.log`, `run.f`, and (if enabled) `coverage.dat` there directly. Repeated runs (`randtest`) write sim outputs into numbered subdirectories: `artefacts/{test_name}/run-0001/`, etc.
 - `test` and `randtest` do **not** automatically change into the suite directory. Run from the suite directory, or use `--test-config` with a full path.
 - `regression` does `chdir` into each suite directory before executing.
+- Preproc plusargs are passed to the simulator verbatim. Resolve suite-local input paths explicitly against `suite_dir`; keep output filenames artifact-relative when they should land under `artefacts/{test_name}/`.
 - For portable configs in multi-suite repos, make paths in `tests.yaml` explicit and verify they resolve correctly from the intended invocation directory.
 
 ---

rtl_buddy-3.2.4/docs/robots.txt

@@ -0,0 +1,4 @@
+User-agent: *
+Allow: /
+
+Sitemap: https://rtl-buddy.github.io/rtl_buddy/sitemap.xml

{rtl_buddy-3.2.2 → rtl_buddy-3.2.4}/mkdocs.yml

@@ -1,5 +1,8 @@
 site_name: RTL Buddy
-site_description: CLI tool for automating tests, regressions, and RTL workflows for Verilog/SystemVerilog codebases.
+site_description: Python CLI for Verilog and SystemVerilog regression testing, Verilator and VCS simulation workflows, RTL test automation, coverage, and YAML-based verification flows.
+site_author: RTL Buddy contributors
+repo_url: https://github.com/rtl-buddy/rtl_buddy
+repo_name: rtl-buddy/rtl_buddy
 docs_dir: docs
 site_url: https://rtl-buddy.github.io/rtl_buddy/
 remote_name: origin

{rtl_buddy-3.2.2 → rtl_buddy-3.2.4}/pyproject.toml

@@ -19,11 +19,23 @@ authors = [
   { name = "Xie Jiacheng"}
 ]
 
-description = "RTL Buddy is a build-system with testplan, regression, workflow support for Verilog RTL codebases."
+description = "Python CLI for Verilog and SystemVerilog RTL testing, randomized regressions, coverage, and simulator workflow automation."
 readme = "README.md"
 license = "BSD-3-Clause"
 license-files = ["LICENSE"]
-keywords = [ "SystemVerilog", "Verilog", "ASIC", "FPGA" ]
+keywords = [
+  "SystemVerilog",
+  "Verilog",
+  "RTL",
+  "ASIC",
+  "FPGA",
+  "EDA",
+  "Verilator",
+  "VCS",
+  "regression testing",
+  "verification",
+  "coverage",
+]
 
 classifiers = [
   "Development Status :: 4 - Beta",
@@ -52,16 +64,35 @@ exclude = ["src/rtl_buddy/docs"]
 "docs" = "rtl_buddy/docs"
 
 [dependency-groups]
-dev = [
-    "pytest>=9.0.3",
-]
 docs = [
   "mkdocs>=1.6.0",
   "mkdocs-material>=9.5.0",
   "mike>=2.1.0",
 ]
+lint = [
+  "ruff>=0.11.0",
+]
+test = [
+  "pytest>=9.0.3",
+]
+dev = [
+  { include-group = "docs" },
+  { include-group = "lint" },
+  { include-group = "test" },
+]
 
 [project.scripts]
 rtl_buddy = "rtl_buddy.__main__:main"
 rtl-buddy = "rtl_buddy.__main__:main"
 rb = "rtl_buddy.__main__:main"
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = ["F", "E7", "E9"]
+
+[tool.ruff.lint.per-file-ignores]
+"src/rtl_buddy/runner/test_runner.py" = ["F403", "F405"]

rtl_buddy-3.2.4/scripts/check_docs_frontmatter.py

@@ -0,0 +1,66 @@
+#!/usr/bin/env python3
+"""Check that all non-generated docs pages have a non-empty description: frontmatter field."""
+
+import argparse
+import re
+import sys
+from pathlib import Path
+
+
+REPO_ROOT = Path(__file__).parent.parent
+DOCS_ROOT = REPO_ROOT / "docs"
+
+# No pages are exempt — reference/cli.md has its description managed by gen_cli_reference.py.
+GENERATED_PAGES: set = set()
+
+_FRONTMATTER_RE = re.compile(r"^---\n(.*?)\n---\n", re.DOTALL)
+
+
+def get_description(content: str) -> str:
+    match = _FRONTMATTER_RE.match(content)
+    if not match:
+        return ""
+    for line in match.group(1).splitlines():
+        if line.startswith("description:") or line.startswith("description "):
+            _, _, value = line.partition(":")
+            return value.strip().strip("\"'")
+    return ""
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(description=__doc__)
+    parser.add_argument(
+        "--check",
+        action="store_true",
+        help="Exit non-zero if any page is missing a description",
+    )
+    args = parser.parse_args()
+
+    offenders: list[str] = []
+    for path in sorted(DOCS_ROOT.rglob("*.md")):
+        if path in GENERATED_PAGES:
+            continue
+        if not get_description(path.read_text()):
+            offenders.append(str(path.relative_to(REPO_ROOT)))
+
+    if not offenders:
+        if args.check:
+            print("All docs pages have a description: frontmatter field.")
+        sys.exit(0)
+
+    print(
+        "The following docs pages are missing a non-empty description: frontmatter field:",
+        file=sys.stderr,
+    )
+    for page in offenders:
+        print(f"  {page}", file=sys.stderr)
+    print(
+        "\nAdd a description: field to the YAML frontmatter at the top of each file.\n"
+        "See docs/CONTRIBUTING.md for the required format.",
+        file=sys.stderr,
+    )
+    sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()