hoa/cli

此包已废弃且不再维护。未建议替代包。

Hoa\Cli库。

2.17.07.12 2017-07-12 07:24 UTC

README

Hoa

Build status Code coverage Packagist License

Hoa是一组模块化、可扩展和结构化的PHP库。
此外,Hoa旨在成为工业界和研究界之间的桥梁。

Hoa\Cli

Help on IRC Help on Gitter Documentation Board

此元库提供了hoa命令行。这是一个shell工具,用于访问库命令。

了解更多.

安装

使用Composer,要将此库包含到依赖项中,您需要要求hoa/cli

$ composer require hoa/cli '~3.0'

有关更多安装说明,请参阅源代码页面

测试

在运行测试套件之前,必须安装开发依赖项

$ composer install

然后,要运行所有测试套件

$ vendor/bin/hoa test:run

有关更多信息,请参阅贡献指南

快速使用

安装完成后,可以使用以下命令行模式运行库中的命令

$ hoa <library-name>:<command-name> <options> <inputs>

不使用参数运行hoa将列出所有可用命令及其简要描述。注意:如果存在--no-verbose选项,则命令列表将不会格式化。因此,与Zsh资源结合使用时,您将能够免费自动完成任何库中的任何命令。

在每条命令中,至少有-h--help-?选项,提供帮助和用法。

要从库中提供一个命令,请在Bin/目录中创建一个类。例如,对于潜在的Hoa\Foo库,bar命令将由位于Foo/Bin/Bar.php文件中的Hoa\Foo\Bin\Bar类描述。

文档

Hoa\Cli的黑客手册包含了有关如何使用此库及其工作原理的详细信息。

要本地生成文档,请执行以下命令

$ composer require --dev hoa/devtools
$ vendor/bin/hoa devtools:documentation --open

更多文档可以在项目网站上找到:hoa-project.net

获取帮助

主要有两种方式可以获得帮助

贡献

你想贡献吗?谢谢!详细的贡献指南解释了你需要知道的一切。

许可

花项目遵循新BSD许可证(BSD-3-Clause)。请参阅许可证获取详细信息。