Aura.Cli vs Symfony Console: which should I use?

Aura.Cli offers low-level, composable tools for parsing and I/O with no framework overhead, while Symfony Console provides a full-featured CLI framework with commands, helpers, and better ecosystem integration. Choose Aura.Cli for maximum control, Symfony for rapid development.

How to handle subcommands like 'app create user' with Aura.Cli?

It doesn't natively support subcommands; you must implement custom logic using positional arguments or parse options manually, such as checking the first argument for command names and delegating accordingly.

Can I use Aura.Cli for colored output on Windows?

The formatter markup is POSIX-specific and may not display correctly on Windows terminals. You might need to disable formatting or use conditional checks for platform compatibility.

How to test CLI commands built with Aura.Cli?

Since components are decoupled, you can mock Context and Stdio objects in unit tests. For integration tests, run commands via shell and capture output, but there's no built-in testing utilities.

Does Aura.Cli support reading from files or pipes in stdin?

Yes, Stdio uses php://stdin by default, which can handle pipes and file redirection. Use in() or inln() methods to read input, but complex streaming requires manual stream handling.

How to integrate Aura.Cli with a dependency injection container?

It's designed to be standalone; you can instantiate objects like CliFactory and inject them manually. For auto-wiring, you may need adapters since it doesn't provide native DI hooks.

Open-Awesome

Aura.Cli

BSD-2-ClausePHP2.2.0

A PHP library providing request/response objects for CLI applications with Getopt support and help system.

GitHub

102 stars20 forks0 contributors

What is Aura.Cli?

Aura.Cli is a PHP library that provides request and response objects for command-line interface (CLI) applications. It simplifies CLI development by offering tools for parsing command-line arguments, managing standard I/O streams, and generating help documentation, similar to web frameworks but for terminal-based scripts.

Target Audience

PHP developers building command-line tools, scripts, or console applications who need structured argument parsing, formatted output, and help system generation.

Value Proposition

Developers choose Aura.Cli for its clean separation of concerns, flexible Getopt support, and POSIX terminal formatting, enabling maintainable CLI code without imposing a rigid framework or base class.

Overview

Command-Line Interface tools

Use Cases

Best For

Building PHP command-line tools with complex option parsing
Creating CLI applications that require formatted output (colors, styles)
Developing scripts with detailed help documentation and usage instructions
Parsing command-line arguments with support for short/long flags and positional arguments
Managing standard input/output/error streams in PHP CLI programs
Implementing Unix-like exit codes for CLI error handling

Not Ideal For

Projects needing a full CLI framework with built-in command routing and automatic dependency injection
Developers looking for interactive CLI tools with prompts, menus, or wizard-like interfaces
Teams already using Symfony Console or Laravel Artisan who prefer ecosystem integration and community plugins

Pros & Cons

Pros

Flexible Option Parsing

Supports complex definitions for short/long flags, aliases, multi-pass options, and optional/required parameters, as shown in the Getopt examples with arrays like 'foo,f:' and 'g*::'.

Separation of Concerns

Provides independent, composable components like Context, Stdio, and Help without enforcing a command structure, aligning with the library's philosophy for customizable CLI development.

POSIX Terminal Formatting

Includes formatter markup for colors, bold, underline, etc., in Stdio output, with a detailed cheat sheet for rich text in compatible terminals.

No Userland Dependencies

Requires only PHP 7.2+ with no external libraries, making it lightweight and easy to install via Composer or direct download.

Cons

No Command Abstraction

Lacks base command classes or routing mechanisms, forcing developers to write boilerplate code for each command, as evidenced by the manual script example in 'Writing Commands'.

Manual Error Handling

Getopt errors are collected but not automatically thrown, requiring explicit checks with hasErrors() and getErrors(), which can lead to verbose and error-prone code.

POSIX-Only Formatting Limitations

Formatter markup is designed for POSIX terminals and may not work on Windows or other platforms without additional configuration or fallbacks.

Frequently Asked Questions

Related Projects

PsySH

A REPL for PHP

Stars9,831

Forks319

Last commit13 hours ago

Cron Expression

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

Stars4,859

Forks340

Last commit2 years ago

CLI Menu

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

Stars1,942

Forks104

Last commit1 year ago

CLImate

PHP's best friend for the terminal.

Stars1,896

Forks126

Last commit12 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