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

BefehlBeschreibung
aboutLiefert allgemeine Informationen zur Shopware-Installation
helpZeigt 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.
listListet alle verfügbaren Befehle auf

Cache

BefehlBeschreibung
cache:clearLeert den Cache
cache:warmupWärmt den Cache auf

Dal

BefehlBeschreibung
dal:refresh:indexAktualisiert die Shop-Indizes

Datenbank

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

Debug

BefehlBeschreibung
debug:business-eventsListet alle Business-Events auf mit der Information, in wie vielen Mails bzw. Logs dieses verwendet wird
BefehlBeschreibung
es:index(Re-)Indexiert die Elasticsearch-Entitäten
es:index:cleanupEntfernt alte, nicht genutzte Elasticsearch-Indizes

HTTP

BefehlBeschreibung
http:cache:warm:upWärmt den HTTP-Cache auf

Import-Export

BefehlBeschreibung
import-export:delete-expiredEntfernt alle abgelaufenen Import/Export Dateien

Media

BefehlBeschreibung
media:delete-unusedEntfernt nicht genutzte Mediendateien
media:generate-thumbnailsGeneriert Thumbnails für die Dateien, bei denen die Thumbnails in den Alben-Einstellungen aktiv sind

Messenger

BefehlBeschreibung
messenger:consumeVerarbeitet die Einträge der Messenger-Queue
messenger:stop-workersStoppt die Verarbeitung der Messenger-Queue nach der aktuell ausgeführten Message

Plugin

BefehlBeschreibung
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:listListet alle im System vorhanden Plugins mit einigen Zusatzinformationen auf
plugin:refreshAktualisiert die Plugin-Liste

Produkt-Export / Produkt-Vergleich

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

Verkaufskanäle

BefehlBeschreibung
sales-channel:listListet 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)

BefehlBeschreibung
scheduled-task:runFührt die scheduled Tasks (geplante Aufgaben) aus

Sitemap

BefehlBeschreibung
sitemap:generateGeneriert die Sitemaps

Theme

BefehlBeschreibung
theme:compileKompiliert das aktuelle Theme
theme:createErstellt ein neues, eigenständiges Theme, das als Grundlage für eigene Template-Anpassungen verwendet werden kann

Benutzer

BefehlBeschreibung
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>



 

War dieser Artikel hilfreich?