Skip to content
A PHP based command-line interface tool for working with Architecture Decision Records (ADR)
PHP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
docs/arch
src
template
tests
.coveralls.yml
.gitignore
.travis.yml
LICENSE
README.md
adr.yml
composer.json
composer.lock
phpunit.xml

README.md

ADR Tools in PHP

Build Status Coverage Status

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

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.

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.

composer require globtec/phpadr --dev

Usage

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.

Create a new ADR

You may use the make:decision command:

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

Count the ADRs

You may use the workspace:count command:

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

List the ADRs

You may use the workspace:list command:

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

Help

For more help execute the following command:

./vendor/bin/phpadr <command> --help
You can’t perform that action at this time.