npryce /adr-tools

Command-line tools for working with Architecture Decision Records

★ 5,777⑂ 632👁 88⑃ 88● 68▤ 6
ShellNOASSERTIONCreated 2016-02-04
下载:3.0.0adr-tools-3.0.0 ↓3.0.02018-07-25
+1
日增长
5,777
stars
632
forks
88
watchers
88
prs
68
issues
6
releases

README

ADR Tools
=========

A command-line tool for working with a log of [Architecture Decision Records][ADRs] (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.

1. Create an ADR directory in the root of your project:

        adr init doc/architecture/decisions

    This will create a directory named doc/architecture/decisions 
    containing the first ADR, which records that you are using ADRs
    to record architectural decisions and links to 
    [Michael Nygard's article on the subject][ADRs].

2. Create Architecture Decision Records

        adr new Implement as Unix shell scripts

    This will create a new, numbered ADR file and open it in your
    editor of choice (as specified by the VISUAL or EDITOR environment
    variable).

    To create a new ADR that supercedes a previous one (ADR 9, for example),
    use the -s option.

        adr new -s 9 Use Rust for performance-critical functionality

    This will create a new ADR file that is flagged as superceding
    ADR 9, and changes the status of ADR 9 to indicate that it is
    superceded by the new ADR.  It then opens the new ADR in your
    editor of choice.
    
3. For further information, use the built in help:

        adr help


See the tests for detailed examples.

The decisions for this tool are recorded as architecture decision records in the project repository. 

[ADRs]: http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions

Top issues

Latest release

3.0.0 3.0.0 2018-07-25
Search parent directories for the ADR directory (see issue 62)
 Better layout of generated graph visualisations

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON