Metadata-Version: 2.4
Name: adrlint
Version: 0.2.0
Summary: A fast, opinionated linter and formatter for MADR architecture decision records
Author-email: Na'aman Hirschfeld <nhirschfeld@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/Goldziher/adrlint
Project-URL: Repository, https://github.com/Goldziher/adrlint.git
Project-URL: Issues, https://github.com/Goldziher/adrlint/issues
Keywords: adr,architecture-decision-record,madr,linter,markdown,cli,rust
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Text Processing
Classifier: Environment :: Console
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: certifi>=2026.7.22

# adrlint

[![PyPI](https://img.shields.io/pypi/v/adrlint?style=flat-square&color=f59e0b)](https://pypi.org/project/adrlint/)
[![License: MIT](https://img.shields.io/badge/License-MIT-f59e0b?style=flat-square)](https://github.com/Goldziher/adrlint/blob/main/LICENSE)

A fast Rust CLI that lints and formats [MADR](https://adr.github.io/madr/) architecture decision
records: structure, numbering, Markdown quality, and immutability of accepted decisions.

## Installation

```bash
pip install adrlint
```

The first run downloads the pre-compiled binary for your platform and verifies it against the release
checksum manifest. Prebuilt archives exist for Linux (glibc) `x86_64`/`aarch64`, macOS
`x86_64`/`aarch64`, and Windows `x86_64`.

Set `ADRLINT_BINARY` to use an existing executable instead of downloading one.

## Usage

```bash
adrlint init                    # write .adrlint.toml and docs/adr
adrlint lint                    # check every ADR
adrlint new "Use PostgreSQL"    # create the next sequential ADR
adrlint lint --format github    # GitHub annotations for CI
```

## Documentation

Rules, configuration, locking and the full CLI reference:
[https://github.com/Goldziher/adrlint](https://github.com/Goldziher/adrlint)

## License

MIT — see [LICENSE](https://github.com/Goldziher/adrlint/blob/main/LICENSE).
