adr-viewer

{
  "aliases": [],
  "alternatives": [],
  "build_dependencies": [],
  "categories": [],
  "caveats": null,
  "conflicts_with": [],
  "dependencies": [
    "python@3.14"
  ],
  "deprecated": 0,
  "deprecation_reason": null,
  "desc": "Generate easy-to-read web pages for your Architecture Decision Records",
  "disable_reason": null,
  "disabled": 0,
  "enrichment_fetched_at": "2026-06-20T23:35:18+00:00",
  "first_seen": "2026-06-20T23:34:18+00:00",
  "full_name": "adr-viewer",
  "github_default_branch": "master",
  "github_last_commit_at": "2024-12-02T11:12:57Z",
  "github_readme_excerpt": "# adr-viewer\n\n[![Latest Version](https://img.shields.io/pypi/v/adr-viewer)](https://pypi.org/project/adr-viewer/)\n\nShow off your Architecture Decision Records with an easy-to-navigate web page, either as a local web-server or generated static content.\nInclude diagrams in [Mermaid](https://mermaid.js.org) format using code blocks/fences, e.g. [test ADR 5](test/adr/0005-has-mermaid.md).\n\n## Examples\n\n\u003cimg src=\"https://github.com/mrwilson/adr-viewer/raw/master/images/example.png\" height=\"500px\"/\u003e\n\n* Example above using Nat Pryce\u0027s [adr-tools](https://github.com/npryce/adr-tools) project\n* This project exposes its own Architecture Decision Records [here](https://mrwilson.github.io/adr-viewer/index.html)\n\n## Installation\n\n### From PyPI\n\n```bash\n$ pip install adr-viewer\n```\n\n### From Homebrew\n\n```bash\n$ brew install adr-viewer\n```\n\nSee also the [`adr-viewer` formula page](https://formulae.brew.sh/formula/adr-viewer).\n\n### From local build\n\nadr-viewer requires Python 3.7 or higher (with Pip)\n\n```bash\n$ git clone https://github.com/mrwilson/adr-viewer\n$ pip install -r requirements.txt\n$ python setup.py install\n```\n\n## Usage\n\n```bash\nUsage: adr-viewer [OPTIONS]\n\nOptions:\n  --adr-path TEXT  Directory containing ADR files.  [default: doc/adr/]\n  --output TEXT    File to write output to.  [default: index.html]\n  --title TEXT     The project title   [default: the basename of the current directory]\n  --serve          Serve content at http://localhost:8000/\n  --port INT       Custom server port [default: 8000]\n  --help           Show this message and exit.\n```\n\nThe default for `--adr-path` is `doc/adr/` because this is the default path generated by `adr-tools`.\n\n## Supported Record Types\n\n\u003cimg src=\"https://github.com/mrwilson/adr-viewer/raw/master/images/record_types.png\"/\u003e\n",
  "github_repo": "mrwilson/adr-viewer",
  "github_stars": 186,
  "github_topics": [
    "accessibility",
    "architecture",
    "architecture-decision-records",
    "python"
  ],
  "homepage": "https://github.com/mrwilson/adr-viewer",
  "homepage_og_description": null,
  "homepage_og_image": null,
  "homepage_title": null,
  "installs_30d": 18,
  "installs_365d": 269,
  "installs_90d": 76,
  "keg_only": 0,
  "keg_only_reason": null,
  "last_seen": "2026-06-20T23:34:18+00:00",
  "license": "MIT",
  "llm_generated_at": null,
  "llm_model": null,
  "name": "adr-viewer",
  "oldnames": [],
  "one_liner": null,
  "optional_dependencies": [],
  "rank_30d": 7055,
  "rank_365d": 6612,
  "rank_90d": 6227,
  "raw_hash": "9657aeea6bf8c552",
  "recommended_dependencies": [],
  "revision": 5,
  "ruby_source_path": "Formula/a/adr-viewer.rb",
  "tap": "homebrew/core",
  "test_dependencies": [],
  "uses_from_macos": [],
  "version_head": null,
  "version_stable": "1.4.0",
  "versioned_formulae": [],
  "why_use_this": null
}