Skip to content
A PHP library for command-line argument processing
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs document operands description May 31, 2018
resources/localization
src accept any value for options with required argument Jan 22, 2019
test
.gitignore
.travis.yml fix coverage report in ci May 15, 2018
CHANGELOG.md
LICENSE
Makefile
README.md update readme and docs to describe operands as positional arguments Nov 2, 2017
composer.json
phpunit.xml

README.md

GetOpt.PHP

Build Status Coverage Status Latest Stable Version Total Downloads License

GetOpt.PHP is a library for command-line argument processing. It supports PHP version 5.4 and above.

Features

  • Supports both short (eg. -v) and long (eg. --version) options
  • Option aliasing, ie. an option can have both a long and a short version
  • Cumulative short options (eg. -vvv)
  • Two alternative notations for long options with arguments: --option value and --option=value
  • Collapsed short options (eg. -abc instead of -a -b -c), also with an argument for the last option (eg. -ab 1 instead of -a -b 1)
  • Two alternative notations for short options with arguments: -o value and -ovalue
  • Quoted arguments (eg. --path "/some path/with spcaces") for string processing
  • Options with multiple arguments (eg. --domain example.org --domain example.com)
  • Operand (positional arguments) specification, validation and limitation
  • Command routing with specified options and operands
  • Help text generation
  • Default argument values
  • Argument validation

Upgrading

If you are still using a legacy version of GetOpt.PHP, please consider upgrading to version 3.

Only a few adjustments to your code are required to benefit from a lot of improvements. Refer to the upgrade guide for details.

Documentation

License

GetOpt.PHP is published under the MIT License.

You can’t perform that action at this time.