globtec/phpadr

A PHP based command-line interface tool for working with ADR

ADR Tools in PHP

, _(*1)

A PHP based command-line interface tool for working with Architecture Decision Records (ADR)., _(*2)

About ADR

Architecture Decision Records (ADR) is a technique for capturing important architectural decisions, along with their context and consequences as described by Michael Nygard in his article: Documenting Architecture Decisions., _(*3)

Requirements

• Requires PHP version 7.1.3 or newer
• Multibyte String extension

Installation

You can install this tool using the Composer, execute the following command., _(*4)

composer require globtec/phpadr --dev

Usage

After of install this project you may execute the binary phpadr in your terminal:, _(*5)

./vendor/bin/phpadr

If to execute the command above, it will be showd a list of all avaliable tool commands., _(*6)

By default the records will be stored in docs/arch, to change this workspace use the option --config with the path of the config file., _(*7)

Create a new ADR

You may use the make:decision command:, _(*8)

./vendor/bin/phpadr make:decision <title> [<status="Accepted">] [--config="adr.yml"]

Count the ADRs

You may use the workspace:count command:, _(*9)

./vendor/bin/phpadr workspace:count [--config="adr.yml"]

List the ADRs

You may use the workspace:list command:, _(*10)

./vendor/bin/phpadr workspace:list [--config="adr.yml"]

Help

For more help execute the following command:, _(*11)

./vendor/bin/phpadr <command> --help