adr-tool

adr-tool

easy CLI for ADR docs

• Demo
• Usage
• Commands

Demo

🎞️ Watch the full screencast

Usage

You can install it globally (npm install -g adr-tool) or use it with npx

$ npx adr-tool init
./docs/adr folder is created!
$ npx adr-tool create Use Markdown Architectural Decision Records
a decision created on ./docs/adr/0000-use-markdown-architectural-decision-records.md

Commands

• adr-tool create [TITLE]
• adr-tool help [COMMAND]
• adr-tool init
• adr-tool toc

adr-tool create [TITLE]

create a new decision and log it into docs/adr/README.md file

USAGE
  $ adr-tool create [TITLE]

ARGUMENTS
  TITLE  title of the decision

OPTIONS
  -h, --help                               show CLI help
  -t, --ticket=ticket                      technical ticket
  --status=accepted|deprecated|superseded

EXAMPLE
  $ adr-tool create Use ADR Tool
  a decision created on ./docs/adr/0000-use-adr-tool.md

See code: src/commands/create.ts

adr-tool help [COMMAND]

Display help for adr-tool.

USAGE
  $ adr-tool help [COMMAND]

ARGUMENTS
  COMMAND  Command to show help for.

OPTIONS
  -n, --nested-commands  Include all nested commands in the output.

See code: @oclif/plugin-help

adr-tool init

create docs/adr folder and copies template.md and README.md

USAGE
  $ adr-tool init

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ adr-tool init
  ./docs/adr folder is created!

See code: src/commands/init.ts

adr-tool toc

create docs/adr/README.md file

USAGE
  $ adr-tool toc

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ adr-tool toc
  ./docs/adr/README.md file is created!

See code: src/commands/toc.ts