https://github.com/npryce/adr-tools

Command-line tools for working with Architecture Decision Records
https://github.com/npryce/adr-tools

architecture architecture-decision-records documentation markdown

Last synced: 2 days ago
JSON representation

Command-line tools for working with Architecture Decision Records

• Host: GitHub
• URL: https://github.com/npryce/adr-tools
• Owner: npryce
• License: other
• Created: 2016-02-04T16:11:31.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-25T18:22:02.000Z (8 months ago)
• Last Synced: 2024-12-03T13:02:53.966Z (9 days ago)
• Topics: architecture, architecture-decision-records, documentation, markdown
• Language: Shell
• Size: 128 KB
• Stars: 4,671
• Watchers: 89
• Forks: 590
• Open Issues: 64
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome - adr-tools - Command-line tools for working with Architecture Decision Records (Shell)
• awesome-architecture - ADR Tools
• awesome-github-repos - npryce/adr-tools - Command-line tools for working with Architecture Decision Records (Shell)
• awesome-starred - npryce/adr-tools - Command-line tools for working with Architecture Decision Records (markdown)
• awesome-docs - adr-tools
• jimsghstars - npryce/adr-tools - Command-line tools for working with Architecture Decision Records (Shell)

README

        
ADR Tools

=========

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

[![Build Status](https://travis-ci.org/npryce/adr-tools.svg?branch=master)](https://travis-ci.org/npryce/adr-tools)

Quick Start

-----------

[Install ADR Tools](INSTALL.md).

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](tests/) for detailed examples.

The decisions for this tool are recorded as [architecture decision records in the project repository](doc/adr/). 

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