Console Commands

• Console Commands
  • The Console: APP_ENV & APP_DEBUG
  • Creating a Command
  • Configuring the Command
  • Registering the Command
  • Executing the Command
  • Console Output
    • Output Sections
  • Console Input
  • Getting Services from the Service Container
  • Command Lifecycle
  • Testing Commands
  • Logging Command Errors
  • Learn More

Console Commands

The Symfony framework provides lots of commands through the bin/console script (e.g. the well-known bin/console cache:clear command). These commands are created with the Console component. You can also use it to create your own commands.

The Console: APP_ENV & APP_DEBUG

Console commands run in the environment defined in the APP_ENV variable of the .env file, which is dev by default. It also reads the APP_DEBUG value to turn “debug” mode on or off (it defaults to 1, which is on).

To run the command in another environment or debug mode, edit the value of APP_ENV and APP_DEBUG.

Creating a Command

Commands are defined in classes extending Symfony\Component\Console\Command\Command. For example, you may want a command to create a user:

// src/Command/CreateUserCommand.php
namespace App\Command;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
class CreateUserCommand extends Command
{
    // the name of the command (the part after "bin/console")
    protected static $defaultName = 'app:create-user';
    protected function configure(): void
    {
        // ...
    }
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        // ... put here the code to create the user
        // this method must return an integer number with the "exit status code"
        // of the command.
        // return this if there was no problem running the command
        return 0;
        // or return this if some error happened during the execution
        // return 1;
    }
}

Configuring the Command

You can optionally define a description, help message and the input options and arguments:

// ...
protected function configure(): void
{
    $this
        // the short description shown while running "php bin/console list"
        ->setDescription('Creates a new user.')
        // the full command description shown when running the command with
        // the "--help" option
        ->setHelp('This command allows you to create a user...')
    ;
}

The configure() method is called automatically at the end of the command constructor. If your command defines its own constructor, set the properties first and then call to the parent constructor, to make those properties available in theconfigure() method:

// ...
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
class CreateUserCommand extends Command
{
    // ...
    public function __construct(bool $requirePassword = false)
    {
        // best practices recommend to call the parent constructor first and
        // then set your own properties. That wouldn't work in this case
        // because configure() needs the properties set in this constructor
        $this->requirePassword = $requirePassword;
        parent::__construct();
    }
    protected function configure(): void
    {
        $this
            // ...
            ->addArgument('password', $this->requirePassword ? InputArgument::REQUIRED : InputArgument::OPTIONAL, 'User password')
        ;
    }
}

Registering the Command

Symfony commands must be registered as services and tagged with the console.command tag. If you’re using the default services.yaml configuration, this is already done for you, thanks to autoconfiguration.

Executing the Command

After configuring and registering the command, you can run it in the terminal:

$ php bin/console app:create-user

As you might expect, this command will do nothing as you didn’t write any logic yet. Add your own logic inside the `execute() method.

Console Output

The `execute() method has access to the output stream to write messages to the console:

// ...
protected function execute(InputInterface $input, OutputInterface $output): int
{
    // outputs multiple lines to the console (adding "\n" at the end of each line)
    $output->writeln([
        'User Creator',
        '============',
        '',
    ]);
    // the value returned by someMethod() can be an iterator (https://secure.php.net/iterator)
    // that generates and returns the messages with the 'yield' PHP keyword
    $output->writeln($this->someMethod());
    // outputs a message followed by a "\n"
    $output->writeln('Whoa!');
    // outputs a message without adding a "\n" at the end of the line
    $output->write('You are about to ');
    $output->write('create a user.');
    return 0;
}

Now, try executing the command:

$ php bin/console app:create-user
User Creator
============
Whoa!
You are about to create a user.

Output Sections

The regular console output can be divided into multiple independent regions called “output sections”. Create one or more of these sections when you need to clear and overwrite the output information.

Sections are created with the ConsoleOutput::section() method, which returns an instance of Symfony\Component\Console\Output\ConsoleSectionOutput:

// ...
use Symfony\Component\Console\Output\ConsoleOutputInterface;
class MyCommand extends Command
{
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        if (!$output instanceof ConsoleOutputInterface) {
            throw new \LogicException('This command accepts only an instance of "ConsoleOutputInterface".');
        }
        $section1 = $output->section();
        $section2 = $output->section();
        $section1->writeln('Hello');
        $section2->writeln('World!');
        // Output displays "Hello\nWorld!\n"
        // overwrite() replaces all the existing section contents with the given content
        $section1->overwrite('Goodbye');
        // Output now displays "Goodbye\nWorld!\n"
        // clear() deletes all the section contents...
        $section2->clear();
        // Output now displays "Goodbye\n"
        // ...but you can also delete a given number of lines
        // (this example deletes the last two lines of the section)
        $section1->clear(2);
        // Output is now completely empty!
        return 0;
    }
}

Note

A new line is appended automatically when displaying information in a section.

Output sections let you manipulate the Console output in advanced ways, such as displaying multiple progress bars which are updated independently and appending rows to tables that have already been rendered.

Console Input

Use input options or arguments to pass information to the command:

use Symfony\Component\Console\Input\InputArgument;
// ...
protected function configure(): void
{
    $this
        // configure an argument
        ->addArgument('username', InputArgument::REQUIRED, 'The username of the user.')
        // ...
    ;
}
// ...
public function execute(InputInterface $input, OutputInterface $output): int
{
    $output->writeln([
        'User Creator',
        '============',
        '',
    ]);
    // retrieve the argument value using getArgument()
    $output->writeln('Username: '.$input->getArgument('username'));
    return 0;
}

Now, you can pass the username to the command:

$ php bin/console app:create-user Wouter
User Creator
============
Username: Wouter

See also

Read Console Input (Arguments & Options) for more information about console options and arguments.

Getting Services from the Service Container

To actually create a new user, the command has to access some services. Since your command is already registered as a service, you can use normal dependency injection. Imagine you have a App\Service\UserManager service that you want to access:

// ...
use App\Service\UserManager;
use Symfony\Component\Console\Command\Command;
class CreateUserCommand extends Command
{
    private $userManager;
    public function __construct(UserManager $userManager)
    {
        $this->userManager = $userManager;
        parent::__construct();
    }
    // ...
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        // ...
        $this->userManager->create($input->getArgument('username'));
        $output->writeln('User successfully generated!');
        return 0;
    }
}

Command Lifecycle

Commands have three lifecycle methods that are invoked when running the command:

initialize() (optional)

This method is executed before the interact() and theexecute() methods. Its main purpose is to initialize variables used in the rest of the command methods.

interact() (optional)

This method is executed after initialize() and beforeexecute(). Its purpose is to check if some of the options/arguments are missing and interactively ask the user for those values. This is the last place where you can ask for missing options/arguments. After this command, missing options/arguments will result in an error.

execute() (required)

This method is executed after interact() andinitialize(). It contains the logic you want the command to execute and it should return an integer which will be used as the command exit status.

Deprecated since version 4.4: Not returning an integer with the exit status as the result of `execute() is deprecated since Symfony 4.4.

Testing Commands

Symfony provides several tools to help you test your commands. The most useful one is the Symfony\Component\Console\Tester\CommandTester class. It uses special input and output classes to ease testing without a real console:

// tests/Command/CreateUserCommandTest.php
namespace App\Tests\Command;
use Symfony\Bundle\FrameworkBundle\Console\Application;
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
use Symfony\Component\Console\Tester\CommandTester;
class CreateUserCommandTest extends KernelTestCase
{
    public function testExecute()
    {
        $kernel = static::createKernel();
        $application = new Application($kernel);
        $command = $application->find('app:create-user');
        $commandTester = new CommandTester($command);
        $commandTester->execute([
            // pass arguments to the helper
            'username' => 'Wouter',
            // prefix the key with two dashes when passing options,
            // e.g: '--some-option' => 'option_value',
        ]);
        // the output of the command in the console
        $output = $commandTester->getDisplay();
        $this->assertContains('Username: Wouter', $output);
        // ...
    }
}

Tip

You can also test a whole console application by using Symfony\Component\Console\Tester\ApplicationTester.

Caution

When testing commands using the CommandTester class, console events are not dispatched. If you need to test those events, use the Symfony\Component\Console\Tester\ApplicationTester instead.

Caution

When testing commands using the Symfony\Component\Console\Tester\ApplicationTester class, don’t forget to disable the auto exit flag:

$application = new Application();
$application->setAutoExit(false);
$tester = new ApplicationTester($application);

Note

When using the Console component in a standalone project, use Symfony\Component\Console\Application and extend the normal \PHPUnit\Framework\TestCase.

Logging Command Errors

Whenever an exception is thrown while running commands, Symfony adds a log message for it including the entire failing command. In addition, Symfony registers an event subscriber to listen to the ConsoleEvents::TERMINATE event and adds a log message whenever a command doesn’t finish with the 0 exit status.

Learn More

• How to Call Other Commands
• How to Color and Style the Console Output
• How to Call a Command from a Controller
• How to Define Commands as Services
• How to Hide Console Commands
• Console Input (Arguments & Options)
• How to Make Commands Lazily Loaded
• Prevent Running the Same Console Command Multiple Times
• How to Style a Console Command
• Verbosity Levels

The console component also contains a set of “helpers” - different small tools capable of helping you with different tasks:

• Question Helper: interactively ask the user for information
• Formatter Helper: customize the output colorization
• Progress Bar: shows a progress bar
• Table: displays tabular data as a table
• Debug Formatter Helper: provides functions to output debug information when running an external program

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.