Add custom CLI commands

Search…
To ease development tasks, Shopware contains the Symfony commands functionality. This allows (plugin-) developers to define new commands executable via the Symfony console at bin/console. The best thing about commands is, that they're more than just simple standalone PHP scripts - they integrate into Symfony and Shopware, so you've got access to all the functionality offered by both of them.
Creating a command for Shopware 6 via a plugin works exactly like you would add a command to Symfony. Make sure to have a look at the Symfony commands guide:
Console Commands (Symfony Docs)
symfony
Prerequisites
This guide does not explain how to create a new plugin for Shopware 6. Head over to our plugin base guide to learn how to create a plugin at first:
Plugin Base Guide
The main requirement here is to have a services.xml file loaded in your plugin. This can be achieved by placing the file into a Resources/config directory relative to your plugin's base class location.
Here's a video on creating custom commands from our free online training "Backend Development".
​Creating a CLI command​
Registering your command
From here on, everything works exactly like in Symfony itself. Commands are recognised by Shopware, once they're tagged with the console.command tag in the dependency injection container. So to register a new command, just add it to your plugin's services.xml and specify the console.command tag:
1
<services>
2
   <!-- ... -->
3
​
4
   <service id="Swag\BasicExample\Command\ExampleCommand">
5
       <tag name="console.command"/>
6
   </service>
7
</services>
8
<!-- ... -->
Copied!
Here's a full example services.xml which registers your custom command:
<plugin root>/src/Resources/config/services.xml
1
<?xml version="1.0" ?>
2
​
3
<container xmlns="http://symfony.com/schema/dic/services"
4
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5
           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
6
​
7
    <services>
8
        <service id="Swag\BasicExample\Command\ExampleCommand">
9
            <tag name="console.command"/>
10
        </service>
11
    </services>
12
</container>
Copied!
Your command's class should extend from the Symfony\Component\Console\Command\Command class, here's an example:
<plugin root>/src/Command/ExampleCommand.php
1
<?php declare(strict_types=1);
2
​
3
namespace Swag\BasicExample\Command;
4
​
5
use Symfony\Component\Console\Command\Command;
6
use Symfony\Component\Console\Input\InputInterface;
7
use Symfony\Component\Console\Output\OutputInterface;
8
​
9
class ExampleCommand extends Command
10
{
11
    // Command name
12
    protected static $defaultName = 'swag-commands:example';
13
​
14
    // Provides a description, printed out in bin/console
15
    protected function configure(): void
16
    {
17
        $this->setDescription('Does something very special.');
18
    }
19
​
20
    // Actual code executed in the command
21
    protected function execute(InputInterface $input, OutputInterface $output): int
22
    {
23
        $output->writeln('It works!');
24
​
25
        // Exit code 0 for success
26
        return 0;
27
    }
28
}
Copied!
This command is of course only a basic example, so feel free to experiment. As stated above, you now have access to all the functionality offered by Symfony and Shopware.
For inspiration, maybe have a look at the Symfony documentation - you may for example use tables, progress bars, or custom formats.
Running commands
Commands are run via the bin/console executable. To list all available commands, run bin/console list:
1
$: php bin/console list
2
Symfony 4.4.4 (env: dev, debug: true)
3
​
4
Usage:
5
  command [options] [arguments]
6
​
7
Options:
8
  -h, --help            Display this help message
9
  -q, --quiet           Do not output any message
10
  -V, --version         Display this application version
11
      --ansi            Force ANSI output
12
      --no-ansi         Disable ANSI output
13
  -n, --no-interaction  Do not ask any interactive question
14
  -e, --env=ENV         The Environment name. [default: "dev"]
15
      --no-debug        Switches off debug mode.
16
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
17
​
18
Available commands:
19
  about                                   Displays information about the current project
20
  help                                    Displays help for a command
21
  list                                    Lists commands
22
 feature
23
  feature:dump                            [administration:dump:features] Creating json file with feature config for js testing and hot reloading capabilities.
24
 assets
25
  assets:install                          
26
 bundle
27
  bundle:dump                              [administration:dump:plugins|administration:dump:bundles] Creates a json file with the configuration for each active Shopware bundle.
28
 cache
29
  cache:clear                             Clears the cache
30
  cache:pool:clear                        Clears cache pools
31
  cache:pool:delete                       Deletes an item from a cache pool
32
  cache:pool:list                         List available cache pools
33
  cache:pool:prune                        Prunes cache pools
34
  cache:warmup                            Warms up an empty cache
35
 [...]
Copied!
Each command usually has a namespace like cache, so to clear the cache you would execute php bin/console cache:clear. If you'd like to learn more about commands in general, have a look at this article in the Symfony documentation.
More interesting topics
​Adding a scheduled task​
Add plugin dependencies
Add scheduled task
Last modified 2mo ago
Copy link
Edit on GitHub
Contents
Prerequisites
Registering your command
Running commands