Shopware CLI

Allgemein

Shopware bietet die Möglichkeit, einige Funktionen über die Konsole ausführen zu können. Die sogenannten "CLI" Befehle können außerhalb von Skript-Limitierungen (Beispiel: Skriptlaufzeit des Servers) ausgeführt werden und sind daher bei der Verarbeitung großer Datenmengen empfehlenswert. Diese Befehle werden direkt in der Konsole des Servers ausgeführt, hierzu kann z.B. eine SSH-Verbindung genutzt werden. Unter Windows kann hierzu z.B. das kostenfrei bereitgestellte Programm "PuTTY" verwendet werden, MacOS und Linux-User können eine SSH-Verbindung direkt im Terminal aufbauen.

Nachdem Du die SSH-Verbindung aufgebaut hast, wechsele in das Installationsverzeichnis von Shopware.
Dort kannst Du die Befehle wie folgt ausführen

php bin/console <befehl>

In diesem Artikel werden wir die wichtigsten Befehle näher erläutern.
Eine Auflistung aller Befehle erhältst Du durch die Eingabe

php bin/console list

Die allgemeine Hilfeseite zu den CLI-Befehlen kannst Du über

php bin/console --help

aufrufen. Außerdem gibt es zu den meisten Befehlen eine eigene Hilfeseite. Diese rufst Du über

php bin/console <befehl> --help

auf.

Übersicht der wichtigsten Befehle

Allgemein

Befehl	Beschreibung
about	Liefert allgemeine Informationen zur Shopware-Installation
help	Zeigt Hilfe-Informationen auf, kann auch in Verbindung mit einem anderen Befehl genutzt werden. Hierzu ist vor dem help ein "--" hinzuzufügen. Siehe auch im ersten Abschnitt Allgemein.
list	Listet alle verfügbaren Befehle auf

Administration

Befehl	Beschreibung
administration:delete-files-after-build	Löscht alle nicht benötigten Dateien des Admin nach dem Build-Prozess

 

App

Befehl	Beschreibung
app:activate	Aktiviert eine App
app:create	Erstellt ein App Skeleton
app:deactivate	Deaktiviert eine App
app:install	Installiert eine App
app:refresh	[app-update] Aktualisiert eine App
app:uninstall	Deinstalliert eine App
app:url-change:resolve	Löst App URL Änderungen auf
app:validate	Validiert eine App

 

Cache

Befehl	Beschreibung
cache:clear	Leert den Cache
cache:warmup	Wärmt den Cache auf

Dal

Befehl	Beschreibung
dal:refresh:index	Aktualisiert die Shop-Indizes

Datenbank

Befehl	Beschreibung
database:clean-personal-data "guests/carts"	Entfernt alte Gastaccounts (guests) bzw. alte, abgebrochene Warenkörbe (carts)

Debug

Befehl	Beschreibung
debug:business-events	Listet alle Business-Events auf mit der Information, in wie vielen Mails bzw. Logs dieses verwendet wird

ES (Elastic Search) 

Befehl	Beschreibung
es:index	(Re-)Indexiert die Elasticsearch-Entitäten
es:index:cleanup	Entfernt alte, nicht genutzte Elasticsearch-Indizes

HTTP

Befehl	Beschreibung
http:cache:warm:up	Wärmt den HTTP-Cache auf

Import-Export

Befehl	Beschreibung
import-export:delete-expired	Entfernt alle abgelaufenen Import/Export Dateien
import:entity "Dateiname" "Ablaufdatum" "Profil"	Importiert die Entitäten

Media

Befehl	Beschreibung
media:delete-unused	Entfernt nicht genutzte Mediendateien
media:generate-thumbnails	Generiert Thumbnails für die Dateien, bei denen die Thumbnails in den Alben-Einstellungen aktiv sind

Messenger

Befehl	Beschreibung
messenger:consume	Verarbeitet die Einträge der Messenger-Queue
messenger:stop-workers	Stoppt die Verarbeitung der Messenger-Queue nach der aktuell ausgeführten Message

Plugin

Befehl	Beschreibung
plugin:activate "pluginname"	Aktiviert ein installiertes Plugin - Der Pluginname ist über den Befehl plugin:list ersichtlich
plugin:deactivate "pluginname"	Deaktiviert ein Plugin - Der Pluginname ist über den Befehl plugin:list ersichtlich
plugin:list	Listet alle im System vorhanden Plugins mit einigen Zusatzinformationen auf
plugin:refresh	Aktualisiert die Plugin-Liste

Produkt-Export / Produkt-Vergleich

Befehl	Beschreibung
product-export:generate "ID des Verkaufskanals"	Generiert die Produkt-Vergleiche - Hierzu wird die Angabe der ID des entsprechenden Verkaufskanals benötigt.

Verkaufskanäle

Befehl	Beschreibung
sales-channel:list	Listet die vorhandenen Verkaufskanäle mit weiteren Informationen (z.B. ID) auf
sales-channel:maintenance:disable "ID des Verkaufskanals"	Deaktiviert den Wartungsmodus des Verkaufskanals
sales-channel:maintenance:enable "ID des Verkaufskanals"	Aktiviert den Wartungsmodus des Verkaufskanals

Scheduled Tasks (geplante Aufgaben)

Befehl	Beschreibung
scheduled-task:run	Führt die scheduled Tasks (geplante Aufgaben) aus

Sitemap

Befehl	Beschreibung
sitemap:generate	Generiert die Sitemaps

Theme

Befehl	Beschreibung
theme:compile	Kompiliert das aktuelle Theme
theme:create	Erstellt ein neues, eigenständiges Theme, das als Grundlage für eigene Template-Anpassungen verwendet werden kann

Benutzer

Befehl	Beschreibung
user:change-password "benutzername"	Ermöglicht die Änderungen des Passworts des Admin-Benutzers <benutzername>
user:create "benutzername"	Erstellt einen neuen Admin-Benutzer mit dem Namen <benutzername>