https://github.com/anvouk/adrctl

Simple utility to help manage local Markdown Architectural Decision Records (MADRs)
https://github.com/anvouk/adrctl

adr architectural-decision-records architectural-decisions cli madr posix-sh shell-script utility

Last synced: 24 days ago
JSON representation

Simple utility to help manage local Markdown Architectural Decision Records (MADRs)

• Host: GitHub
• URL: https://github.com/anvouk/adrctl
• Owner: anvouk
• License: apache-2.0
• Created: 2022-11-20T16:19:47.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-22T21:41:20.000Z (about 2 years ago)
• Last Synced: 2024-11-10T10:41:20.498Z (3 months ago)
• Topics: adr, architectural-decision-records, architectural-decisions, cli, madr, posix-sh, shell-script, utility
• Language: Shell
• Homepage:
• Size: 9.77 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# adrctl

Custom-made little cli tool to handle markdown

[Architectural Decision Records (ADRs)](https://adr.github.io) inside your

project.

Based on [MADR format spec](https://adr.github.io/madr/)

## Usage

1. Open shell in your project

2. Create new ADR `adrctl new My awesome shining new feature`

This will create the file `0001-my-awesome-shining-new-feature.md` with the short

template inside the folder `docs/decisions`.

You can list ADRs with `adrctl list`

Help message with `adrctl`

> **Note**: ADRs file numbering is automatically handled by the cli.

## Installation

### Linux/macOS

1. Download `adrctl`

2. Ensure it has execute permissions `chmod +x adrctl`

3. Move it to local bin (e.g. `sudo mv adrctl /usr/local/bin`)

### Windows

1. Install [WSL](https://learn.microsoft.com/en-us/windows/wsl/install)

2. Follow the Linux installation procedure above

## Requirements to run

- POSIX sh (dash is ok)

- POSIX common utilities (e.g. `sed`, `tr`, etc)

## Known limitations

- Grouping MADRs in Sub directories is not yet supported (though can be manually

targeted by setting `ADRCTL_ADR_FOLDER=docs/decisions/sub` before running `adctl`)

- Long version template is not provided

## TODO

- Grouping in sub folders

- Long version template support

- Basic sh completion

## License

Apache-2.0 license