rabe/helpers-cli-input
11
0
Fork 0
mirror of https://github.com/n3w/helpers-cli-input.git synced 2025-12-19 12:43:23 +00:00
Code Issues Projects Releases Wiki Activity
Collection of classes for handling argv (and other) input when calling command-line scripts. Helps with parsing, collecting, and validating arguments, options, and flags.
14 commits 1 branch 14 tags 103 KiB
Find a file
Alannah Kearney 4117ed266c Added getDisplayName() method to standardise how the name of an InputTypeInterface class wants to display it's name
2019-05-25 11:56:47 +10:00
example Updated README, CHANGELOG, example/example.php, and composer.json for 1.1.1 release 2019-05-24 18:06:57 +10:00
src/Input Added getDisplayName() method to standardise how the name of an InputTypeInterface class wants to display it's name 2019-05-25 11:56:47 +10:00
.gitignore Initial commit 2019-05-20 15:08:41 +10:00
CHANGELOG.md Updated README, CHANGELOG, example/example.php, and composer.json for 1.1.1 release 2019-05-24 18:06:57 +10:00
composer.json Updated README, CHANGELOG, example/example.php, and composer.json for 1.1.1 release 2019-05-24 18:06:57 +10:00
CONTRIBUTING.md Initial commit 2019-05-20 15:08:41 +10:00
LICENCE Initial commit 2019-05-20 15:08:41 +10:00
README.md Updated README, CHANGELOG, example/example.php, and composer.json for 1.1.1 release 2019-05-24 18:06:57 +10:00

README.md

PHP Helpers: Command-line Input and Input Type Handlers

Collection of classes for handling argv (and other) input when calling command-line scripts. Helps with parsing, collecting and validating arguments, options, and flags.

Installation

This library is installed via Composer. To install, use composer require pointybeard/helpers-cli-input or add "pointybeard/helpers-cli-input": "~1.1" to your composer.json file.

And run composer to update your dependencies:

$ curl -s http://getcomposer.org/installer | php
$ php composer.phar update

Requirements

This library makes use of the PHP Helpers: Flag Functions (pointybeard/helpers-functions-flags) and PHP Helpers: Factory Foundation Classes packages. They are installed automatically via composer.

To include all the PHP Helpers packages on your project, use composer require pointybeard/helpers or add "pointybeard/helpers": "~1.1" to your composer file.

Usage

Include this library in your PHP files with use pointybeard\Helpers\Cli. See example code in example/example.php. The example code can be run with the following command:

php -f example/example.php -- -vvvs -d example/example.json import

Support

If you believe you have found a bug, please report it using the GitHub issue tracker, or better yet, fork the library and submit a pull request.

Contributing

We encourage you to contribute to this project. Please check out the Contributing documentation for guidelines about how to get involved.

License

"PHP Helpers: Command-line Input and Input Type Handlers" is released under the MIT License.

Credits