How to Hide Console Commands
Edit this pageHow 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:
1 2 3 4 5 6 7 8 9 10 11
// src/Command/LegacyCommand.php
namespace App\Command;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
#[AsCommand(name: 'app:legacy', hidden: true)]
class LegacyCommand extends Command
{
// ...
}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.
This work, including the code samples, is licensed under a
Creative Commons BY-SA 3.0
license.
TOC
Version
Version:
