function HelpCommand::configure

Overrides Command::configure

File

vendor/symfony/console/Command/HelpCommand.php, line 30

Class

HelpCommand

HelpCommand displays the help for a given command.

Namespace

Symfony\Component\Console\Command

Code

protected function configure() : void {
    $this->ignoreValidationErrors();
    $this->setName('help')
        ->setDefinition([
        new InputArgument('command_name', InputArgument::OPTIONAL, 'The command name', 'help', fn() => array_keys((new ApplicationDescription($this->getApplication()))
            ->getCommands())),
        new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt', fn() => (new DescriptorHelper())->getFormats()),
        new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw command help'),
    ])
        ->setDescription('Display help for a command')
        ->setHelp(<<<'EOF'
The <info>%command.name%</info> command displays help for a given command:

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

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

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

To display the list of available commands, please use the <info>list</info> command.
EOF
);
}