mirror of
https://github.com/symfony/symfony-docs.git
synced 2026-03-24 00:32:14 +01:00
31 lines
992 B
ReStructuredText
31 lines
992 B
ReStructuredText
How to Hide Console Commands
|
|
============================
|
|
|
|
By default, all console commands are listed when executing the console application
|
|
script without arguments or when using the ``list`` command.
|
|
|
|
However, sometimes commands are not intended to be run by end-users; for
|
|
example, commands for the legacy parts of the application, commands exclusively
|
|
run through scheduled tasks, etc.
|
|
|
|
In those cases, you can define the command as **hidden** by setting to ``true``
|
|
the ``hidden`` property of the ``AsCommand`` attribute::
|
|
|
|
// src/Command/LegacyCommand.php
|
|
namespace App\Command;
|
|
|
|
use Symfony\Component\Console\Attribute\AsCommand;
|
|
|
|
#[AsCommand(name: 'app:legacy', hidden: true)]
|
|
class LegacyCommand
|
|
{
|
|
// ...
|
|
}
|
|
|
|
Hidden commands behave the same as normal commands but they are no longer displayed
|
|
in command listings, so end-users are not aware of their existence.
|
|
|
|
.. note::
|
|
|
|
Hidden commands are still available using the JSON or XML descriptor.
|