# 使用 Homebrew 安装 adr-viewer 查看 adr-viewer 的安装路径、可执行文件、元数据以及面向 AI 代理工作流的安全说明。 ## 安装 ```sh sudo av install brew:adr-viewer ``` 其他安装命令: ### macOS - Homebrew (100%): ```sh brew install adr-viewer ``` 证据: local Homebrew formula metadata ## 软件包事实 - **软件包键:** brew:adr-viewer - **软件包管理器:** Homebrew - **软件包管理器页面:** - **版本:** 1.4.0 - **来源摘要:** Generate easy-to-read web pages for your Architecture Decision Records - **主页:** - **仓库:** - **许可证:** MIT - **源码归档:** - **最后更新:** 2026-07-10T10:17:21Z - **已生成:** 2026-08-04T22:13:35+00:00 ## 可执行文件 - adr-viewer (cli) - adr-viewer (别名) ## 依赖 - python@3.14 ## 安装行为 - post-install 钩子: 未定义 - Bottle: 可用 于 arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux ## 版本和新鲜度 - 页面生成时间: 2026-08-04 - 管理器版本: 1.4.0 - 管理器更新时间: 2026-07-10 - 本地数据: OK - 上游仓库: https://github.com/mrwilson/adr-viewer - 信息: No cached GitHub release or tag data was available. ## 项目历史与用法 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. ### 项目历史 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. ### 采用历史 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. ### 使用方式 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. ### 为什么软件包爱好者会关心 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. ### 时间线 - 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. ### 来源 - - - - - source_facts.package-manager ## 安全说明 broad file, network, media, or database tool signal. - **Geiger 风险:** blue / 中 - broad file, network, media, or database tool signal ## 源数据库详情 - **Source Database:** Homebrew formula API - **Tap:** homebrew/core - **Full Name:** adr-viewer - **Version Scheme:** 0 - **Revision:** 6 - **Bottle Stable Root URL:** - **Deprecated:** no - **Disabled:** no - **Keg Only:** no - **URL Keys:** stable ## 相关链接 - [Source-control packages](https://pkg.so/zh-hans/source-control-tools/) - Belongs to a source-control command family. - [Secret-risk packages](https://pkg.so/zh-hans/secret-risk-packages/) - Has protected-tool coverage, approval-gate, or non-low Geiger security signals. - [Terminal utility packages](https://pkg.so/zh-hans/terminal-utilities/) - Matched terminal and command-line workflow metadata. - [Text processing packages](https://pkg.so/zh-hans/text-processing-tools/) - Matched text, document, or structured-data processing metadata. - [python@3.14](https://pkg.so/zh-hans/brew/python-3-14/) - Runtime dependency declared by Homebrew. - [adr-tools](https://pkg.so/zh-hans/brew/adr-tools/) - Shares pkgdb curated category or tags: adr, architecture-decisions, cli, developer-tools, documentation. - [markdown](https://pkg.so/zh-hans/brew/markdown/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, html. - [htmldoc](https://pkg.so/zh-hans/brew/htmldoc/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, html. - [texi2html](https://pkg.so/zh-hans/brew/texi2html/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, html. - [xmltoman](https://pkg.so/zh-hans/brew/xmltoman/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, html. - [adrs](https://pkg.so/zh-hans/brew/adrs/) - Shares pkgdb curated category or tags: adr, cli, developer-tools, documentation. - [literate-git](https://pkg.so/zh-hans/brew/literate-git/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, html. - [libxml2](https://pkg.so/zh-hans/brew/libxml2/) - Shares pkgdb curated category or tags: cli, developer-tools, html. - [cppman](https://pkg.so/zh-hans/brew/cppman/) - Both packages touch the same language runtime or ecosystem. Shared terms: cli, developer, developer-tools, documentation, pages. ## Combined YAML source View the package source record on GitHub. [combined/adr-viewer.yml](https://github.com/mxcl/pkgdb/blob/main/combined/adr-viewer.yml) ## 来源 - pkg.so package database - Geiger risk classifier - package-page enrichment - curated package history - package version freshness - pkgdb category and tag curation - package relationship graph - cross-ecosystem install command graph