peakrdl-cli

library1.5.0pypypiunverified

Command-line tool for control/status register automation and code generation. It provides commands to compile SystemRDL input and generate register model outputs (e.g., HTML, SystemVerilog, C header, IP-XACT, etc.) via plugins. Current version 1.5.0, supports Python >=3.7, release cadence is irregular.

devops

pip install peakrdl-cli

github ↗homepage ↗

INSTALL

IMPORT

SIG · PEAKRDL-CLI

peakrdl-cli

devopspythonv1.5.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verify installation and display help.

import subprocess subprocess.run(['peakrdl', '--help'], check=True)

Debug

Known issues

gotchaPeakRDL CLI is a command-line tool only; do not import it in Python code. Use the Python API via separate packages like 'peakrdl-html' or 'peakrdl-uvvm'.

fix

Use 'peakrdl' command in shell or subprocess.

affects: all

deprecatedSome subcommands (e.g., 'uvvm') require additional plugins. If missing, peakrdl will exit with an error about unknown command.

fix

Install the required plugin: pip install peakrdl-uvvm (for UVVM output).

affects: >=1.0.0

breakingVersion 1.0.0 introduced a new CLI interface with subcommands (e.g., 'peakrdl regblock') replacing the old monolithic 'peakrdl' invocation. Scripts using the old syntax will break.

fix

Update commands to use subcommand syntax: peakrdl <plugin> ...

affects: >=1.0.0

Errors

Common errors & fixes

peakrdl: error: argument command: invalid choice: 'html' (choose from 'regblock', 'systemverilog', 'uvvm', ...)

Missing peakrdl-html plugin or using old syntax without subcommand.

fix

Install peakrdl-html: pip install peakrdl-html

ModuleNotFoundError: No module named 'peakrdl'

Trying to import peakrdl in Python script. peakrdl-cli is a command-line tool, not a Python package.

fix

Run commands via subprocess or shell, not import.

Upgrade

Version history

1.5.0latest on PyPI · released Oct 3, 2025

Audit

Dependencies

No dependency data recorded yet.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/SystemRDL/PeakRDL ↗

homepagehttps://github.com/SystemRDL/PeakRDL ↗