# Install adr-viewer with Homebrew Generate easy-to-read web pages for your Architecture Decision Records. Version 1.4.0 via Homebrew; verified 2026-07-02. ## Install ```sh sudo av install brew:adr-viewer ``` Additional install commands: ### macOS - Homebrew (100%): ```sh brew install adr-viewer ``` Evidence: local Homebrew formula metadata ## Package facts - **Package key:** brew:adr-viewer - **Package manager:** Homebrew - **Package manager page:** - **Version:** 1.4.0 - **Source summary:** Generate easy-to-read web pages for your Architecture Decision Records - **Homepage:** - **Repository:** - **Upstream docs:** - **License:** MIT - **Source archive:** - **Last updated:** 2026-07-02T11:12:14-04:00 - **Generated:** 2026-07-08T07:18:31+00:00 ## Executables - adr-viewer (cli) - adr-viewer (alias) ## Dependencies - python@3.14 ## Install behavior - Post-install hook: not defined - Bottle: available on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux ## Freshness - Page generated: 2026-07-08 - Package-manager version: 1.4.0 - Package-manager updated: 2026-07-02 - Local data: ok - Upstream repository: https://github.com/mrwilson/adr-viewer - info: No cached GitHub release or tag data was available. ## Project history and usage adr-viewer is a Python command-line tool that renders Architecture Decision Records into an easy-to-navigate web page, either by serving content locally or generating static HTML. It sits next to ADR Tools in the ADR ecosystem: ADR Tools creates and edits records, adr-viewer makes a browsable view of them. ### Project history The project records its own first ADR on 2018-09-02, choosing to document its architecture decisions with ADRs and explicitly pointing users toward Nat Pryce's ADR Tools. Its README says it can show ADRs as a local web server or static content and can include Mermaid diagrams embedded in fenced code blocks. The README documents a small CLI surface: `--adr-path`, `--output`, `--title`, `--serve`, `--port`, and `--help`. It defaults to `doc/adr/` because that is the default path generated by ADR Tools, showing that it was designed around the de facto file layout rather than inventing a new ADR store. After a quiet period, the 1.4.0 RC release note said the maintainer had time to maintain the project properly again. The 1.4.0 production release gathered maintenance work including dependency/security updates, Python version testing, Homebrew installation documentation, UTF-8 output, parsing refactors, and Mermaid support; 1.5.0 RC1 later fixed Mermaid feature detection. ### Adoption history The tool is officially installable from PyPI and Homebrew according to its README, and the provided package facts show a Homebrew formula. That gives it a lower-friction adoption path for teams already using ADR Tools or plain Markdown ADR directories. Its adoption is tied to the broader ADR convention rather than to a server product. Because it generates static content or runs a local server, it fits teams that want to publish architecture decisions inside existing documentation sites, CI artifacts, or repository pages. ### How it is used Users point `adr-viewer` at an ADR directory, usually `doc/adr/`, and either write an `index.html` file or serve the generated view on localhost. It can set a project title, change the output file, choose a port, and render Mermaid diagrams embedded in ADRs. The project is useful when ADRs have grown beyond a handful of Markdown files. It provides navigation and visual treatment while preserving the simple repository storage model that made ADRs attractive in the first place. ### Why package nerds care adr-viewer is a neat packaging companion because it turns a documentation convention into a single CLI with no hosted service requirement. Homebrew packaging is particularly natural: install the command, run it against a repo, produce static HTML. It also demonstrates how conventions propagate through packages. The default `doc/adr/` path is not a platform rule; it is inherited from ADR Tools and then reinforced by downstream tooling. ### Timeline - 2018: Project ADR 1 recorded the use of Architecture Decision Records. - 2018: The project adopted ADR Tools' ADR convention and `doc/adr` layout. - 2024: Version 1.4.0 RC1 announced renewed maintenance after a hiatus. - 2024: Version 1.4.0 production release included dependency, testing, Homebrew, and Mermaid-related work. - 2024: Version 1.5.0 RC1 fixed Mermaid feature detection. ### Related projects - ADR Tools is the upstream convention-setter for the default ADR path. - Mermaid is supported for diagrams embedded inside ADR Markdown. ### Sources - - - - - source_facts.package-manager ## Security Notes broad file, network, media, or database tool signal. - **Geiger risk:** blue / medium - broad file, network, media, or database tool signal ## Source Database Details - **Source Database:** Homebrew formula API - **Tap:** homebrew/core - **Full Name:** adr-viewer - **Version Scheme:** 0 - **Revision:** 5 - **Bottle Stable Root URL:** - **Deprecated:** no - **Disabled:** no - **Keg Only:** no - **URL Keys:** stable ## Related links - [Source-control packages](https://www.automicvault.com/pkg/source-control-tools/) - Belongs to a source-control command family. - [Secret-risk packages](https://www.automicvault.com/pkg/secret-risk-packages/) - Has protected-tool coverage, approval-gate, or non-low Geiger security signals. - [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata. - [Text processing packages](https://www.automicvault.com/pkg/text-processing-tools/) - Matched text, document, or structured-data processing metadata. - [python@3.14](https://www.automicvault.com/pkg/brew/python-3-14/) - Runtime dependency declared by Homebrew. - [adr-tools](https://www.automicvault.com/pkg/brew/adr-tools/) - Shares av.db curated category or tags: adr, cli, developer-tools, documentation. - [literate-git](https://www.automicvault.com/pkg/brew/literate-git/) - Shares av.db curated category or tags: cli, developer-tools, documentation, html. - [xmltoman](https://www.automicvault.com/pkg/brew/xmltoman/) - Shares av.db curated category or tags: cli, developer-tools, documentation, html. - [action-docs](https://www.automicvault.com/pkg/brew/action-docs/) - Shares av.db curated category or tags: cli, developer-tools, documentation. - [cargo-docset](https://www.automicvault.com/pkg/brew/cargo-docset/) - Shares av.db curated category or tags: cli, developer-tools, documentation. - [cheat](https://www.automicvault.com/pkg/brew/cheat/) - Shares av.db curated category or tags: cli, developer-tools, documentation. - [context7-mcp](https://www.automicvault.com/pkg/brew/context7-mcp/) - Shares av.db curated category or tags: cli, developer-tools, documentation. - [cppman](https://www.automicvault.com/pkg/brew/cppman/) - Shares av.db curated category or tags: cli, developer-tools, documentation. ## Combined YAML source View the package source record on GitHub. [combined/adr-viewer.yml](https://github.com/automic-vault/db/blob/main/combined/adr-viewer.yml) ## Sources - Nucleus package database - Geiger risk classifier - package-page enrichment - curated package history - package version freshness - av.db category and tag curation - package relationship graph - cross-ecosystem install command graph