Download the PHP package pointybeard/php-cli-lib without Composer
On this page you can find all versions of the php package pointybeard/php-cli-lib. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pointybeard/php-cli-lib
More information about pointybeard/php-cli-lib
Files in pointybeard/php-cli-lib
Package php-cli-lib
Short Description Collection of helpful classes to use when working on the command line (cli).
License MIT
Informations about the package php-cli-lib
PHP Command Line Interface (CLI) Library
- Version: v1.1.0
- Date: April 5th 2019
- Release notes
- GitHub repository
Collection of helpful classes to use when working on the command line (cli).
Installation
This library is installed via Composer. To install, use composer require pointybeard/php-cli-lib
or add "pointybeard/php-cli-lib": "~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
Usage
This library is broken into 3 distinct components: Message, Prompt, and Argument. They can be used as needed, although they do rely on each other internally.
Message
Prompt
Argument & Argument/Iterator
Include CLILib\Argument
in your scripts then create an instance of Argument\Iterator
. It will automatically look for arguments, or you can pass it your own argument string (see below).
Syntax Supported
This library supports the most common argument formats. Specifically -x
,--long
, /x
. It also supports use of =
or :
as a delimiter. The following are examples of supported argument syntax:
-x
--aa
--database=blah
-d:blah
--d blah
--database-name=blah
/d blah
-u http://www.theproject.com
-y something
-p:\Users\pointybeard\Sites\shellargs\
-p:"\Users\pointybeard\Sites"
-h:local:host
/host=local-host
Example
Running the Test Suite
You can check that all code is passing by running the following command from the shell-args folder:
./vendor/bin/phpunit --bootstrap vendor/autoload.php tests/ArgumentsTest
If you want to run code coverage (e.g. --coverage-html tests/reports/ ...
) you'll to install xdebug:
pecl channel-update pecl.php.net
pecl install xdebug
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 Command Line Interface (CLI) Library" is released under the MIT License.