Shopware CLI: General Recommendations & Important Commands

In this Shopware CLI guide, we provide general recommendations on how to use the command-line interface with the platform. You will find a list of the most important CLI commands explained and divided into groups. Other Shopware 6 tutorials and guides are available in our cookbook.

‘

General Recommendations

You can dramatically simplify your interaction with Shopware via console. Shopware provides the ability to execute some functions with the help of  “CLI” commands that can be executed outside of script limitations. Furthermore, there are situations when you should use them, such as the necessity to process large amounts of data. 

You execute Shopware CLI commands directly in the server’s console. Since you need an SSH connection for that, it is necessary to take care of additional prerequisites. For instance, Windows requires apps like “PuTTY” to establish an SSH connection while macOS and Linux provide the same opportunity directly in the terminal.

Now, when the SSH connection is established, proceed to the Shopware installation directory. The platform lets you execute commands with the help of the following general form:

To obtain the list of all Shopware CLI commands, enter the following one:

Also, it is possible to access the help page for Shopware CLI commands. Use this command:

In addition, you will find a separate help page for most Shopware CLI commands. Use this command to call it up:

Don’t forget to replace <command> with a particular Shopware CLI command for which you need additional information.

Important Shopware CLI Commands

Below, you will find Shopware CLI commands divided into the following groups:

• General;
• Cache;
• Dal;
• Database;
• Debug;
• Elasticsearch;
• HTTP;
• Media;
• Messenger;
• Plugin;
• Product Comparison;
• Sales Channel;
• Sitemap;
• Theme;
• User.

General

• about – general information on the Shopware installation;
• help – general CLI help;
• list – all available Shopware CLI commands;

Cache

• cache:clear – you can clear cache with this Shopware CLI command;
• cache:warmup – use this one to warm up the cache;

Dal

• dal:refresh:index – this Shopware CLI command updates shop indexes;

Database

• database:clean-personal-data “guests/carts” – use this command to remove either old guest accounts (guests) or canceled shopping carts (carts);

Debug

• debug:business-events – this Shopware CLI command displays all business events with the information on the number of mails or logs they are used in;

Elasticsearch 

• es:index – reindex the Elasticsearch entities with the help of this Shopware CLI command;
• es:index:cleanup – use this command to remove old, unused Elasticsearch indexes

HTTP

• http:cache:warm:up – warm up the HTTP cache with this command;

Media

• media:delete-unused – with its help, you can remove unused media files;
• media:generate-thumbnails – use this command to generate thumbnails if they are enabled in the album settings;

Messenger

• messenger:consume – this command lets you process the entries of the messenger queue;
• messenger:stop-workers – use this command to stop the processing after the currently executed message;

Plugin

• plugin:activate “pluginname” – use this command to enable an installed plugin; 
• plugin:deactivate “pluginname” – use this command to disable an installed plugin; 
• plugin:list – you can view plugin names and some additional information;
• plugin:refresh – this Shopware CLI command updates the plugin list;

Product Comparison

• product-export:generate “sales channel ID” – with this command, you can generate a product comparison for the corresponding sales channel;

Sales Channels

• sales-channel:list – with this command, you can get a list of sales channels with IDs;
• sales-channel:maintenance:disable “sales channel ID” – use this command to disable the maintenance mode for the sales channel;
• sales-channel:maintenance:enable “sales channel ID” – use this command to enable the maintenance mode for the sales channel;

Scheduled Tasks

• scheduled-task:run – you can execute the scheduled tasks with the help of this Shopware CLI command;

Sitemap

• sitemap:generate – use this command to generate a sitemap;

Theme

• theme:compile – use this command to compile the current theme;
• theme:create – you can create a new, stand-alone theme with this CLI command. Use it for your template customisations;

User

• user:change-password “username” – change the password of the admin user <username> with this Shopware CLI command;
• user:create “username” – create a new admin user with the name specified as <username>.

Shopware 6 Essentials FAQ

Get Improved Import & Export for Shopware by Firebear Studio

Explore Shopware

‘