How to create subcommands with GetOpt.PHP?

Use the command routing feature by defining options and operands for each command; the library routes based on specified arguments, but you'll need to handle the logic programmatically. Check the documentation for examples on setting up commands.

GetOpt.PHP or symfony/console for building CLI tools?

GetOpt.PHP is better for fine-grained control over argument parsing and validation in standalone scripts, while symfony/console offers a more integrated framework with built-in commands and helpers for larger applications. Choose based on whether you need parsing flexibility or a full CLI ecosystem.

How to set default values for options in GetOpt.PHP?

Define default values when adding options using the library's API, such as with the setDefault() method; this ensures fallback values if arguments aren't provided, as mentioned in the validation features.

Can GetOpt.PHP handle arguments with spaces?

Yes, it supports quoted arguments like --path "/some path/with spaces" for string processing, allowing proper handling of spaces in values as specified in the features list.

Examples of using GetOpt.PHP for command routing?

The documentation includes examples where you define operands and options to route commands; for instance, you can set up different actions based on the first operand, but implementation details require custom logic.

How to upgrade from GetOpt.PHP version 2 to version 3?

Follow the upgrade guide linked in the README; it outlines necessary code adjustments, such as changes to option definitions and validation methods, to migrate from legacy versions.

Open-Awesome

GetOpt

MITPHPv4.0.4

A PHP library for command-line argument processing with support for short/long options, operands, validation, and help generation.

Visit Website GitHub

344 stars63 forks0 contributors

What is GetOpt?

GetOpt.PHP is a PHP library designed for parsing and processing command-line arguments in scripts and applications. It solves the problem of handling complex argument structures, such as short/long options, operands, and validation, providing a standardized way to build command-line interfaces.

Target Audience

PHP developers building command-line tools, scripts, or applications that require robust argument parsing, such as CLI utilities, automation scripts, or console-based services.

Value Proposition

Developers choose GetOpt.PHP for its comprehensive feature set, including support for multiple argument notations, collapsed options, operand handling, and built-in help generation, all while maintaining a simple and flexible API.

Overview

A PHP library for command-line argument processing

Use Cases

Best For

Building PHP command-line tools with complex argument structures
Parsing and validating short and long options in CLI scripts
Generating automatic help documentation for console applications
Handling positional arguments (operands) with validation
Routing commands based on specific options and arguments
Creating professional-grade CLI interfaces in PHP

Not Ideal For

PHP projects using frameworks with integrated CLI components like Laravel Artisan or Symfony Console
Simple scripts where direct access to $argv suffices and full parsing is unnecessary overhead
Teams preferring configuration-driven argument definitions over programmatic setup

Pros & Cons

Pros

Flexible Argument Notation

Supports multiple styles such as --option value, --option=value, -o value, and -ovalue, accommodating diverse CLI conventions as highlighted in the features list.

Robust Operand Handling

Provides specification, validation, and limits for positional arguments, ensuring reliable processing of operands without manual checks.

Automatic Help Generation

Generates help text automatically based on defined options and commands, saving development time and improving user experience.

Comprehensive Validation

Includes argument validation and default values, reducing error-prone manual validation code, as noted in the features.

Cons

Legacy Upgrade Complexity

Version 3 introduced breaking changes requiring code adjustments, as mentioned in the upgrade guide, which can be a barrier for existing users.

Programmatic Configuration Overhead

Defining options and operands programmatically can be verbose compared to configuration-based libraries, adding boilerplate for simple setups.

Limited High-Level Abstractions

Focuses on low-level parsing; lacks built-in features for common CLI patterns like interactive prompts or advanced subcommand management without extra work.

Frequently Asked Questions

Related Projects

PsySH

A REPL for PHP

Stars9,830

Forks318

Last commit2 days ago

Cron Expression

CRON for PHP: Calculate the next or previous run date and determine if a CRON expression is due

Stars4,864

Forks337

Last commit2 years ago

CLI Menu

🖥 Build beautiful PHP CLI menus. Simple yet Powerful. Expressive DSL.

Stars1,946

Forks107

Last commit10 months ago

CLImate

PHP's best friend for the terminal.

Stars1,891

Forks124

Last commit8 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub