Generar el registro de las deciciones de arquitectura (ADR).

Tablad de contenido

Instalacion

npm install -g adr-cli

For more information go to npmjs adr-cli.

Propiedades del CLI

Usage: adr-cli [options] [command]

Architecrture Decision Recored

Options:
  -v, --version          output the current version
  -h, --help             display help for command

Commands:
  new [title]            Create a new ADR file into document directory. Considering the relative directory in which it is located.
  index                  Create index file into document directory. Considering the relative directory in which it is located.
  show                   Show list of ADR files. For default is "doc/adr" in relative directory.
  init                   Initialize the working directory for the ADR`s
  status [options] [id]  Modify the status an ADR by id. The status chooice: proposed, acceptance, rejection, deprecation, superseding
  config                 Command to configure properties for the cli.
  help [command]         display help for command


    Example call config:
      $ adr-cli config get adrPath"
      $ adr-cli config set adrPath="<new_path>"

New ADR

Command line:

 adr-cli new -h

Ooutput:

Usage: adr-cli new [options] [title]

Create a new ADR file into document directory. Considering the relative directory in which it is located.

Arguments:
  title       Name of title for ADR

Options:
  -h, --help  display help for command

Generate Index of ADR`s

 adr-cli index -h

Ooutput:

Usage: adr-cli index [options]

Create index file into document directory. Considering the relative directory in which it is located.

Options:
  -h, --help  display help for command

Show list of ADR files

 adr-cli show -h

Ooutput:

Usage: adr-cli show [options]

Show list of ADR files. For default is "doc/adr" in relative directory.

Options:
  -h, --help  display help for command

Init work directory

Usage: adr-cli init

Initialize the working directory for the ADR`s

Options: -h, --help display help for command

Show and modify status of ADR

 adr-cli status -h

Ooutput:

Usage: adr-cli status [options] [id]

Modify the status an ADR by id. The status chooice: proposed, acceptance, rejection, deprecation, superseding

Arguments:
  id                        Default "0 (default: "0")

Options:
  -s,--status <new_status>  Set or change status for adr. The status chooice: proposed, acceptance, rejection, deprecation, superseding
  -h, --help                display help for command

Configure ADR relationship with other ADRs

adr-cli rel -h

Usage: adr-cli rel [options] [id]

Mark relation ADR to other/s ADR

Arguments:
  id                ADR source id (default: "0")

Options:
  -t,--to <id_adr>  ADR Id to add to source ADR. To add many Id`s, add separate by comma.
  -h, --help        display help for command

Show and modify config settings of adr-cli

 adr-cli config -h

Ooutput:

Usage: adr-cli config [options] [command]

Command to configure properties for the cli.

Options:
  -h, --help  display help for command

Commands:
  get <name>  Command to get properties value.
  set <name>  Command to set propertie value.
  path        Command to get the folder where is the config file for adr-tools.
  reset       Command to reset or regenerate the config file for defaults.
  show        Command to show key values of configurations. Properties si case sensitive

Ejemplo

Estados ADR

Los estados posibles son los siguientes:

| Estado | Color | | :---------- | :-----------------------------------: | | proposed | $\color{DodgerBlue}{proposed}$ | | acceptance | $\color{MediumSeaGreen}{acceptance}$ | | rejection | $\color{Tomato}{rejection}$ | | deprecation | $\color{Orange}{deprecation}$ | | superseding | $\color{Violet}{superseding}$ |