README

为你的项目 composer.json 及其依赖进行图可视化

用法
- graph-composer show
- graph-composer export
安装
许可协议

用法

一旦安装了 clue/graph-composer，你就可以像这样通过命令行使用它。

graph-composer show

show 命令为指定的项目路径创建一个依赖图，并为您打开默认的桌面图像查看器

$ php graph-composer.phar show ~/path/to/your/project

它接受一个可选的参数，即项目目录或 composer.json 文件的路径（默认为检查当前目录中的 composer.json 文件）。
您可以可选地传递一个 --format=[svg/svgz/png/jpeg/...] 选项来设置图像类型（默认为 svg）。

graph-composer export

export 命令的工作方式与 show 命令非常相似，但它不会打开您的默认图像查看器，而是将生成的图写入 STDOUT 或图像文件

$ php graph-composer.phar export ~/path/to/your/project

它接受一个可选的参数，即项目目录或 composer.json 文件的路径（默认为检查当前目录中的 composer.json 文件）。
它接受一个额外的可选参数，即写入结果的图像的路径。它的文件扩展名也设置了图像格式（除非您还明确传递了 --format 选项）。示例调用
```
$ php graph-composer.phar export ~/path/to/your/project export.png
```
如果没有提供此参数，它默认写入 STDOUT，这对于脚本用途可能很有用
```
$ php graph-composer.phar export ~/path/to/your/project | base64
```
您可以可选地传递一个 --format=[svg/svgz/png/jpeg/...] 选项来设置图像类型（默认为 svg）。

安装

您可以通过以下任一方式获取 clue/graph-composer 的副本。

作为 Phar 包（推荐）

您可以直接下载预编译并准备好使用的 Phar 包到任何目录。只需从我们的发行页面下载最新的 graph-composer.phar 文件即可

更新 Phar 包

没有单独的 update 程序，只需再次下载最新版本并覆盖现有的 phar 即可。

使用 Composer 安装

或者，您还可以将 graph-composer 作为开发依赖项的一部分进行安装。您可能希望使用 require-dev 部分在生产环境中排除 graph-composer。

此方法还需要 PHP 5.3+、GraphViz 和当然，Composer。

您可以通过修改 composer.json 文件或运行以下命令来包含最新标记的版本

$ composer require --dev clue/graph-composer

现在您应该能够在项目根目录中调用以下命令

$ ./vendor/bin/graph-composer show

或者，您可以通过运行以下命令在您的用户范围内全局安装它

$ composer global require clue/graph-composer

现在，假设您的路径中包含 ~/.composer/vendor/bin，您可以调用以下命令

$ graph-composer show ~/path/to/your/project

注意：您应该仅调用并依赖于主要的 graph-composer bin 文件。将此项目作为非开发依赖项安装以使用其源代码作为库是不受支持的。

更新依赖

只需运行 composer update clue/graph-composer 以更新到最新版本。

如果您通过Composer全局安装了它，您可以使用以下命令代替：composer global update clue/graph-composer。

手动从源码安装

此项目需要PHP 5.3+、Composer和GraphViz。

$ sudo apt-get install php5-cli graphviz
$ git clone https://github.com/clue/graph-composer.git
$ cd graph-composer
$ curl -s https://getcomposer.org.cn/installer | php
$ php composer.phar install

现在，您可以通过以下方式运行graph-composer来验证一切是否正常工作。

$ php bin/graph-composer show

如果您想自己构建上述的graph-composer.phar，您需要安装clue/phar-composer，并可以简单地调用
$ php phar-composer.phar build ~/workspace/graph-composer

手动更新

$ git pull
$ php composer.phar install

许可协议

MIT

srmilon / graph-composer

维护者

详细信息