adrs

adrs is a command-line tool for managing Architectural Decision Records.

Installation

Homebrew:

brew tap joshrotenberg/brew
brew install adrs

From source (requires the Rust toolchain):

git clone https://github.com/joshrotenberg/adrs
cd adrs
cargo install

Via cargo (aslo requires the Rust toolchain):

cargo install adrs

Via a released binary:

See Releases.

Command Line

Architectural Decision Record command line tool

Usage: adrs <COMMAND>

Commands:
  init      Initializes the directory of Architecture Decision Records
  new       Create a new, numbered Architectural Decision Record
  edit      Edit an existing Architectural Decision Record
  link      Link Architectural Decision Records
  list      List Architectural Decision Records
  config    Show the current configuration
  generate  Generates summary documentation about the Architectural Decision Records
  help      Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Custom templates

The adrs new command allows passing in custom templates using the handlebars templating language. Five template variables are respected:

Variable name	Value
number	Index of ADR
date	Current date
title	Title of ADR
superceded	Array of markdown links to superceded ADRs
linked	Array of markdown links to linked ADRs

Contributing

Contributions absolutely welcome. See the current issues.

License

See LICENSE-MIT or LICENSE-APACHE-2.0.