12345678910111213

$php bin/console list...Available commands:  about             Display information about the current project  completion        Dump the shell completion scripthelp              Displayhelpfor acommand  list              List commands assets  assets:install    Install bundle's web assets under a public directory cache  cache:clear       Clear the cache...

1

$php bin/console assets:install --help

Note

When using Bash, make sure you installed and setup the "bash completion"package for your OS (typically namedbash-completion).

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:

12

$php vendor/bin/phpstan completion --help$composer completion --help

Tip

If you are using theSymfony local web server, it is recommended to use the built-in completionscript that will ensure the right PHP version and configuration are used whenrunning the Console Completion. Runsymfony completion --help for theinstallation instructions for your shell. The Symfony CLI will providecompletion for theconsole andcomposer commands.

1234567891011121314151617181920212223242526272829303132

// src/Command/CreateUserCommand.phpnamespaceApp\Command;useSymfony\Component\Console\Attribute\AsCommand;useSymfony\Component\Console\Command\Command;useSymfony\Component\Console\Input\InputInterface;useSymfony\Component\Console\Output\OutputInterface;// the name of the command is what users type after "php bin/console"#[AsCommand(name:'app:create-user')]classCreateUserCommandextendsCommand{protectedfunctionexecute(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    }}

Tip

Using the#[AsCommand] attribute to define a description instead ofusing thesetDescription() method allows to get the command description withoutinstantiating its class. This makes thephp bin/console list command runmuch faster.

If you want to always run thelist command fast, add the--short optionto it (php bin/console list --short). This will avoid instantiating commandclasses, but it won't show any description for commands that use thesetDescription() method instead of the attribute to define the commanddescription.

1234567891011121314151617181920212223

// ...protectedfunctionexecute(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;}

123456

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

Note

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

Warning

Terminals only allow overwriting the visible content, so you must take intoaccount the console height when trying to write/overwrite section contents.

1234567891011121314151617181920212223242526

useSymfony\Component\Console\Input\InputArgument;// ...protectedfunctionconfigure():void{$this// configure an argument        ->addArgument('username', InputArgument::REQUIRED,'The username of the user.')// ...    ;}// ...publicfunctionexecute(InputInterface$input, OutputInterface$output):int{$output->writeln(['User Creator','============','',    ]);// retrieve the argument value using getArgument()$output->writeln('Username: '.$input->getArgument('username'));return Command::SUCCESS;}

12345

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

12345678910111213141516171819202122232425

// ...useApp\Service\UserManager;useSymfony\Component\Console\Command\Command;classCreateUserCommandextendsCommand{publicfunction__construct(private UserManager$userManager,    ){parent::__construct();    }// ...protectedfunctionexecute(InputInterface$input, OutputInterface$output):int{// ...$this->userManager->create($input->getArgument('username'));$output->writeln('User successfully generated!');return Command::SUCCESS;    }}

1234567891011121314151617181920212223242526272829303132333435

// tests/Command/CreateUserCommandTest.phpnamespaceApp\Tests\Command;useSymfony\Bundle\FrameworkBundle\Console\Application;useSymfony\Bundle\FrameworkBundle\Test\KernelTestCase;useSymfony\Component\Console\Tester\CommandTester;classCreateUserCommandTestextendsKernelTestCase{publicfunctiontestExecute():void{self::bootKernel();$application =newApplication(self::$kernel);$command =$application->find('app:create-user');$commandTester =newCommandTester($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);// ...    }}

123456789101112131415

useSymfony\Component\Console\Terminal;$terminal =newTerminal();// 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);

1

$php bin/console --profile app:my-command