Create a custom command

Adobe Commerce and Magento Open Source enables your component to add commands to our Symfony-like command-line interface (CLI).

Commerce has one command-line interface that performs both installation and configuration tasks: <magento_root>/bin/magento. The new interface performs multiple tasks, including:

Installing Commerce (and related tasks such as creating or updating the database schema, creating the deployment configuration, and so on).
Clearing the cache.
Managing indexes, including reindexing.
Creating translation dictionaries and translation packages.
Generating non-existent classes such as factories and interceptors for plug-ins, generating the dependency injection configuration for the object manager.
Deploying static view files.
Creating CSS from Less.

Other benefits:

A single command (<magento_root>/bin/magento list) lists all available installation and configuration commands.
Consistent user interface based on Symfony.
The CLI is extensible so third party developers can "plug in" to it. This has the additional benefit of eliminating users' learning curve.
Commands for disabled modules do not display.

Prerequisites#

Before you begin, make sure you understand the following:

All Magento command-line interface (CLI) commands rely on the application and must have access to its context, dependency injections, plug-ins, and so on.
All CLI commands should be implemented in the scope of your module and should depend on the module's status.
Your command can use the Object Manager and dependency injection features; for example, it can use constructor dependency injection.

Your command should have an unique name, defined in the configure() method of the Command class:

protected function configure(): void
{
    $this->setName('my:first:command');
    $this->setDescription('This is my first console command.');

    parent::configure();
}
...
Copied to your clipboard
1protected function configure(): void
2{
3    $this->setName('my:first:command');
4    $this->setDescription('This is my first console command.');
5
6    parent::configure();
7}
8...

or in the di.xml file:

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    ...
    <type name="Magento\CommandExample\Console\Command\SomeCommand">
        <arguments>
            <!-- configure the command name via constructor $name argument -->
            <argument name="name" xsi:type="string">my:first:command</argument>
        </arguments>
    </type>
    ...
</config>
Copied to your clipboard
1<?xml version="1.0"?>
2<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
3    ...
4    <type name="Magento\CommandExample\Console\Command\SomeCommand">
5        <arguments>
6            <!-- configure the command name via constructor $name argument -->
7            <argument name="name" xsi:type="string">my:first:command</argument>
8        </arguments>
9    </type>
10    ...
11</config>

or in the __construct method (declaration is similar to di.xml):

public function __construct()
{
    parent::__construct('my:first:command');
}
Copied to your clipboard
1public function __construct()
2{
3    parent::__construct('my:first:command');
4}

Otherwise the Symfony framework will return an The command defined in "<Command class>" cannot have an empty name. error.

Add CLI commands using dependency injection#

The sample modules provide a demonstration of many programming techniques, including adding a CLI command using dependency injection. Look at the sample-module-command for an example. The module's README.md discusses how to install it.

Following is a summary of the process:

Create a Command class (the recommended location is <your component root dir>/Console/Command).

See <Magento_Store_module_dir>/Console/Command/StoreListCommand.php for example.

<?php

declare(strict_types=1);

namespace Magento\CommandExample\Console\Command;

use Magento\Framework\Exception\LocalizedException;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

class SomeCommand extends Command
{
    private const NAME = 'name';

    protected function configure(): void
    {
        $this->setName('my:first:command');
        $this->setDescription('This is my first console command.');
        $this->addOption(
            self::NAME,
            null,
            InputOption::VALUE_REQUIRED,
            'Name'
        );

        parent::configure();
    }

    /**
     * Execute the command
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     *
     * @return int
     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $exitCode = 0;
         
         if ($name = $input->getOption(self::NAME)) {
             $output->writeln('<info>Provided name is `' . $name . '`</info>');
         }

         $output->writeln('<info>Success message.</info>');
         $output->writeln('<comment>Some comment.</comment>');

         try {
             if (rand(0, 1)) {
                throw new LocalizedException(__('An error occurred.'));
             }
         } catch (LocalizedException $e) {
             $output->writeln(sprintf(
                 '<error>%s</error>',
                 $e->getMessage()
             );
             $exitCode = 1;
         }
         
         return $exitCode;
     }
}
Copied to your clipboard
1<?php
2
3declare(strict_types=1);
4
5namespace Magento\CommandExample\Console\Command;
6
7use Magento\Framework\Exception\LocalizedException;
8use Symfony\Component\Console\Command\Command;
9use Symfony\Component\Console\Input\InputInterface;
10use Symfony\Component\Console\Input\InputOption;
11use Symfony\Component\Console\Output\OutputInterface;
12
13class SomeCommand extends Command
14{
15    private const NAME = 'name';
16
17    protected function configure(): void
18    {
19        $this->setName('my:first:command');
20        $this->setDescription('This is my first console command.');
21        $this->addOption(
22            self::NAME,
23            null,
24            InputOption::VALUE_REQUIRED,
25            'Name'
26        );
27
28        parent::configure();
29    }
30
31    /**
32     * Execute the command
33     *
34     * @param InputInterface $input
35     * @param OutputInterface $output
36     *
37     * @return int
38     */
39     protected function execute(InputInterface $input, OutputInterface $output): int
40     {
41         $exitCode = 0;
42         
43         if ($name = $input->getOption(self::NAME)) {
44             $output->writeln('<info>Provided name is `' . $name . '`</info>');
45         }
46
47         $output->writeln('<info>Success message.</info>');
48         $output->writeln('<comment>Some comment.</comment>');
49
50         try {
51             if (rand(0, 1)) {
52                throw new LocalizedException(__('An error occurred.'));
53             }
54         } catch (LocalizedException $e) {
55             $output->writeln(sprintf(
56                 '<error>%s</error>',
57                 $e->getMessage()
58             );
59             $exitCode = 1;
60         }
61         
62         return $exitCode;
63     }
64}

Style the output text by using <error>, <info>, or <comment> tags. See Symfony documentation for more information about styling.

Declare your Command class in Magento\Framework\Console\CommandListInterface and configure the command name using dependency injection (<your component root dir>/etc/di.xml):

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    ...
    <type name="Magento\Framework\Console\CommandListInterface">
        <arguments>
            <argument name="commands" xsi:type="array">
                <item name="commandexample_somecommand" xsi:type="object">Magento\CommandExample\Console\Command\SomeCommand</item>
            </argument>
        </arguments>
    </type>
    ...
</config>
Copied to your clipboard
1<?xml version="1.0"?>
2<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
3    ...
4    <type name="Magento\Framework\Console\CommandListInterface">
5        <arguments>
6            <argument name="commands" xsi:type="array">
7                <item name="commandexample_somecommand" xsi:type="object">Magento\CommandExample\Console\Command\SomeCommand</item>
8            </argument>
9        </arguments>
10    </type>
11    ...
12</config>

Clean the cache:

bin/magento cache:clean
Copied to your clipboard
bin/magento cache:clean

Regenerate the code:

bin/magento setup:di:compile
Copied to your clipboard
bin/magento setup:di:compile

Result#

As a result, the new command my:first:command that accepts a --name parameter is ready to use.

bin/magento my:first:command --name 'John'
Copied to your clipboard
bin/magento my:first:command --name 'John'

Naming guidelines

Staging

Last updated 8/9/2022

Was this helpful?

Yes

Create a custom command

Prerequisites.css-1911m5i{margin-left:var(--spectrum-global-dimension-size-100);}#

Add CLI commands using dependency injection#

Result.css-1mxjwj6{margin-left:var(--spectrum-global-dimension-size-50);}#

Prerequisites#

Result#