Skip to content

Latest commit

 

History

History
36 lines (20 loc) · 1.02 KB

adr.md

File metadata and controls

36 lines (20 loc) · 1.02 KB

Usage

adr [COMMAND]

Description

Creation and management of architectural decision records (ADRs)

Commands

init Initialise the directory of architecture decision records.

new Creates a new, numbered ADR.

list Lists the filenames of the currently created architecture decision records.

version Prints the version of adr-j.

edit Starts the editor on the specified ADR.

config List of the currently set properties.

help Displays help information about the specified command.

Exit Codes:

0 Successful program execution.

64 Invalid input: an unknown option or invalid parameter was specified.

70 Execution exception: an exception occurred while executing the business logic.

Environment Variables:

ADR_AUTHOR The author of the ADR ADR_EDITOR The editor to open ADRs ADR_VISUAL The editor to open ADRs. Ignored when ADR_EDITOR set