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 :doc:`Console component </components/console>`. You can also
use it to create your own commands.
Each Symfony application comes with a large set of commands. You can use
the list
command to view all available commands in the application:
$ php bin/console list
...
Available commands:
about Display information about the current project
completion Dump the shell completion script
help Display help for a command
list List commands
assets
assets:install Install bundle's web assets under a public directory
cache
cache:clear Clear the cache
...
Note
list
is the default command, so running php bin/console
is the same.
If you find the command you need, you can run it with the --help
option
to view the command's documentation:
$ php bin/console assets:install --help
Note
--help
is one of the built-in global options from the Console component,
which are available for all commands, including those you can create.
To learn more about them, you can read
:ref:`this section <console-global-options>`.
Console commands run in the :ref:`environment <config-dot-env>` 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
. You can also define this env vars when running the
command, for instance:
# clears the cache for the prod environment
$ APP_ENV=prod php bin/console cache:clear
.. versionadded:: 6.1 Console completion for Fish was introduced in Symfony 6.1.
.. versionadded:: 6.2 Console completion for Zsh was introduced in Symfony 6.2.
If you are using the Bash, Zsh or Fish shell, you can install Symfony's completion script to get auto completion when typing commands in the terminal. All commands support name and option completion, and some can even complete values.
First, you have to install the completion script once. Run
bin/console completion --help
for the installation instructions for
your shell.
Note
When using Bash, make sure you installed and setup the "bash completion"
package for your OS (typically named bash-completion
).
After installing and restarting your terminal, you're all set to use completion (by default, by pressing the Tab key).
Tip
Many PHP tools are built using the Symfony Console component (e.g. Composer, PHPstan and Behat). If they are using version 5.4 or higher, you can also install their completion script to enable console completion:
$ php vendor/bin/phpstan completion --help
$ composer completion --help
Tip
If you are using the :doc:`Symfony local web server
</setup/symfony_server>`, it is recommended to use the built-in completion
script that will ensure the right PHP version and configuration are used when
running the Console Completion. Run symfony completion --help
for the
installation instructions for your shell. The Symfony CLI will provide
completion for the console
and composer
commands.
Commands are defined in classes extending :class:`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\Attribute\AsCommand; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; // the name of the command is what users type after "php bin/console" #[AsCommand(name: 'app:create-user')] class CreateUserCommand extends Command { 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. You can also use these constants to make code more readable // return this if there was no problem running the command // (it's equivalent to returning int(0)) return Command::SUCCESS; // or return this if some error happened during the execution // (it's equivalent to returning int(1)) // return Command::FAILURE; // or return this to indicate incorrect command usage; e.g. invalid options // or missing arguments (it's equivalent to returning int(2)) // return Command::INVALID } }
You can optionally define a description, help message and the
:doc:`input options and arguments </console/input>` by overriding the
configure()
method:
// src/Command/CreateUserCommand.php // ... class CreateUserCommand extends Command { // the command description shown when running "php bin/console list" protected static $defaultDescription = 'Creates a new user.'; // ... protected function configure(): void { $this // the command help shown when running the command with the "--help" option ->setHelp('This command allows you to create a user...') ; } }
Tip
Defining the $defaultDescription
static property instead of using the
setDescription()
method allows to get the command description without
instantiating its class. This makes the php bin/console list
command run
much faster.
If you want to always run the list
command fast, add the --short
option
to it (php bin/console list --short
). This will avoid instantiating command
classes, but it won't show any description for commands that use the
setDescription()
method instead of the static property.
.. deprecated:: 6.1 The static property ``$defaultDescription`` was deprecated in Symfony 6.1. Instead, use the ``#[AsCommand]`` attribute to define the optional command description.
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 the configure()
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') ; } }
You can register the command by adding the AsCommand
attribute to it:
// src/Command/CreateUserCommand.php namespace App\Command; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Command\Command; // the "name" and "description" arguments of AsCommand replace the // static $defaultName and $defaultDescription properties #[AsCommand( name: 'app:create-user', description: 'Creates a new user.', hidden: false, aliases: ['app:add-user'] )] class CreateUserCommand extends Command { // ... }
If you can't use PHP attributes, register the command as a service and
:doc:`tag it </service_container/tags>` with the console.command
tag. If you're using the
:ref:`default services.yaml configuration <service-container-services-load-example>`,
this is already done for you, thanks to :ref:`autoconfiguration <services-autoconfigure>`.
.. deprecated:: 6.1 The static property ``$defaultName`` was deprecated in Symfony 6.1. Define your command name with the ``#[AsCommand]`` attribute instead.
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.
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://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 Command::SUCCESS; }
Now, try executing the command:
$ php bin/console app:create-user
User Creator
============
Whoa!
You are about to create a user.
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 :method:`ConsoleOutput::section() <Symfony\\Component\\Console\\Output\\ConsoleOutput::section>` method, which returns an instance of :class:`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!'); sleep(1); // Output displays "Hello\nWorld!\n" // overwrite() replaces all the existing section contents with the given content $section1->overwrite('Goodbye'); sleep(1); // Output now displays "Goodbye\nWorld!\n" // clear() deletes all the section contents... $section2->clear(); sleep(1); // 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); sleep(1); // Output is now completely empty! // setting the max height of a section will make new lines replace the old ones $section1->setMaxHeight(2); $section1->writeln('Line1'); $section1->writeln('Line2'); $section1->writeln('Line3'); return Command::SUCCESS; } }
Note
A new line is appended automatically when displaying information in a section.
.. versionadded:: 6.2 The feature to limit the height of a console section was introduced in Symfony 6.2.
Output sections let you manipulate the Console output in advanced ways, such as :ref:`displaying multiple progress bars <console-multiple-progress-bars>` which are updated independently and :ref:`appending rows to tables <console-modify-rendered-tables>` that have already been rendered.
Caution!
Terminals only allow overwriting the visible content, so you must take into account the console height when trying to write/overwrite section contents.
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 Command::SUCCESS; }
Now, you can pass the username to the command:
$ php bin/console app:create-user Wouter
User Creator
============
Username: Wouter
.. seealso:: Read :doc:`/console/input` for more information about console options and arguments.
To actually create a new user, the command has to access some
:doc:`services </service_container>`. 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 { public function __construct( private UserManager $userManager, ){ parent::__construct(); } // ... protected function execute(InputInterface $input, OutputInterface $output): int { // ... $this->userManager->create($input->getArgument('username')); $output->writeln('User successfully generated!'); return Command::SUCCESS; } }
Commands have three lifecycle methods that are invoked when running the command:
- :method:`Symfony\\Component\\Console\\Command\\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. - :method:`Symfony\\Component\\Console\\Command\\Command::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 required options/arguments. This method is called before validating the input. Note that it will not be called when the command is run without interaction (e.g. when passing the--no-interaction
global option flag). - :method:`Symfony\\Component\\Console\\Command\\Command::execute` (required)
- This method is executed after
interact()
andinitialize()
. It contains the logic you want the command to execute and it must return an integer which will be used as the command exit status.
Symfony provides several tools to help you test your commands. The most useful one is the :class:`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(): void { self::bootKernel(); $application = new Application(self::$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', // use brackets for testing array value, // e.g: '--some-option' => ['option_value'], ]); $commandTester->assertCommandIsSuccessful(); // the output of the command in the console $output = $commandTester->getDisplay(); $this->assertStringContainsString('Username: Wouter', $output); // ... } }
If you are using a :doc:`single-command application </components/console/single_command_tool>`,
call setAutoExit(false)
on it to get the command result in CommandTester
.
Tip
You can also test a whole console application by using :class:`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
:class:`Symfony\\Component\\Console\\Tester\\ApplicationTester` instead.
Caution!
When testing commands using the :class:`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);
Caution!
When testing InputOption::VALUE_NONE
command options, you must pass true
to them:
$commandTester = new CommandTester($command); $commandTester->execute(['--some-option' => true]);
Note
When using the Console component in a standalone project, use
:class:`Symfony\\Component\\Console\\Application`
and extend the normal \PHPUnit\Framework\TestCase
.
When testing your commands, it could be useful to understand how your command reacts on different settings like the width and the height of the terminal, or even the color mode being used. You have access to such information thanks to the :class:`Symfony\\Component\\Console\\Terminal` class:
use Symfony\Component\Console\Terminal; $terminal = new Terminal(); // gets the number of lines available $height = $terminal->getHeight(); // gets the number of columns available $width = $terminal->getWidth(); // gets the color mode $colorMode = $terminal->getColorMode(); // changes the color mode $colorMode = $terminal->setColorMode(AnsiColorMode::Ansi24);
.. versionadded:: 6.2 The support for setting and getting the current color mode was introduced in Symfony 6.2.
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 :doc:`event subscriber </event_dispatcher>` to listen to the
:ref:`ConsoleEvents::TERMINATE event <console-events-terminate>` and adds a log
message whenever a command doesn't finish with the 0
exit status.
When a command is running, many events are dispatched, one of them allows to react to signals, read more in :doc:`this section </components/console/events>`.
Symfony allows to profile the execution of any command, including yours. First,
make sure that the :ref:`debug mode <debug-mode>` and the :doc:`profiler </profiler>`
are enabled. Then, add the --profile
option when running the command:
$ php bin/console --profile app:my-command
Symfony will now collect data about the command execution, which is helpful to debug errors or check other issues. When the command execution is over, the profile is accessible through the web page of the profiler.
Tip
If you run the command in verbose mode (adding the -v
option), Symfony
will display in the output a clickable link to the command profile (if your
terminal supports links). If you run it in debug verbosity (-vvv
) you'll
also see the time and memory consumed by the command.
Caution!
When profiling the messenger:consume
command from the :doc:`Messenger </messenger>`
component, add the --no-reset
option to the command or you won't get any
profile. Moreover, consider using the --limit
option to only process a few
messages to make the profile more readable in the profiler.
.. versionadded:: 6.4 The ``--profile`` option was introduced in Symfony 6.4.
.. toctree:: :maxdepth: 1 :glob: console/*
The console component also contains a set of "helpers" - different small tools capable of helping you with different tasks:
- :doc:`/components/console/helpers/questionhelper`: interactively ask the user for information
- :doc:`/components/console/helpers/formatterhelper`: customize the output colorization
- :doc:`/components/console/helpers/progressbar`: shows a progress bar
- :doc:`/components/console/helpers/progressindicator`: shows a progress indicator
- :doc:`/components/console/helpers/table`: displays tabular data as a table
- :doc:`/components/console/helpers/debug_formatter`: provides functions to output debug information when running an external program
- :doc:`/components/console/helpers/processhelper`: allows to run processes using
DebugFormatterHelper
- :doc:`/components/console/helpers/cursor`: allows to manipulate the cursor in the terminal