The Console Component

Installation

1

$ composer require symfony/console

Creating a Console Application

First, you need to create a PHP script to define the console application:

1
2
3
4
5
6
7
8
9
10
11
12
13

#!/usr/bin/env php
<?php
// application.php

require __DIR__.'/vendor/autoload.php';

use Symfony\Component\Console\Application;

$application = new Application();

// ... register commands

$application->run();

Then, you can register the commands using addCommand():

1
2

// ...
$application->addCommand(new GenerateAdminCommand());

You can also register inline commands and define their behavior thanks to the Command::setCode() method:

1
2
3
4
5
6
7
8

// ...
$application->register('generate-admin')
    ->addArgument('username', InputArgument::REQUIRED)
    ->setCode(function (InputInterface $input, OutputInterface $output): int {
        // ...

        return Command::SUCCESS;
    });

This is useful when creating a single-command application.

See the Console Commands article for information about how to create commands.

Using a PSR Container

The Application class accepts an optional third argument, a PSR-11 ContainerInterface. When provided, the application automatically wires several services from the container:

• event_dispatcher: sets the event dispatcher via setDispatcher()
• console.argument_resolver: sets the argument resolver via setArgumentResolver()
• console.command_loader: sets the command loader via setCommandLoader()
• console.command.ids: eagerly loads commands registered in the container
• services_resetter: resets services after run() completes

When using Symfony's ContainerInterface, the kernel.environment and kernel.debug parameters are also displayed in the application's long version output.

This makes it possible to build console applications with dependency injection without requiring HttpKernel or FrameworkBundle. Passing no container preserves all existing behavior:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

#!/usr/bin/env php
<?php

use Symfony\Component\Console\Application;
use Symfony\Component\DependencyInjection\ContainerBuilder;

require __DIR__.'/vendor/autoload.php';

$container = new ContainerBuilder();
// ... register your services, commands, etc.
$container->compile();

$application = new Application('my-cli', '1.0', $container);
$application->run();

Learn more