A PHP based command-line interface tool for working with Architecture Decision Records (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.
- Requires PHP version 7.1.3 or newer
- Multibyte String extension
You can install this tool using the Composer, execute the following command.
composer require globtec/phpadr --dev
After of install this project you may execute the binary phpadr in your terminal:
./vendor/bin/phpadr
If to execute the command above, it will be showd a list of all avaliable tool commands.
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.
You may use the make:decision command:
./vendor/bin/phpadr make:decision <title> [<status="Accepted">] [--config="adr.yml"]
You may use the workspace:count command:
./vendor/bin/phpadr workspace:count [--config="adr.yml"]
You may use the workspace:list command:
./vendor/bin/phpadr workspace:list [--config="adr.yml"]
For more help execute the following command:
./vendor/bin/phpadr <command> --help