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

Features

  • See the tests for detailed examples
  • Use the adr command to manage ADRs
  • A command-line tool for working with a log of Architecture Decision Records
  • Create a new, numbered ADR file and open it in your editor of choice
  • Create a new ADR that supercedes a previous one
  • Create a new ADR file that is flagged as superceding ADR 9

Project Samples

Project Activity

See All Activity >

Follow ADR Tools

ADR Tools Web Site

Other Useful Business Software
Try Google Cloud Risk-Free With $300 in Credit Icon
Try Google Cloud Risk-Free With $300 in Credit

No hidden charges. No surprise bills. Cancel anytime.

Use your credit across every product. Compute, storage, AI, analytics. When it runs out, 20+ products stay free. You only pay when you choose to.
Start Free
Rate This Project
Login To Rate This Project

User Reviews

Be the first to post a review of ADR Tools!

Additional Project Details

Programming Language

Unix Shell

Related Categories

Unix Shell Documentation Software, Unix Shell Command Line Tools

Registered

2022-09-07