Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jandev/adr-cli
A Windows equivalent of adr-tools (https://github.com/npryce/adr-tools). Original on https://github.com/GingerTommy/adr-cli, but appears to be abandonned.
https://github.com/jandev/adr-cli
adr architecture documentation
Last synced: about 1 month ago
JSON representation
A Windows equivalent of adr-tools (https://github.com/npryce/adr-tools). Original on https://github.com/GingerTommy/adr-cli, but appears to be abandonned.
- Host: GitHub
- URL: https://github.com/jandev/adr-cli
- Owner: Jandev
- License: mit
- Created: 2020-10-01T06:12:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-29T13:32:30.000Z (almost 3 years ago)
- Last Synced: 2024-05-01T13:04:41.429Z (8 months ago)
- Topics: adr, architecture, documentation
- Language: C#
- Homepage:
- Size: 57.6 KB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# ADR CLI tooling
A command-line tool for working with Architecture Decision Records (ADRs).
# Installation
* Download the latest version of the adr-cli tool from the [Releases page](https://github.com/Jandev/adr-cli/releases)
It's available for both Windows & Linux.
* Copy the executable to a location mentioned in the PATH of your system.
# Usage
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.
## Init
`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.
## List
`adr-cli init`
Placeholder, does nothing yet.
This command is inherited from the previous implementation and can be deleted.
## New
`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)| |
```
## Link
Placeholder, does nothing yet.
This command is inherited from the previous implementation and can be deleted.
## Generate
Placeholder, does nothing yet.
This command is inherited from the previous implementation and can be deleted.
# Publishing
If you don't want to use the [Releases published in this repository](https://github.com/Jandev/adr-cli/releases), 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:
```powershell
dotnet publish -r win-x64 -c Release /p:PublishSingleFile=true /p:PublishTrimmed=true
```
# Credits
This tool was originally started by [GingerTommy](https://github.com/GingerTommy/adr-cli). 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.