macOS
Homebrew已验证 · 100%
brew install adr-viewerlocal Homebrew formula metadata
安装
其他安装命令
概览
软件包摘要
Generate easy-to-read web pages for your Architecture Decision Records
历史
项目历史与用法
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.
来源
安全态势
风险级别：blue
broad file, network, media, or database tool signal.
风险分类器
blue 风险 · 中 置信度 · tool
原因
- broad file, network, media, or database tool signal
信号
- text:record
安装行为
- formula 元数据中未记录 Homebrew post-install 钩子。
- Homebrew bottle 元数据适用于 6 个平台目标。
- 安装时包含 1 个运行时依赖。
建议审查
在无人值守的代理使用前，请检查该工具是否读取明文凭据、写入远程状态、发布制品或调用插件。
可执行文件
已安装的可执行文件
| 命令 | 类型 | 暴露范围 | 备注 |
|---|---|---|---|
adr-viewer | cli | 全局可执行文件 |
新鲜度
版本和新鲜度
这些信号区分页生成时间、软件包管理器活动和上游发布比较。只有存在证据 URL 和可比较版本时，才会提示版本落后。
页面生成时间2026-07-25
管理器版本1.4.0
管理器更新时间2026-07-10
本地数据OK
上游not checked
检测到的最新版本未检测到
https://github.com/mrwilson/adr-viewer
- 信息No cached GitHub release or tag data was available.https://github.com/mrwilson/adr-viewernone 置信度
安装元数据
软件包元数据
| 软件包键 | brew:adr-viewer |
|---|---|
| 版本 | 1.4.0 |
| 软件包管理器 | Homebrew |
| 软件包管理器页面 | https://formulae.brew.sh/formula/adr-viewer |
| 主页 | https://github.com/mrwilson/adr-viewer |
| 仓库 | https://github.com/mrwilson/adr-viewer |
| 上游文档 | https://github.com/mrwilson/adr-viewer#readme |
| 许可证 | MIT |
| 源码归档 | https://files.pythonhosted.org/packages/1b/72/0f787da38d0f9d69c06b31d8f412735ed4fad383edd7f7d2286f4fc7b5b0/adr_viewer-1.4.0.tar.gz |
| 最后更新 | 2026-07-10T10:17:21Z |
| Pulse | updated |
| 依赖 | python@3.14 |
| Bottle | 可用 (于 arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux) |
| Homebrew post-install | 未定义 |
| 服务 | 未声明 |
注册表事实
源数据库详情
| Source Database | Homebrew formula API |
|---|---|
| Tap | homebrew/core |
| Full Name | adr-viewer |
| Version Scheme | 0 |
| Revision | 6 |
| Bottle Stable Root URL | https://ghcr.io/v2/homebrew/core |
| Deprecated | no |
| Disabled | no |
| Keg Only | no |
| URL Keys |
|
来源线索
由仓库数据生成
此页面由 av-web 从 scripts/generate-pkg-sqlite.py 生成的私有软件包 SQLite 工件提供。
Combined YAML source
View the package source record on GitHub.
使用的来源
- Geiger risk classifier
- Nucleus package database
- av.db category and tag curation
- cross-ecosystem install command graph
- curated package history
- package relationship graph
- package version freshness
- package-page enrichment