Skip to main content

A visualisation tool for Architecture Decision Records

Project description


Build Status

Show off your Architecture Decision Records with an easy-to-navigate web page, either as a local web-server or generated static content.


  • Example above using Nat Pryce's adr-tools project
  • This project exposes its own Architecture Decision Records here


From PyPI

$ pip install adr-viewer

From local build

adr-viewer requires Python 2.7 (with Pip)

$ git clone
$ pip install -r requirements.txt
$ python install


Usage: adr-viewer [OPTIONS]

  --adr-path TEXT  Directory containing ADR files.  [default: doc/adr/]
  --output TEXT    File to write output to.  [default: index.html]
  --serve          Serve content at http://localhost:8000/
  --help           Show this message and exit.

The default for --adr-path is doc/adr/ because this is the default path generated by adr-tools.

Supported Record Types

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adr-viewer-1.1.1.tar.gz (4.3 kB view hashes)

Uploaded source

Built Distributions

adr_viewer-1.1.1-py2.7.egg (8.1 kB view hashes)

Uploaded 2 7

adr_viewer-1.1.1-py2-none-any.whl (5.2 kB view hashes)

Uploaded py2

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page