Skip to main content

rdlfmt

A formatter for SystemRDL 2.0, following the PeakRDL style guide.

Documentation

Before:

addrmap top{
  reg {
      field{sw=rw;
    hw=r;} data[31:0];   // payload
  }ctrl @0x0;


  reg{field{sw=r;hw=w;}status[7:0];}stat@0x4;
};

After:

addrmap top {
    reg {
        field {
            sw = rw;
            hw = r;
        } data[31:0]; // payload
    } ctrl @ 0x0;

    reg {
        field {
            sw = r; hw = w;
        } status[7:0];
    } stat @ 0x4;
};

Line breaks between statements are yours — note that the first register's properties stay split and the second's stay joined. There is nothing to configure, deliberately. See What it does.

Install

A prebuilt binary, needing no toolchain of any kind:

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/fischeti/rdlfmt/releases/latest/download/rdlfmt-installer.sh | sh

Or from PyPI:

uv tool install rdlfmt

cargo install rdlfmt works too. See Installation for Windows and building from source.

Usage

rdlfmt regs.rdl     # rewrite in place -- the default
rdlfmt .            # every .rdl file in the tree
rdlfmt --check .    # exit 1 if anything is unformatted; the one for CI
rdlfmt --diff .     # ...and show what would change
rdlfmt -            # filter stdin to stdout

That last one is what editors want: Editor integration has format-on-save recipes for Neovim, Vim, VS Code, Zed, Helix and Emacs. Full command line in Usage.

Library

The formatter is also a library:

let formatted = rdlfmt::format(source)?;

rdlfmt::syntax exposes the lexer and the lossless CST underneath. API docs on docs.rs.

License

Dual-licensed under either of

at your option.

Metadata

Release files for rdlfmt 0.4.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rdlfmt 0.4.2
File Size Uploaded Provenance Actions
rdlfmt-0.4.2.tar.gz 86.2 kB With provenance Details for rdlfmt-0.4.2.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for rdlfmt 0.4.2
File Actions
rdlfmt-0.4.2-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details for rdlfmt-0.4.2-py3-none-win_amd64.whl
rdlfmt-0.4.2-py3-none-musllinux_1_2_x86_64.whl Python 3 none Linux musl 1.2+ x86-64 Details for rdlfmt-0.4.2-py3-none-musllinux_1_2_x86_64.whl
rdlfmt-0.4.2-py3-none-musllinux_1_2_aarch64.whl Python 3 none Linux musl 1.2+ ARM64 Details for rdlfmt-0.4.2-py3-none-musllinux_1_2_aarch64.whl
rdlfmt-0.4.2-py3-none-manylinux2014_x86_64.manylinux_2_17_x86_64.whl Python 3 none Linux glibc 2.17+ x86-64 Details for rdlfmt-0.4.2-py3-none-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
rdlfmt-0.4.2-py3-none-manylinux2014_aarch64.manylinux_2_17_aarch64.whl Python 3 none Linux glibc 2.17+ ARM64 Details for rdlfmt-0.4.2-py3-none-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
rdlfmt-0.4.2-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details for rdlfmt-0.4.2-py3-none-macosx_11_0_arm64.whl
rdlfmt-0.4.2-py3-none-macosx_10_12_x86_64.whl Python 3 none macOS 10.12+ x86-64 Details for rdlfmt-0.4.2-py3-none-macosx_10_12_x86_64.whl

Total release size: 8.6 MB

Release files / rdlfmt-0.4.2.tar.gz

Download URL rdlfmt-0.4.2.tar.gz
Size 86.2 kB
Tags Source
SHA-256 checksum
How to use checksums
ce2327582432b8785811d9254e7aeac334b0d4ae9e3896434441129d73df5646
BLAKE2b-256 checksum
How to use checksums
efd67264258a253c27705ff1e50a17a452cf774c9cb1d8a4adf3dbbc534270a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 1, 2026.

Transparency log

Release files / rdlfmt-0.4.2-py3-none-win_amd64.whl

Download URL rdlfmt-0.4.2-py3-none-win_amd64.whl
Size 1.1 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
d45f691c7db03e8766587d19785e51733d6c077b04a828159d6e340f8435ab70
BLAKE2b-256 checksum
How to use checksums
44080ca89f3070e350760a2981877082c20f335dd898d67ef939b3ed44cae48e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 1, 2026.

Transparency log

Release files / rdlfmt-0.4.2-py3-none-musllinux_1_2_x86_64.whl

Download URL rdlfmt-0.4.2-py3-none-musllinux_1_2_x86_64.whl
Size 1.3 MB
Tags Linux musl 1.2+ x86-64 Python 3
SHA-256 checksum
How to use checksums
de2171e345f7b248adafa892273106495190c82aacc55bb45e5686d021cbf979
BLAKE2b-256 checksum
How to use checksums
32719af24a09ba88e9b5e750a35941de91f86c3d3a75d3a6e9cc7c75fee66062
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 1, 2026.

Transparency log

Release files / rdlfmt-0.4.2-py3-none-musllinux_1_2_aarch64.whl

Download URL rdlfmt-0.4.2-py3-none-musllinux_1_2_aarch64.whl
Size 1.3 MB
Tags Linux musl 1.2+ ARM64 Python 3
SHA-256 checksum
How to use checksums
ac8717a7d76043357312a3ca275e055594102f7a5d2403101c109f6da26776b9
BLAKE2b-256 checksum
How to use checksums
f0596ce98e738bf1c879f5d7ff372cf5a7fe5228e9e4f74c12b5aefc1166f4b8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 1, 2026.

Transparency log

Release files / rdlfmt-0.4.2-py3-none-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

Download URL rdlfmt-0.4.2-py3-none-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Size 1.3 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
ce1d058bf9f720813f23d8a357f691f655fa5728e708013331b3158f73b4c1c3
BLAKE2b-256 checksum
How to use checksums
768dc359acbf0a580e9e4c6809f1b77020389979c4156a35bba6e5ed4a401b26
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 1, 2026.

Transparency log

Release files / rdlfmt-0.4.2-py3-none-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

Download URL rdlfmt-0.4.2-py3-none-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
Size 1.2 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
57fcfcfaa8183b35fe3df93ef1c52f3b23c2dbfa106cb8975838e62824a4cfbf
BLAKE2b-256 checksum
How to use checksums
4d9bd1fb53d1be3b5e951c140225295984e19ad86fb577a6e6b48f6e8f474978
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 1, 2026.

Transparency log

Release files / rdlfmt-0.4.2-py3-none-macosx_11_0_arm64.whl

Download URL rdlfmt-0.4.2-py3-none-macosx_11_0_arm64.whl
Size 1.1 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
8b6ec17c8bc443cb6aee113cf64ee4cf7ac229d327bca6e4f4a62b70c904c4b2
BLAKE2b-256 checksum
How to use checksums
222541348aa215029c7e57224a621f52a4c3f169d150b78f0453d8261c6226f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 1, 2026.

Transparency log

Release files / rdlfmt-0.4.2-py3-none-macosx_10_12_x86_64.whl

Download URL rdlfmt-0.4.2-py3-none-macosx_10_12_x86_64.whl
Size 1.2 MB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
bd06202f9cdc344f04b8d5ff92395d1de4446750fbe34bc866026cf4ef452a8e
BLAKE2b-256 checksum
How to use checksums
8e17a2efe8fd795c47a0d3ae03b16197e9edb9fe46e9f4841e4f16b5096dc516
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 1, 2026.

Transparency log

Security for rdlfmt 0.4.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 8 files in this release have been uploaded with provenance metadata.

Select from 8 files

Attestation for rdlfmt-0.4.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 1, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page