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.
Befehl | Beschreibung |
---|---|
about | Liefert allgemeine Informationen zur Shopware-Installation |
completion | Gibt das Shell-Vervollständigungsskripta aus |
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 |
Befehl | Beschreibung |
---|---|
administration:delete-files-after-build | Löscht alle nicht benötigten Dateien des Admin nach dem Build-Prozess |
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 |
Befehl | Beschreibung |
---|---|
assets:install | Installiert gebündelte Web-Assets unter einem öffentlichen Webverzeichnis |
Befehl | Beschreibung |
---|---|
bundle:dump | [administration:dump:plugins|administration:dump:bundles] Gibt die Bundle-Konfiguration für ein Plugin aus |
Befehl | Beschreibung |
---|---|
cache:clear | Leert den Cache |
cache:pool:clear | Leer die Cache Pools |
cache:pool:delete | Löscht ein Item vom Cache Pool |
cache:pool:invalidate-tags | Cache-Tags für alle oder einen bestimmten Pool ungültig machen |
cache:pool:list | Zeigt alle verfügbaren Cache Pools an |
cache:pool:prune | Reinigt die Cache Pools |
cache:warmup | Wärmt den Cache auf |
Befehl | Beschreibung |
---|---|
cart:migrate | Migriert Warenkörbe von Redis zur Datenbank |
Befehl | Beschreibung |
---|---|
changelog:change | Ändert den Changelog einer Version |
changelog:check | Prüft den Changelog auf Fehler |
changelog:create | Erzeugt eine Changelog-Datei |
changelog:release | Erzeugt ein neues Changelog-Release |
Zum Einsatz der nachfolgenden CLI Kommandos muss das Commercial Plugin installiert und aktiv sein.
Befehl | Beschreibung |
---|---|
commercial:feature:disable | Deaktiviert ein in Deinem Plan enthaltenes Feature |
commercial:feature:enable | Aktiviert ein in Deinem Plan enthaltenes Feature |
commercial:feature:list | Liste aller Features und deren Status abhängig von Deinem Plan |
commercial:license:set | Lizenzschlüssel und Host setzen |
commercial:license:update | Update des Lizenzschlüssels |
commercial:report-turnover | Umsatz für einen angegebenen Zeitraum melden |
Befehl | Beschreibung |
---|---|
config:dump-reference | Gibt die Standardkonfiguration für eine Erweiterung aus |
Befehl | Beschreibung |
---|---|
customer:delete-unused-guests | Löscht unbenutzte Gastaccounts |
Befehl | Beschreibung |
---|---|
dal:create:entities | Erzeugt die Entity-Klassen |
dal:create:hydrators | Erzeugt die Hydrator-Klassen |
dal:create:schema | Erzeugt das Datenbankschema |
dal:refresh:index | Aktualisiert die Shop-Indizes |
dal:validate | Validiert die DAL-Definitionen |
Befehl | Beschreibung |
---|---|
database:clean-personal-data | Entfernt persönliche Daten aus der Datenbank |
database:create-migration | Erstellt eine neue Migrationsdatei |
database:migrate | Führt alle Migrationen aus |
database:migrate-destructive | Führt alle Migrationen aus |
database:refresh-migration | Aktualisiert den Status der Migration |
Befehl | Beschreibung |
---|---|
debug:autowiring | Klassen/Schnittstellen auflisten, die Du für die automatische Verdrahtung verwenden kannst |
debug:business-events | Listet alle Business-Events auf mit der Information, in wie vielen Mails bzw. Logs dieses verwendet wird |
debug:config | Gibt die aktuelle Konfiguration für eine Erweiterung aus |
debug:container | Aktuelle Dienste für eine Anwendung anzeigen |
debug:dotenv | Listet alle dotenv-Dateien mit Variablen und Werten auf |
debug:event-dispatcher | Konfigurierte Listener für eine Anwendung anzeigen |
debug:messenger | Liste der Nachrichten, die Sie mit den message buses versenden können |
debug:router | Aktuelle Routen für eine Anwendung anzeigen |
debug:translation | Informationen zu Übersetzungsmeldungen anzeigen |
debug:twig | Eine Liste der twig-Funktionen, Filter, Globals und Tests anzeigen |
debug:validator | Validierungseinschränkungen für Klassen anzeigen |
Befehl | Beschreibung |
---|---|
docs:app-system-events | Gibt die App-Ereignisse aus |
docs:generate-scripts-reference | Erzeugt die Skriptreferenz |
Befehl | Beschreibung |
---|---|
dotenv:dump | Kompiliert .env-Dateien zu .env.local.php |
Befehl | Beschreibung |
---|---|
es:admin:index | Indiziert die Elasticsearch für die Admin-Suche |
es:admin:reset | Zurücksetzen der Elasticsearch-Indizierung des Admins |
es:admin:test | Ermöglicht den Test des Admin-Suchindex |
es:create:alias | Erstellt den elasticsearch-Alias |
es:index | (Re-)Indexiert die Elasticsearch-Entitäten |
es:index:cleanup | Entfernt alte, nicht genutzte Elasticsearch-Indizes |
es:reset | Setzt den elasticsearch-Index zurück |
es:status | Zeigt den Status des elasticsearch-Index an |
es:test:analyzer | Testet den elasticsearch analyzer |
Befehl | Beschreibung |
---|---|
feature:dump | [administration:dump:features|administration:dump:features] Gibt alle Features aus |
Befehl | Beschreibung |
---|---|
framework:demodata | Generiert Demodaten |
framework:dump:class:schema | Gibt das Schema der angegebenen Entität aus |
framework:schema | Gibt das Schema der angegebenen Entität aus |
Befehl | Beschreibung |
---|---|
http:cache:warm:up | Wärmt den HTTP-Cache auf |
Befehl | Beschreibung |
---|---|
import:entity | Importiert die Entitäten |
Befehl | Beschreibung |
---|---|
import-export:delete-expired | Entfernt alle abgelaufenen Import/Export Dateien |
Befehl | Beschreibung |
---|---|
lint:container | Stellt sicher, dass in Dienste eingespeiste Argumente den Typdeklarationen entsprechen |
lint:twig | Lint eines Twig-Template und Ausgabe aufgetretene Fehler |
lint:xliff | Lint einer XLIFF-Datei und Ausgabe aufgetretener Fehler |
lint:yaml | Lint einer YAML-Datei und Ausgabe aufgetretener Fehler |
Befehl | Beschreibung |
---|---|
mailer:test | Testet den E-Mail-Transport, indem eine Mail versandt wird. |
Befehl | Beschreibung |
---|---|
media:delete-unused | Entfernt nicht genutzte Mediendateien |
media:generate-media-types | Generiert Medientypen für alle Mediendateien |
media:generate-thumbnails | Generiert Thumbnails für die Dateien, bei denen die Thumbnails in den Alben-Einstellungen aktiv sind |
Befehl | Beschreibung |
---|---|
messenger:consume | Verarbeitet die Einträge der Messenger-Queue |
messenger:failed:remove | Entfernt bestimmte Messages aus dem Fehltransport |
messenger:failed:retry | Wiederholung einer oder mehrerer Messages aus dem Fehltransport |
messenger:failed:show | Zeigt eine oder mehrere Messages von dem Fehltransport an |
messenger:setup-transports | Vorbereitung der erforderlichen Infrastruktur für den Transport |
messenger:status | Anzeige der Messages für einen oder mehrere Transporte |
messenger:stop-workers | Stoppt die Verarbeitung der Messenger-Queue nach der aktuell ausgeführten Message |
Befehl | Beschreibung |
---|---|
migration:migrate basicSettings | Migration von Grundeinstellungen und Kategorien |
migration:migrate cms | Migration von CMS Layouts |
migration:migrate customersOrders | Migration von sämtlichen Kunden, Bestellungen und Bestelldokumenten |
migration:migrate media | Migration sämtlicher Medien und Medien-Ordner |
migration:migrate newsletterRecipient | Migration von Newsletter-Empfängern |
migration:migrate products | Migration aller Produktdaten und zugehöriger Entitäten (inkl. media-Entitäten) |
migration:migrate productReviews | Migration von Produktbewertungen |
migration:migrate promotions | Migration von Rabatten und Aktionen |
migration:migrate seoUrls | Migration von SEO URLs |
migration:migrate customerWishlists | Migration von Merklisten |
In der Version 13.0.0 vom Migrationsassistent wurden die CLI-Befehle angepasst. Für Näheres hierzu und über die Migration bei großen Datenmengen über die Konsole erfährst Du hier.
Befehl | Beschreibung |
---|---|
number-range:migrate | Migration des Inkrementenspeichers eines Zahlenbereichs |
Befehl | Beschreibung |
---|---|
plugin:activate | Aktiviert ein Plugin |
plugin:create | Erstellt ein neues Plugin |
plugin:deactivate | Deaktiviert ein Plugin |
plugin:install | Installiert ein Plugin |
plugin:list | Listet alle im System vorhanden Plugins auf |
plugin:refresh | Aktualisiert die Plugin-Liste |
plugin:uninstall | Deinstalliert ein Plugin |
plugin:update | Aktualisiert ein Plugin |
plugin:zip-import | Importiert ein Plugin aus einer Zip-Datei |
Befehl | Beschreibung |
---|---|
product-export:generate | Erzeugt eine Produktexportdatei |
Befehl | Beschreibung |
---|---|
router:match | Hilfe beim Debuggen von Routen durch Simulation einer Pfadübereinstimmung |
Befehl | Beschreibung |
---|---|
s3:set-visibility | Setzt die Sichtbarkeit aller Dateien im S3-Dateisystem auf öffentlich |
Befehl | Beschreibung |
---|---|
sales-channel:create | Erstellt einen neuen Verkaufskanal |
sales-channel:create:storefront | Erstellt einen neuen Storefront Verkaufskanal |
sales-channel:list | Listet die vorhandenen Verkaufskanäle mit weiteren Informationen (z.B. ID) auf |
sales-channel:maintenance:disable | Deaktiviert den Wartungsmodus des Verkaufskanals |
sales-channel:maintenance:enable | Aktiviert den Wartungsmodus des Verkaufskanals |
sales-channel:update:domain | Aktiviert eine Verkaufskanal-Domain |
Befehl | Beschreibung |
---|---|
scheduled-task:register | Registriert alle geplanten Aufgaben |
scheduled-task:run | Führt die scheduled Tasks (geplante Aufgaben) aus |
Befehl | Beschreibung |
---|---|
secrets:decrypt-to-local | Entschlüsselt alle Secrets und speichert sie im lokalen Tresor |
secrets:encrypt-from-local | Verschlüsselt alle Secrets vom lokalen Tresor |
secrets:generate-keys | Generiert neue Verschlüsselungsschlüssel |
secrets:list | Listet alle Secrets auf |
secrets:remove | Löscht einen Secret vom Tresor |
secrets:set | Setzt einen Secret im Tresor |
Befehl | Beschreibung |
---|---|
sitemap:generate | Generiert die Sitemaps |
Befehl | Beschreibung |
---|---|
snippets:validate | Validiert Textbausteine |
Befehl | Beschreibung |
---|---|
state-machine:dump | Speichert den Status einer Maschine in eine graphviz Datei |
Befehl | Beschreibung |
---|---|
store:download | Lädt ein Plugin vom Store herunter |
store:login | Loggt Dich in den Store ein |
Befehl | Beschreibung |
---|---|
sync:composer:version | Synchronisiert die Composer-Version mit der Shopware-Version |
Befehl | Beschreibung |
---|---|
system:config:get | Einen Konfigurationswert abrufen |
system:config:set | Einen Konfigurationswert festlegen |
system:configure-shop | Konfiguriert einen Shop |
system:generate-app-secret | Generiert einen neuen App-Secret |
system:generate-jwt-secret | Generiert einen neuen JWT-Secret |
system:install | Installiert das Shopware 6 System |
system:setup | Richtet das System ein |
system:update:finish | Schließt den Update-Prozess ab |
system:update:prepare | Bereitet den Update-Prozess vor |
Befehl | Beschreibung |
---|---|
theme:change | Wechselt das aktive Theme eines Verkaufskanals |
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 |
theme:dump | Dump der Theme-Konfiguration |
theme:prepare-icons | Vorbereitung der Theme-Icons |
theme:refresh | Aktualisiert die Theme-Konfiguration |
Befehl | Beschreibung |
---|---|
translation:extract | Extrahiert fehlende Übersetzungsschlüssel aus dem Code in Übersetzungsdateien. |
translation:pull | Übersetzungen von einem bestimmten Provider abrufen. |
translation:push | Überträgt Übersetzungen an einen bestimmten Provider. |
Befehl | Beschreibung |
---|---|
user:change-password | Ändert das Passwort eines Admin-Benutzer |
user:create | Erstellt einen neuen Admin-Benutzer |