function ListCommand::configure

File

vendor/symfony/console/Command/ListCommand.php, line 28

Class

ListCommand: ListCommand displays the list of all available commands for the application.

Namespace

Code

protected function configure() : void {
    $this->setName('list')
        ->setDefinition([
        new InputArgument('namespace', InputArgument::OPTIONAL, 'The namespace name', null, fn() => array_keys((new ApplicationDescription($this->getApplication()))
            ->getNamespaces())),
        new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw command list'),
        new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt', fn() => (new DescriptorHelper())->getFormats()),
        new InputOption('short', null, InputOption::VALUE_NONE, 'To skip describing commands\' arguments'),
    ])
        ->setDescription('List commands')
        ->setHelp(<<<'EOF'
The <info>%command.name%</info> command lists all commands:

  <info>%command.full_name%</info>

You can also display the commands for a specific namespace:

  <info>%command.full_name% test</info>

You can also output the information in other formats by using the <comment>--format</comment> option:

  <info>%command.full_name% --format=xml</info>

It's also possible to get raw list of commands (useful for embedding command runner):

  <info>%command.full_name% --raw</info>
EOF
);
}