hoa/cli

The Hoa\Cli library.

, _(*1)

, _(*2)

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

Hoa\Cli

, _(*4)

This meta-library provides the hoa command line. This is a shell tool to access libraries' commands., _(*5)

Learn more., _(*6)

Installation

With Composer, to include this library into your dependencies, you need to require hoa/cli:, _(*7)

$ composer require hoa/cli '~3.0'

For more installation procedures, please read the Source page., _(*8)

Testing

Before running the test suites, the development dependencies must be installed:, _(*9)

$ composer install

Then, to run all the test suites:, _(*10)

$ vendor/bin/hoa test:run

For more information, please read the contributor guide., _(*11)

Quick usage

Once installed, commands from libraries can be run with the following command line pattern:, _(*12)

$ 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., _(*13)

On every command, there is at least the -h, --help and -? options, providing helps and usages., _(*14)

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., _(*15)

Documentation

The hack book of Hoa\Cli contains detailed information about how to use this library and how it works., _(*16)

To generate the documentation locally, execute the following commands:, _(*17)

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

More documentation can be found on the project's website: hoa-project.net., _(*18)

Getting help

There are mainly two ways to get help:, _(*19)

• On the #hoaproject IRC channel,
• On the forum at users.hoa-project.net.

Contribution

Do you want to contribute? Thanks! A detailed contributor guide explains everything you need to know., _(*20)

License

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