Building a CLI Application with Symfony Console

Symfony Console organizes CLI commands, arguments, options, status codes and help output.

What It Does and When to Use It

Install a supported Symfony Console release through Composer. CLI commands consume arguments, communicate via STDOUT/STDERR, and return process exit codes; web handlers use HTTP status codes.

Requirements, Inputs and Expected Behavior

Confirm the runtime, extension, environment variables, and permissions before running the examples in production. Install symfony/console with Composer and run through an autoloaded entry point.

Example 1: Basic Operation

Install a supported Symfony Console release through Composer.

composer require symfony/console

Example 2: Behavior and Validation

Register a PHP attribute-based command in current Symfony Console instead of relying on removed defaultName behavior.

<?php
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
#[AsCommand(name:'app:report')]
final class ReportCommand extends Command {
    protected function execute(InputInterface $input, OutputInterface $output): int {
        $output->writeln('Report ready'); return Command::SUCCESS;
    }
}

Practical Example: Application Use

Create a console application and add the annotated report command.

<?php
use Symfony\Component\Console\Application;
$app=new Application('Admin Tools');
$app->add(new ReportCommand());
exit($app->run());

Important Behavior and Edge Cases

The second example highlights: Register a PHP attribute-based command in current Symfony Console instead of relying on removed defaultName behavior. The practical example adds: Create a console application and add the annotated report command.

Comparison with Related Approaches

Common Beginner Mistakes

Key Takeaways

• Symfony Console organizes CLI commands, arguments, options, status codes and help output.
• Create a console application and add the annotated report command.
• Avoid assuming $_SERVER has the same keys in both SAPIs.