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.

Development Environment Setup

These instructions are for developers who want to build the adr tool from source or contribute to its development.

1. Install Go: Ensure you have Go installed on your system. We recommend using the latest stable version. You can find installation instructions at https://go.dev/doc/install.

2. Clone the Repository:

   git clone https://github.com/marouni/adr.git

3. Navigate to Project Directory:

   cd adr

4. Build the Project:

   go build .

   This will create an executable named adr (or adr.exe on Windows) in the project directory.

5. Run Tests: To ensure everything is working correctly, run the tests:

   go test ./...