redbox/cli

Simple cli argument parser written in and for PHP.

v1.4 2021-05-09 15:22 UTC

This package is auto-updated.

Last update: 2024-10-24 20:43:14 UTC


README

redbox-logo-klein

Build Status Scrutinizer Code Quality Code Coverage Twitter URL

redbox-cli

This is a command line parser based on Climate by Joe Tannenbaum. We share a lot of similarities but i desided to take the getopt route and downgrade the number of lines in the code by 1/4 of the original size.

Howto use the package

Look in the examples folder for basic examples of how to use the package.

Installation

Using composer:

$ composer require redbox-cli

Requirements

The following versions of PHP are supported by this version.

  • PHP >= 7.3

Unit Testing

With the new 1.2 release we increased the test ratio from 64% in previous versions to 95% and that is making me proud. Also with the new release i have found a way to unit test the core component of this package (getopt(). While doing this we can make sure your implementation of Redbox-cli will run like a sunshine with any of your projects. If you want a little of what our new tests cover that was not possible before, checkout our examples directory for some great examples on how to use this great package.

Author

This package is created and maintained by Johnny Mast but it was based on Climate by Joe Tannenbaum. For feature requests and suggestions you could consider sending me an e-mail or fill out an issue.

License

Redbox-cli is released under the MIT public license.

LICENSE