Skip to content
A minimalist command line tool written in Go to work with Architecture Decision Records
Go
Branch: master
Clone or download
Latest commit 0ef4b48 May 5, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.travis.yml
README.md Update README.md May 5, 2019
commands.go
flags.go initial commit Aug 26, 2018
helpers.go
main.go

README.md

Build Status

ADR Go

A minimalist command line tool written in Go to work with Architecture Decision Records (ADRs).

Greatly inspired by the adr-tools with all of the added benefits of using the Go instead of Bash.

Quick start

Installing adr

Go to the releases page and grab one of the binaries that corresponds to your platform.

Alternatively, if you have a Go developement environment setup you can install it directly using :

go get github.com/marouni/adr && go install github.com/marouni/adr

Initializing adr

Before creating any new ADR you need to choose a folder that will host your ADRs and use the init sub-command to initialize the configuration :

adr init /home/user/my_adrs

Creating a new ADR

As simple as :

adr new my awesome proposition

this will create a new numbered ADR in your ADR folder : xxx-my-new-awesome-proposition.md. Next, just open the file in your preferred markdown editor and starting writing your ADR.

You can’t perform that action at this time.