hoa/cli

The Hoa\Cli library.

2.17.07.12 2017-07-12 07:24 UTC

README

Hoa

Build status Code coverage Packagist License

Hoa is a modular, extensible and structured set of PHP libraries.
Moreover, Hoa aims at being a bridge between industrial and research worlds.

Hoa\Cli

Help on IRC Help on Gitter Documentation Board

This meta-library provides the hoa command line. This is a shell tool to access libraries' commands.

Learn more.

Installation

With Composer, to include this library into your dependencies, you need to require hoa/cli:

$ composer require hoa/cli '~3.0'

For more installation procedures, please read the Source page.

Testing

Before running the test suites, the development dependencies must be installed:

$ composer install

Then, to run all the test suites:

$ vendor/bin/hoa test:run

For more information, please read the contributor guide.

Quick usage

Once installed, commands from libraries can be run with the following command line pattern:

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

Running hoa with no argument will list all the available commands with a small description. Note: If the option --no-verbose is present, the list of commands will not be formatted. Thus, used in conjunction with Zsh resources, you will be able to auto-complete any commands from any libraries for free.

On every command, there is at least the -h, --help and -? options, providing helps and usages.

To provide a command from a library, create a class inside the Bin/ directory. For instance, for a potential Hoa\Foo library, the bar command will be described by the Hoa\Foo\Bin\Bar class, located inside the Foo/Bin/Bar.php file.

Documentation

The hack book of Hoa\Cli contains detailed information about how to use this library and how it works.

To generate the documentation locally, execute the following commands:

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

More documentation can be found on the project's website: hoa-project.net.

Getting help

There are mainly two ways to get help:

Contribution

Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know.

License

Hoa is under the New BSD License (BSD-3-Clause). Please, see LICENSE for details.