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.1

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.1
File Size Uploaded Provenance Actions
rdlfmt-0.4.1.tar.gz 86.1 kB With provenance Details for rdlfmt-0.4.1.tar.gz

Built distributions (wheels)

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

Total release size: 8.6 MB

Release files / rdlfmt-0.4.1.tar.gz

Download URL rdlfmt-0.4.1.tar.gz
Size 86.1 kB
Tags Source
SHA-256 checksum
How to use checksums
f2e176552593f63d94695604fc250601dea3d6c68ee4b83a91a417a1a25a7dc2
BLAKE2b-256 checksum
How to use checksums
b944737168f87983c4d2315f07935faca82aa49b4add8b04a8fa849f994267c1
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.1-py3-none-win_amd64.whl

Download URL rdlfmt-0.4.1-py3-none-win_amd64.whl
Size 1.1 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
0078caad5c0eb8e720be20194af07c7d61bdcdaa25d35aa54845af14da8610e5
BLAKE2b-256 checksum
How to use checksums
1bb05ac03b7b67df6c025db979a140e372ec71b310df1fc8f8891cc35e923d2f
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.1-py3-none-musllinux_1_2_x86_64.whl

Download URL rdlfmt-0.4.1-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
c9eebff5eda01ff131a91ab1bef11f6e9998f6bb51d17e659344b727ca17bed2
BLAKE2b-256 checksum
How to use checksums
cc937a206a14629d851c938188cc0a7ad2209841b6cf5484024e442b4c094b19
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.1-py3-none-musllinux_1_2_aarch64.whl

Download URL rdlfmt-0.4.1-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
80a7938993f1de556859f4acc1dce521149ee31dbc883e1f5fb6bfe442f55519
BLAKE2b-256 checksum
How to use checksums
e5afc0956630e0f152c34249d18a95b63e76be32f4d5c4c02e090dc7f3250a5f
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.1-py3-none-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

Download URL rdlfmt-0.4.1-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
e1880f6409df2f784eab7826f66d63c13c8730d29481b066c191bd644f3e6ca6
BLAKE2b-256 checksum
How to use checksums
c08dbdcc779b6f82a8d2d0f6006e11b20f5fca9913f50b8cc90df929824852cd
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.1-py3-none-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

Download URL rdlfmt-0.4.1-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
2677bd4a6984a0fc816f92c12719c7fdd08b8e313d04cca6e0b48df5aa2ca119
BLAKE2b-256 checksum
How to use checksums
ad87c78ffffc11082b6c6c90611db432dbcc3db17a18d6d1d2557d870e5f5ab2
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.1-py3-none-macosx_11_0_arm64.whl

Download URL rdlfmt-0.4.1-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
98d04b43bb70b7b42bda30889ed53cef466630b527ffbebbc1e0f147f9b55178
BLAKE2b-256 checksum
How to use checksums
4feac19da094696da00ff7e7446e6ceb2dca770f6ca150ed9ae174e99f053414
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.1-py3-none-macosx_10_12_x86_64.whl

Download URL rdlfmt-0.4.1-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
ce8cdde6f3d9be3c5a622aa62be526850bb3d3695c12b3e9f2f504b852a87702
BLAKE2b-256 checksum
How to use checksums
b8bbd8fcfabdd43bf2c78f1c2c9fc3b05259c10647ba35ad61ac0bb691524f48
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.1

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.1.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