ulrichsg / getopt-php
Command line arguments parser for PHP 7.1 and above
Installs: 3 785 216
Dependents: 92
Suggesters: 0
Security: 0
Stars: 337
Watchers: 12
Forks: 62
Open Issues: 3
Requires
- php: ^7.1 || ^8.0
- ext-mbstring: *
Requires (Dev)
- dev-master
- v4.0.3
- v4.0.2
- v4.0.1
- v4.0.0
- v4.0.0-alpha.1
- v3.x-dev
- v3.4.0
- v3.3.0
- v3.3.0-rc.1
- 3.2.2
- 3.2.1
- 3.2.0
- 3.2.0-alpha.1
- 3.1.x-dev
- 3.1.3
- 3.1.2
- 3.1.1
- 3.1.0
- 3.1.0-alpha.1
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
- 3.0.0-beta.1
- 3.0.0-alpha.8
- 3.0.0-alpha.7
- 3.0.0-alpha.6
- 3.0.0-alpha.4
- 3.0.0-alpha.3
- 2.x-dev
- 2.4.3
- 2.4.2
- 2.3.0
- 2.2.0
- 2.1.0
- 2.0.0
- 1.4.1
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.1
- 1.0.0
- dev-dependabot/github_actions/dot-github/workflows/actions/download-artifact-4.1.7
- dev-github-actions
- dev-phpunit-upgrade
- dev-php-requirement
- dev-type-declarations
This package is auto-updated.
Last update: 2024-12-03 22:44:12 UTC
README
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.