zenstruck/console-extra
A modular set of features to reduce configuration boilerplate for your Symfony commands:
#[AsCommand('create:user', 'Creates a user in the database.')]
final class CreateUserCommand extends InvokableServiceCommand
{
use ConfigureWithAttributes, RunsCommands, RunsProcesses;
public function __invoke(
IO $io,
UserRepository $repo,
#[Argument]
string $email,
#[Argument]
string $password,
#[Option(name: 'role', shortcut: 'r')]
array $roles,
): void {
$repo->createUser($email, $password, $roles);
$this->runCommand('another:command');
$this->runProcess('/some/script');
$io->success('Created user.');
}
}
bin/console create:user kbond p4ssw0rd -r ROLE_EDITOR -r ROLE_ADMIN
[OK] Created user.
// Duration: < 1 sec, Peak Memory: 10.0 MiB
Installation
composer require zenstruck/console-extra
Usage
This library is a set of modular features that can be used separately or in combination.
Note To reduce command boilerplate even further, it is recommended to create an abstract base command for your app that enables all the features you desire. Then have all your app's commands extend this.
IO
This is a helper object that extends SymfonyStyle
and implements InputInterface
(so it implements
InputInterface
, OutputInterface
, and StyleInterface
).
use Zenstruck\Console\IO;
$io = new IO($input, $output);
$io->getOption('role'); // InputInterface
$io->writeln('a line'); // OutputInterface
$io->success('Created.'); // StyleInterface
// additional methods
$io->input(); // get the "wrapped" input
$io->output(); // get the "wrapped" output
On its own, it isn't very special, but it can be auto-injected into Invokable
commands.
Invokable
Use this trait to remove the need for extending Command::execute()
and just inject what your need
into your command's __invoke()
method. The following are parameters that can be auto-injected:
Zenstruck\Console\IO
Symfony\Component\Console\Style\StyleInterface
Symfony\Component\Console\Input\InputInterface
Symfony\Component\Console\Input\OutputInterface
- arguments (parameter name must match argument name or use the
Zenstruck\Console\Attribute\Argument
attribute) - options (parameter name must match option name or use the
Zenstruck\Console\Attribute\Option
attribute)
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;
use Zenstruck\Console\Invokable;
use Zenstruck\Console\IO;
class MyCommand extends \Symfony\Component\Console\Command\Command
{
use Invokable; // enables this feature
// $username/$roles are the argument/option defined below
public function __invoke(IO $io, string $username, array $roles)
{
$io->success('created.');
// even if you don't inject IO, it's available as a method:
$this->io(); // IO
}
public function configure(): void
{
$this
->addArgument('username', InputArgument::REQUIRED)
->addOption('roles', mode: InputOption::VALUE_IS_ARRAY)
;
}
}
You can auto-inject the "raw" input/output:
public function __invoke(IO $io, InputInterface $input, OutputInterface $output)
No return type (or void
) implies a 0
status code. You can return an integer if you want to change this:
public function __invoke(IO $io): int
{
return $success ? 0 : 1;
}
InvokableServiceCommand
If using the Symfony Framework, you can take Invokable
to the next level by auto-injecting services
into __invoke()
. This allows your commands to behave like
Invokable Service Controllers
(with controller.service_arguments
). Instead of a Request, you inject IO
.
Have your commands extend InvokableServiceCommand
and ensure they are auto-wired/configured.
use App\Repository\UserRepository;
use Psr\Log\LoggerInterface;
use Zenstruck\Console\InvokableServiceCommand;
use Zenstruck\Console\IO;
class CreateUserCommand extends InvokableServiceCommand
{
public function __invoke(IO $io, UserRepository $repo, LoggerInterface $logger): void
{
// access container parameters
$environment = $this->parameter('kernel.environment');
// ...
}
}
ConfigureWithAttributes
Use this trait to use the Argument
and Option
attributes to configure your command's
arguments and options (PHP 8+ required):
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Zenstruck\Console\Attribute\Argument;
use Zenstruck\Console\Attribute\Option;
use Zenstruck\Console\ConfigureWithAttributes;
#[Argument('arg1', description: 'Argument 1 description', mode: InputArgument::REQUIRED)]
#[Argument('arg2', description: 'Argument 1 description')]
#[Option('option1', description: 'Option 1 description')]
class MyCommand extends Command
{
use ConfigureWithAttributes;
}
Note This trait is incompatible with
ConfigureWithDocblocks
.
Invokable Attributes
If using ConfigureWithAttributes
and Invokable
together, you can add the
Option
/Argument
attributes to your __invoke()
parameters to define and inject arguments/options:
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Zenstruck\Console\Attribute\Argument;
use Zenstruck\Console\Attribute\Option;
use Zenstruck\Console\ConfigureWithAttributes;
use Zenstruck\Console\Invokable;
#[AsCommand('my:command')]
class MyCommand extends Command
{
use ConfigureWithAttributes, Invokable;
public function __invoke(
#[Argument]
string $username, // defined as a required argument (username)
#[Argument]
string $password = 'p4ssw0rd', // defined as an optional argument (password) with a default (p4ssw0rd)
#[Option(name: 'role', shortcut: 'r')]
array $roles = [], // defined as an array option that requires values (--r|role[])
#[Option(name: 'super-admin')]
bool $superAdmin = false, // defined as a "value-less" option (--super-admin)
#[Option]
?bool $force = null, // defined as a "negatable" option (--force/--no-force)
#[Option]
?string $name = null, // defined as an option that requires a value (--name=)
): void {
// ...
}
}
Note Option/Argument modes and defaults are detected from the parameter's type-hint/default value and cannot be defined on the attribute.
AutoName
Use this trait to have your command's name auto-generated from the class name:
use Symfony\Component\Console\Command\Command;
use Zenstruck\Console\AutoName;
class CreateUserCommand extends Command
{
use AutoName; // command's name will be "app:create-user"
}
By default, the command name's prefix is app:
. You can customize with your own
prefix (or none at all) by overriding the autoNamePrefix()
method from the
AutoName
trait:
use Symfony\Component\Console\Command\Command;
use Zenstruck\Console\AutoName;
class CreateUserCommand extends Command
{
use AutoName; // command's name will be "create-user"
protected static function autoNamePrefix(): string
{
return '';
}
}
ConfigureWithDocblocks
Note This trait is deprecated when using with PHP 8+ and will be removed in 2.0. Use
ConfigureWithAttributes
instead.
Use this trait to allow your command to be configured by your command class' docblock.
phpdocumentor/reflection-docblock
is required for this feature
(composer install phpdocumentor/reflection-docblock
).
Example:
use Symfony\Component\Console\Command\Command;
use Zenstruck\Console\ConfigureWithDocblocks;
/**
* This is the command's description.
*
* This is the command help
*
* Multiple
*
* lines allowed.
*
* @command my:command
* @alias alias1
* @alias alias2
* @hidden
*
* @argument arg1 First argument is required (this is the argument's "description")
* @argument ?arg2 Second argument is optional
* @argument arg3=default Third argument is optional with a default value
* @argument arg4="default with space" Forth argument is "optional" with a default value (with spaces)
* @argument ?arg5[] Fifth argument is an optional array
*
* @option option1 First option (no value) (this is the option's "description")
* @option option2= Second option (value required)
* @option option3=default Third option with default value
* @option option4="default with space" Forth option with "default" value (with spaces)
* @option o|option5[] Fifth option is an array with a shortcut (-o)
*/
class MyCommand extends Command
{
use ConfigureWithDocblocks;
}
Note
- If the
@command
tag is absent, AutoName is used.- All the configuration can be disabled by using the traditional methods of configuring your command.
- Command's are still lazy using this method of configuration but there is overhead in parsing the docblocks so be aware of this.
- This trait is incompatible with
ConfigureWithAttributes
.
@command
Tag
You can pack all the above into a single @command
tag. This can act like routing for your console:
/**
* @command |app:my:command|alias1|alias2 arg1 ?arg2 arg3=default arg4="default with space" ?arg5[] --option1 --option2= --option3=default --option4="default with space" --o|option5[]
*/
class MyCommand extends Command
{
use ConfigureWithDocblocks;
}
Note
- The
|
prefix makes the command hidden.- Argument/Option descriptions are not allowed.
- It is recommended to only do this for very simple commands as it isn't as explicit as splitting the tags out.
CommandRunner
A CommandRunner
object is available to simplify running commands anywhere (ie controller):
use Zenstruck\Console\CommandRunner;
/** @var \Symfony\Component\Console\Command\Command $command */
CommandRunner::for($command)->run(); // int (the status after running the command)
// pass arguments
CommandRunner::for($command, 'arg --opt')->run(); // int
If the application is available, you can use it to run commands:
use Zenstruck\Console\CommandRunner;
/** @var \Symfony\Component\Console\Application $application */
CommandRunner::from($application, 'my:command')->run();
// pass arguments/options
CommandRunner::from($application, 'my:command arg --opt')->run(); // int
If your command is interactive, you can pass inputs:
use Zenstruck\Console\CommandRunner;
/** @var \Symfony\Component\Console\Application $application */
CommandRunner::from($application, 'my:command')->run([
'foo', // input 1
'', // input 2 (<enter>)
'y', // input 3
]);
By default, output is suppressed, you can optionally capture the output:
use Zenstruck\Console\CommandRunner;
/** @var \Symfony\Component\Console\Application $application */
$output = new \Symfony\Component\Console\Output\BufferedOutput();
CommandRunner::from($application, 'my:command')
->withOutput($output) // any OutputInterface
->run()
;
$output->fetch(); // string (the output)
RunsCommands
You can give your Invokable Commands the ability to run other commands (defined
in the application) by using the RunsCommands
trait. These sub-commands will use the same
output as the parent command.
use Symfony\Component\Console\Command;
use Zenstruck\Console\Invokable;
use Zenstruck\Console\RunsCommands;
class MyCommand extends Command
{
use Invokable, RunsCommands;
public function __invoke(): void
{
$this->runCommand('another:command'); // int (sub-command's run status)
// pass arguments/options
$this->runCommand('another:command arg --opt');
// pass inputs for interactive commands
$this->runCommand('another:command', [
'foo', // input 1
'', // input 2 (<enter>)
'y', // input 3
])
}
}
RunsProcesses
You can give your Invokable Commands the ability to run other processes (symfony/process
required)
by using the RunsProcesses
trait. Standard output from the process is hidden by default but can be shown by
passing -v
to the parent command. Error output is always shown. If the process fails, a \RuntimeException
is thrown.
use Symfony\Component\Console\Command;
use Symfony\Component\Process\Process;
use Zenstruck\Console\Invokable;
use Zenstruck\Console\RunsProcesses;
class MyCommand extends Command
{
use Invokable, RunsProcesses;
public function __invoke(): void
{
$this->runProcess('/some/script');
// construct with array
$this->runProcess(['/some/script', 'arg1', 'arg1']);
// for full control, pass a Process itself
$this->runProcess(
Process::fromShellCommandline('/some/script')
->setTimeout(900)
->setWorkingDirectory('/')
);
}
}
CommandSummarySubscriber
Add this event subscriber to your Application
's event dispatcher to display a summary after every command is run.
The summary includes the duration of the command and peak memory usage.
If using Symfony, configure it as a service to enable:
# config/packages/zenstruck_console_extra.yaml
services:
Zenstruck\Console\EventListener\CommandSummarySubscriber:
autoconfigure: true
Note This will display a summary after every registered command runs.