ADR Tools

A command-line tool for working with a log of Architecture Decision Records (ADRs).

Quick Start

Install ADR Tools.
Use the adr command to manage ADRs. Try running adr help.
ADRs are stored in a subdirectory of your project as Markdown files.
The default directory is doc/adr, but you can specify the directory
when you initialise the ADR log.

Create an ADR directory in the root of your project:

 adr init doc/architecture/decisions

<p>
  This will create a directory named <code>doc/architecture/decisions</code><br /> containing the first ADR, which records that you are using ADRs<br /> to record architectural decisions and links to<br /> <a rel="nofollow noopener" target="_blank" href="http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions">Michael Nygard&#8217;s article on the subject</a>. </li> 
  
  <li>
    Create Architecture Decision Records</p> <pre class="notranslate"><code> adr new Implement as Unix shell scripts

    <p>
      This will create a new, numbered ADR file and open it in your<br /> editor of choice (as specified by the VISUAL or EDITOR environment<br /> variable).<br /> To create a new ADR that supercedes a previous one (ADR 9, for example),<br /> use the -s option.
    </p>
    
    <pre class="notranslate"><code> adr new -s 9 Use Rust for performance-critical functionality

    <p>
      This will create a new ADR file that is flagged as superceding<br /> ADR 9, and changes the status of ADR 9 to indicate that it is<br /> superceded by the new ADR. It then opens the new ADR in your<br /> editor of choice. </li> 
      
      <li>
        For further information, use the built in help:</p> <pre class="notranslate"><code> adr help

      <p>
        See the tests for detailed examples.<br /> The decisions for this tool are recorded as architecture decision records in the project repository.
      </p>