README

一个基于PHP的命令行界面工具，用于处理架构决策记录（ADR）。

关于ADR

架构决策记录（ADR）是一种捕捉重要架构决策及其上下文和影响的技术，由Michael Nygard在其文章《记录架构决策》中描述：[http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions)。

需求

需要PHP版本7.1.3或更高版本
多字节字符串扩展

安装

您可以使用Composer安装此工具，执行以下命令。

composer require globtec/phpadr --dev

使用方法

安装此项目后，您可以在终端中执行二进制文件phpadr

./vendor/bin/phpadr

如果执行上述命令，将显示所有可用工具命令的列表。

默认情况下，记录将存储在docs/arch中，要更改此工作空间，请使用带有配置文件路径的选项--config。

创建一个新的ADR

您可以使用make:decision命令

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

计算ADR的数量

您可以使用workspace:count命令

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

列出ADR

您可以使用workspace:list命令

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

帮助

要获取更多帮助，请执行以下命令

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

globtec / phpadr

维护者

详细信息