Weave Code
Console Laravel Package
symfony/console
The Console component eases the creation of beautiful and testable command line interfaces for PHP applications, with support for input/output handling, styling, and argument parsing.
Eases the creation of beautiful and testable command line interfaces
Frequently asked questions about Console
- What is symfony/console used for in Laravel?
- symfony/console is the underlying component that powers Laravel Artisan, providing command definition, argument parsing, input/output handling, styled terminal output, prompts, and progress bars. Laravel developers use it indirectly through Artisan and can use it directly for advanced CLI behavior. It is also suitable for standalone PHP CLI tools that need testable command interfaces.
- How do I install symfony/console in a Laravel app?
- In most Laravel applications you do not need to install it separately because Artisan already depends on symfony/console. For a standalone PHP CLI project, install it with Composer using composer require symfony/console. In Laravel, confirm the resolved version in composer.lock before relying on specific Symfony Console features.
- Is symfony/console already included with Laravel Artisan?
- Yes. Laravel Artisan is built on Symfony Console, so Laravel 10+ already includes a compatible symfony/console version through its dependency graph. This makes integration low-friction because the component is already present. You can extend Artisan commands or use Symfony Console features without adding a new top-level dependency in typical Laravel apps.
- Which Symfony Console version should I use with Laravel 10+?
- Laravel 10+ supports Symfony Console versions in the 6.4 through 8.0 range, so pin a deliberate range that matches your Laravel and PHP constraints. The assessed v8.1.0-BETA3 target is pre-stable, so production adoption should account for beta stability. Avoid drifting onto unsupported branches and verify the resolved version in composer.lock.
- How do I create a custom Symfony Console command in Laravel?
- For standard Artisan integration, extend Illuminate\Console\Command and register the command using Laravel conventions. For advanced or standalone use cases, you can subclass Symfony\Component\Console\Command\Command directly. Prefer composition with SymfonyStyle and explicit output handling for commands that need rich formatting or security-sensitive output.
- How can I test Symfony Console commands with ApplicationTester?
- ApplicationTester supports automated CLI interaction tests, which is important for CI/CD and regression safety. Use it to exercise command input, output, and exit behavior without manually running the terminal. Add tests for terminal output sanitization when commands write external or user-controlled context.
- What is the v5.4.54 security fix in symfony/console?
- The v5.4.54 release is a security patch that fixes escaping of context strings written to the terminal, addressing issue #65692. It is an old-branch patch only and does not introduce new features, deprecations, or breaking changes for the v8.1 target. If any service remains on Symfony 5.4, verify it is on v5.4.54 or a later patched release.
- How do I prevent terminal escape injection in Symfony Console output?
- Treat CLI output as a trust boundary, especially when commands interpolate external or user-controlled context into the terminal. Audit commands that write untrusted data, rely on Symfony escaped output paths, and avoid OUTPUT_RAW for untrusted content. Add tests for terminal output sanitization and review output handling in security-sensitive commands.
- Is symfony/console v8.1.0-BETA3 safe for production?
- The assessed v8.1.0-BETA3 target is pre-stable, so production adoption should account for beta stability. Prefer a deliberate supported stable range unless you specifically need beta features and can absorb upgrade risk. Keep CI on the selected Symfony major line and verify patched security releases in composer.lock.
- What are alternatives to symfony/console for Laravel CLI tools?
- Within Laravel, the practical choice is usually between Laravel's Illuminate\Console\Command wrapper and direct Symfony Console subclassing. The Laravel wrapper is preferred for standard Artisan integration, while direct Symfony Console is useful for advanced output or standalone PHP CLI utilities. Because Artisan depends on Symfony Console, replacing it outright is rarely necessary in a Laravel application.
Weaver
How can I help you explore Laravel packages today?