A command-line tool for working with Architecture Decision Records (ADRs).
-
Download the latest version of the adr-cli tool from the Releases page
It's available for both Windows & Linux. -
Copy the executable to a location mentioned in the PATH of your system.
You can use this tool to create a directory for your ADR documents to be stored in and create new ADR files.
An index file will also be created on initial setup.
adr-cli init
This will create the necessary folder (/docs/adr) from where you are running the command, including the initial document (0001-record-architecture-decisions.md) and the index file (0000-index.md).
Once created, it will try to open the initial file in your Markdown editor.
adr-cli init
Placeholder, does nothing yet.
This command is inherited from the previous implementation and can be deleted.
adr-cli new "New decision"
Will create a new ADR document with the mentioned title and a follow-up number.
The document will have the Proposed status.
The -s flag (supercedes) can be used like the following:
./adr-cli new "Superseded decision" -s "0003-another-decision.md"
This will result in an index like the following example:
# Index
| Number | Title | Superseded by |
| ------ | ----- | ------------- |
| 1 | [Record Architecture Decisions](./0001-record-architecture-decisions.md)| |
| 2 | [new-decision](./0002-new-decision.md)| |
| 3 | ~~[Another decision](./0003-another-decision.md)~~| [5 - superseded-decision](./0005-superseded-decision.md) |
| 4 | [Another decision](./0004-another-decision.md)| |
| 5 | [superseded-decision](./0005-superseded-decision.md)| |
Placeholder, does nothing yet.
This command is inherited from the previous implementation and can be deleted.
Placeholder, does nothing yet.
This command is inherited from the previous implementation and can be deleted.
If you don't want to use the Releases published in this repository, you can also publish them yourselves.
The FolderProfile in this solution is set up to do this.
If you're a fan of the dotnet CLI, publish using the following command:
dotnet publish -r win-x64 -c Release /p:PublishSingleFile=true /p:PublishTrimmed=trueThis tool was originally started by GingerTommy. After having waited for a couple of months for my PR's to get approved, I've decided to create a new repository for the tool and use the original as a base.