Shopware CLI: Allgemeine Empfehlungen und wichtige Befehle

In diesem Shopware CLI-Leitfaden geben wir allgemeine Empfehlungen zur Verwendung der Befehlszeilenschnittstelle mit der Plattform. Sie finden eine Liste der wichtigsten CLI-Befehle erklärt und in Gruppen unterteilt. Weitere Shopware 6-Tutorials und -Anleitungen finden Sie in unserem Kochbuch.

Allgemeine Empfehlungen

Sie können Ihre Interaktion mit Shopware über die Konsole drastisch vereinfachen. Shopware bietet die Möglichkeit, einige Funktionen mit Hilfe von “CLI”-Befehlen auszuführen, die außerhalb der Skriptbeschränkungen ausgeführt werden können. Außerdem gibt es Situationen, in denen Sie diese Befehle verwenden sollten, z. B. wenn Sie große Datenmengen verarbeiten müssen.

Shopware CLI-Befehle führen Sie direkt in der Konsole des Servers aus. Da Sie dafür eine SSH-Verbindung benötigen, müssen Sie sich um zusätzliche Voraussetzungen kümmern. So benötigt Windows beispielsweise Apps wie “PuTTY”, um eine SSH-Verbindung aufzubauen, während macOS und Linux die gleiche Möglichkeit direkt im Terminal bieten.

Wenn die SSH-Verbindung hergestellt ist, wechseln Sie in das Shopware-Installationsverzeichnis. Auf der Plattform können Sie Befehle mit Hilfe der folgenden allgemeinen Form ausführen:

Um eine Liste aller Shopware CLI-Befehle zu erhalten, geben Sie den folgenden Befehl ein:

Es ist auch möglich, die Hilfeseite für Shopware CLI-Befehle aufzurufen. Verwenden Sie diesen Befehl:

Außerdem finden Sie für die meisten Shopware CLI-Befehle eine eigene Hilfeseite. Verwenden Sie diesen Befehl, um sie aufzurufen:

Vergessen Sie nicht, <Befehl> durch einen bestimmten Shopware CLI-Befehl zu ersetzen, für den Sie zusätzliche Informationen benötigen.

Wichtige Shopware CLI-Befehle

Im Folgenden finden Sie Shopware CLI-Befehle, die in die folgenden Gruppen unterteilt sind:

• Allgemein;
• Cache;
• Dal;
• Datenbank;
• Fehlersuche;
• Elasticsearch;
• HTTP;
• Medien;
• Messenger;
• Plugin;
• Produktvergleich;
• Vertriebskanal;
• Sitemap;
• Thema;
• Benutzer.

Allgemein

• about – allgemeine Informationen über die Shopware-Installation;
• help – allgemeine CLI-Hilfe;
• list – alle verfügbaren Shopware-CLI-Befehle;

Cache

• cache:clear – mit diesem Shopware CLI-Befehl können Sie den Cache löschen;
• cache:warmup – verwenden Sie diesen Befehl, um den Cache aufzuwärmen;

Dal

• dal:refresh:index – dieser Shopware CLI-Befehl aktualisiert die Shop-Indizes;

Datenbank

• database:clean-personal-data “guests/carts” – verwenden Sie diesen Befehl, um entweder alte Gästekonten (guests) oder abgebrochene Einkaufswagen (carts) zu entfernen;

Fehlersuche

• debug:business-events – dieser Shopware CLI-Befehl zeigt alle Geschäftsereignisse mit den Informationen über die Anzahl der Mails oder Protokolle an, in denen sie verwendet werden;

Elasticsearch

• es:index – reindexieren Sie die Elasticsearch-Entitäten mit Hilfe dieses Shopware CLI-Befehls;
• es:index:cleanup – verwenden Sie diesen Befehl, um alte, nicht verwendete Elasticsearch-Indizes zu entfernen

HTTP

• http:cache:warm:up – mit diesem Befehl wird der HTTP-Cache aufgewärmt;

Medien

• media:delete-unused – mit Hilfe dieses Befehls können Sie unbenutzte Mediendateien entfernen;
• media:generate-thumbnails – verwenden Sie diesen Befehl, um Miniaturbilder zu erzeugen, wenn sie in den Albumeinstellungen aktiviert sind;

Messenger

• messenger:consume – mit diesem Befehl können Sie die Einträge der Messenger-Warteschlange verarbeiten;
• messenger:stop-workers – verwenden Sie diesen Befehl, um die Verarbeitung nach der aktuell ausgeführten Nachricht zu beenden;

Plugin

• plugin:activate “pluginname” – verwenden Sie diesen Befehl, um ein installiertes Plugin zu aktivieren;
• plugin:deactivate “pluginname” – verwenden Sie diesen Befehl, um ein installiertes Plugin zu deaktivieren;
• plugin:list – Sie können Plugin-Namen und einige zusätzliche Informationen einsehen;
• plugin:refresh – dieser Shopware CLI-Befehl aktualisiert die Plugin-Liste;

Produktvergleich

• product-export:generate “sales channel ID” – mit diesem Befehl können Sie einen Produktvergleich für den entsprechenden Verkaufskanal erstellen;

Verkaufskanäle

• sales-channel:list – mit diesem Befehl können Sie eine Liste der Vertriebskanäle mit IDs abrufen;
• sales-channel:maintenance:disable “sales channel ID” – mit diesem Befehl können Sie den Wartungsmodus für den Vertriebskanal deaktivieren;
• sales-channel:maintenance:enable “sales channel ID” – verwenden Sie diesen Befehl, um den Wartungsmodus für den Vertriebskanal zu aktivieren;

Geplante Aufgaben

• scheduled-task:run – mit Hilfe dieses Shopware CLI-Befehls können Sie die geplanten Aufgaben ausführen;

Sitemap

• sitemap:generate – verwenden Sie diesen Befehl, um eine Sitemap zu erstellen;

Thema

• theme:compile – verwenden Sie diesen Befehl, um das aktuelle Theme zu kompilieren;
• theme:create – mit diesem CLI-Befehl können Sie ein neues, eigenständiges Theme erstellen. Verwenden Sie es für Ihre Template-Anpassungen;

Benutzer

• user:change-password “username” – ändern Sie das Passwort des Admin-Benutzers <username> mit diesem Shopware CLI-Befehl;
• user:create “username” – erstellt einen neuen Admin-Benutzer mit dem als <username> angegebenen Namen.