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
- Host: GitHub
- URL: https://github.com/corani/adr
- Owner: corani
- License: mit
- Created: 2021-12-29T07:41:08.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-01T22:37:28.000Z (4 months ago)
- Last Synced: 2025-04-05T09:11:09.623Z (2 months ago)
- Topics: adr, architecture-decision-records, cli, golang, markdown
- Language: Go
- Homepage:
- Size: 5.32 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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`.