通过 
搜索
搜索viliam-husar / c4ml
C4 架构图生成器
dev-master
2015-11-12 20:31 UTC
Requires
- php: >=5.5
- phpdocumentor/graphviz: ~1.0
- symfony/class-loader: ~2.7
- symfony/config: ~2.7
- symfony/console: ~2.7
- symfony/options-resolver: ~2.7
- symfony/process: ~2.7
- symfony/yaml: ~2.7
This package is not auto-updated.
Last update: 2024-09-28 18:53:06 UTC
README
本应用程序受C4软件架构模型启发，如Simon Brown所描述。
注意：仍处于开发中。
需求
- PHP 5.5+
- Graphviz (dor)
安装
目前您可以通过composer安装C4ML。未来将提供更多选项。
$ composer require viliam-husar/c4ml
安装后，您可以运行C4ML
$ bin/vendor/c4ml
语法
请参阅example.c4ml以了解语法。一些限制
- 您需要为模型中的每个部分使用唯一的ID。
- 当定义用法时，您只能从/到引用：容器、外部系统、内部用户、外部用户。
用法
C4ML处理您的模型有几种选项。要查看所有选项，请使用--help选项
指定输出格式
由于C4ML使用Graphviz进行渲染，您可能可以将模型图渲染成多种格式（svg是默认格式）。
$ bin/vendor/c4ml example.c4ml example.svg -f svg $ bin/vendor/c4ml example.c4ml example.png -f png
通过容器视图选择内部系统
默认情况下，所有内部系统都以容器视图显示，并显示所有相关元素。如果您有包含多个内部系统的大型模型，您可能需要选择哪些系统应以这种方式显示。所有其他内部系统将以系统视图显示，并且仅在所选内部系统需要时显示。
$ bin/vendor/c4ml example.c4ml example.svg -s site $ bin/vendor/c4ml example.c4ml example.svg -s site -s orders
突出显示元素（容器、外部系统、内部用户、外部用户）
在某些情况下，您可能需要在图表中突出显示一个或多个元素。为此，请使用选项-l|--highlight
$ bin/vendor/c4ml example.c4ml example.svg -l site $ bin/vendor/c4ml example.c4ml example.svg -l site -l orders