Scroll to navigation

adr(1) General Commands Manual (prm) adr(1)

NAME

adrtool for working with Architecture Decision Records (ADRs)

SYNOPSIS

adr command [...]

DESCRIPTION

The tool adr simplifies maintaining documents.

COMMANDS

Adr is a multiplexer into individual miniature tools for specific operations.

init

Initialize directory of ADR documents.

new [-s SUPERSEDED] [-l TARGET:LINK:REVERSE-LINK] TITLE_TEXT...

Create a new numbered ADR. Elements of TITLE_TEXT are concatenated to form the title of the ADR.

Create a link between two ADRs.

Creates a link between two ADRs, from SOURCE to TARGET. SOURCE and TARGET are both a reference (number or partial filename) to an ADR. LINK is the description of the link created in the SOURCE. REVERSE-LINK is the description of the link created in the TARGET.

list

List all ADRs.

upgrade-repository

Upgrade ADR documents to the latest format.

generate toc

Generate a table of contents in in format.

generate graph

Generate a visualization of the links between decision records in format.

BUGS

This manual page is a stub. Consider the built-in help system by running .

AUTHORS

Zygmunt Krynicki <me@zygoon.pl>

July 18, 2021 adr-tools 3.0.0-1