ulrichsg/getopt-php
Command line arguments parser for PHP 7.1 and above
Maintainers
Requires
- php: ^7.1 || ^8.0
- ext-mbstring: *
Requires (Dev)
Suggests
None
Provides
None
Conflicts
None
Replaces
None
MIT 9313ecde04f7bed262716e3a4d32a5e2cea3ffad
- Ulrich Schmidt-Goertz <ulrich.woop@schmidt-goertz.de>
- Thomas Flori <thflori.woop@gmail.com>
This package is auto-updated.
Last update: 2026-06-02 13:57:18 UTC
README
👁 .github/workflows/push.yml
👁 Test Coverage
👁 Maintainability
👁 Latest Stable Version
👁 Total Downloads
👁 License
GetOpt.PHP is a library for command-line argument processing. It supports PHP version 7.1 and above.
Releases
For an overview of the releases with a changelog please have look here: https://github.com/getopt-php/getopt-php/releases
Features
- Supports both short (e.g.
-v) and long (e.g.--version) options - Option aliasing, ie. an option can have both a long and a short version
- Cumulative short options (e.g.
-vvv) - Two alternative notations for long options with arguments:
--option valueand--option=value - Collapsed short options (e.g.
-abcinstead of-a -b -c), also with an argument for the last option (e.g.-ab 1instead of-a -b 1) - Two alternative notations for short options with arguments:
-o valueand-ovalue - Quoted arguments (e.g.
--path "/some path/with spaces") for string processing - Options with multiple arguments (e.g.
--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.
