pointybeard / helpers-cli-input
Collection of classes for handling argv (and other) input when calling command-line scripts. Helps with parsing, collecting and validating arguments, options, and flags.
Installs: 2 363
Dependents: 2
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 1
Open Issues: 2
Requires
- php: >=7.2
- pointybeard/helpers-foundation-factory: ~1.0
- pointybeard/helpers-functions-flags: ~1.0
README
- Version: v1.2.2
- Date: Aug 06 2019
- Release notes
- GitHub repository
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.2.0"
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 -- -vvv -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
- Some inspiration taken from the Symfony Console Component (although no code has been used).