An open API service indexing awesome lists of open source software.

https://github.com/corani/adr

A simple command-line tool to manage ADRs in markdown format
https://github.com/corani/adr

adr architecture-decision-records cli golang markdown

Last synced: about 2 months ago
JSON representation

A simple command-line tool to manage ADRs in markdown format

Awesome Lists containing this project

README

        

# Architecture Decision Records

A simple command-line tool to manage ADRs in markdown format.

## Usage

- `adr init [path]`
Initialize the ADR path and create a `template.md`. Feel free to update the template, but leave
the yaml front-matter intact.
- `adr new `
Create a new ADR with the given title and open it in your `$EDITOR`.
- `adr show `
Show the ADR with the given id.
- `adr edit `
Open the ADR with the given id in your `$EDITOR`.
- `adr list`
List all ADRs with their status, date and title.
- `adr update `
Update the ADR with the given id, setting the status to one of: `proposed`, `accepted`,
`deprecated` or `superseded`.