https://github.com/horgix/madr-cli
Command Line Interface to create & manage Markdown Architectural Decision Records
https://github.com/horgix/madr-cli
Last synced: 26 days ago
JSON representation
Command Line Interface to create & manage Markdown Architectural Decision Records
- Host: GitHub
- URL: https://github.com/horgix/madr-cli
- Owner: Horgix
- Created: 2021-02-20T16:53:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-21T00:12:22.000Z (over 5 years ago)
- Last Synced: 2026-04-24T04:07:16.214Z (3 months ago)
- Language: Rust
- Size: 1.95 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Markdown Architectural Decision Records - Command Line Interface
`madr-cli` is a small command line interface to create and manage ADRs
(Architectural Decision Records) using [_madr_ (Markdown
ADR)](https://adr.github.io/madr/) as format.
## Objectives
`madr-cli` aims for:
- Simplicity of usage. Everything should make sense out of the box
- Configurability of madr optionnal sections
- Portability
Of course, `madr-cli` uses madr to record its own decisions 🙂
## How is it different from `adr-tools` ?
You might already know [`adr-tools`](https://github.com/npryce/adr-tools) that
fits a similar need. However:
- `adr-tools` is written in pure shell and thus depends on some external tools
such as grep, sed, awk, etc., making it environment-dependant and not that
much portable.
- At time of writing, `adr-tools` is unmaintained for 3+ years
- At time of writing, the CI of `adr-tools` is reporting to fail