init

Overview

The init command initializes a new ADR directory, using doc/adr by default. An alternate directory can optionally be supplied to the command to store ADRs in a different location. init will also create the .adr-dir file to store the directory location so that other commands can find the top level directory.

init creates an initial ADR for you as well, noting the decision you've made to document your Architectural Decisions using ADRs. Good job by you.

Help

Initializes the directory of Architecture Decision Records

Usage: adrs init [DIRECTORY]

Arguments:
  [DIRECTORY]  Directory to initialize [default: doc/adr]

Options:
  -h, --help     Print help
  -V, --version  Print version

Examples

# use the default location
# an initial ADR will be created in doc/adr/0001-record-architecture-decisions.md
adrs init

# put your ADRs somewhere else
# creates some/other/place/0001-record-architecture-decisions.md
adrs init some/other/place

Issues

See the cmd-init label for command specific issues.