Skip to content

Commands Reference

Commands Reference

These commands can be executed using the Shopware command line interface (CLI), located within your Shopware project.

bash
$ bin/console [command] [parameters]

Commands

General

CommandDescription
aboutDisplays information about the current project
helpDisplays help for a command
listLists commands

Administration

CommandDescription
administration:delete-files-after-buildDeletes all unnecessary files of the administration after the build process

App

CommandDescription
app:activateActivates the app in the folder with the given name
app:createCreates an app skeleton
app:deactivateDeactivates the app in the folder with the given name
app:installInstalls the app in the folder with the given name
app:refresh[app:update] Refreshes the installed apps
app:uninstallUninstalls the app
app:url-change:resolveResolves changes in the app URL and how the app system should handle it.
app:validateChecks manifests for errors

Assets

CommandDescription
assets:install

Bundle

CommandDescription
bundle:dump[administration:dump:plugins|administration:dump:bundles] Creates a JSON file with the configuration for each active Shopware bundle.

Cache

CommandDescription
cache:clearClears the cache
cache:pool:clearClears cache pools
cache:pool:deleteDeletes an item from a cache pool
cache:pool:listLists available cache pools
cache:pool:prunePrunes cache pools
cache:warmupWarms up an empty cache

Cart

CommandDescription
cart:migrateMigrates carts from redis to database

Changelog

CommandDescription
changelog:changeReturns all changes made in a specific / unreleased version.
changelog:checkChecks the validation of a given changelog file or of all files in the "changelog/_unreleased" folder
changelog:createCreates a changelog markdown file in /changelog/_unreleased
changelog:releaseCreates or updates the final changelog for a new release

Config

CommandDescription
config:dump-referenceDumps the default configuration for an extension

Customer

CommandDescription
customer:delete-unused-guestsDeletes unused guest customers

Dal

CommandDescription
dal:create:entitiesCreates the entity classes
dal:create:hydratorsCreates the hydrator classes
dal:create:schemaCreates the database schema
dal:refresh:indexRefreshes the index for a given entity
dal:validateValidates the DAL definitions

Database

CommandDescription
database:clean-personal-dataCleans personal data from the database
database:create-migrationCreates a new migration file
database:migrateExecutes all migrations
database:migrate-destructiveExecutes all migrations
database:refresh-migrationRefreshes the migration state

Debug

CommandDescription
debug:autowiringLists classes/interfaces you can use for autowiring
debug:business-eventsDumps all business events
debug:configDumps the current configuration for an extension
debug:containerDisplays current services for an application
debug:event-dispatcherDisplays configured listeners for an application
debug:messengerLists messages you can dispatch using the message buses
debug:routerDisplays current routes for an application
debug:translationDisplays translation messages information
debug:twigShows a list of twig functions, filters, globals and tests

Es

CommandDescription
es:admin:indexIndexes the elasticsearch for the admin search
es:admin:resetReset Admin Elasticsearch indexing
es:admin:testAllows you to test the admin search index
es:create:aliasCreates the elasticsearch alias
es:indexReindexes all entities to elasticsearch
es:index:cleanupCleans outdated indices
es:resetResets the elasticsearch index
es:statusShows the status of the elasticsearch index
es:test:analyzerAllows to test an elasticsearch analyzer

Feature

CommandDescription
feature:dump[administration:dump:features] Creates a JSON file with feature config for JS testing and hot reloading capabilities

Framework

CommandDescription
framework:demodataGenerates demo data
framework:dump:class:schemaDumps the schema of the given entity
framework:schemaDumps the api definition to a json file.

Http

CommandDescription
http:cache:warm:upWarms up the HTTP cache

Import

CommandDescription
import:entityImports entities from a CSV file

Import-export

CommandDescription
import-export:delete-expiredDeletes all expired import/export files

Lint

CommandDescription
lint:containerEnsures that arguments injected into services match type declarations
lint:twigLints a Twig template and outputs encountered errors
lint:xliffLints a XLIFF file and outputs encountered errors
lint:yamlLints a YAML file and outputs encountered errors

Mailer

CommandDescription
mailer:testTests Mailer transports by sending an email

Media

CommandDescription
media:delete-unusedDeletes all media files that are never used. Use the --dry-run flag to see a paginated list of files that will be deleted, without actually deleting them. Use the --grace-period-days=10 to set a grace period for unused media, meaning only media uploaded before the current date and time minus 10 days will be considered for deletion. The default is 20 and therefore any media uploaded in the previous 20 days will not be considered for deletion even if it is unused. Use the --folder-entity flag to target only a specific folder (e.g. --folder-entity=PRODUCT to purge all product images)
media:generate-media-typesGenerates the media types for all media entities
media:generate-thumbnailsGenerates the thumbnails for all media entities

Messenger

CommandDescription
messenger:consumeConsumes messages
messenger:failed:removeRemoves given messages from the failure transport
messenger:failed:retryRetries one or more messages from the failure transport
messenger:failed:showShows one or more messages from the failure transport
messenger:setup-transportsPrepares the required infrastructure for the transport
messenger:statsShows the message count for one or more transports
messenger:stop-workersStops workers after their current message

Number-range

CommandDescription
number-range:migrateMigrates the increment storage of a number range

Plugin

CommandDescription
plugin:activateActivates given plugins
plugin:createCreates a plugin skeleton
plugin:deactivateDeactivates given plugins
plugin:installInstalls given plugins
plugin:listLists all plugins
plugin:refreshRefreshes the plugins list in the storage from the file system
plugin:uninstallUninstalls given plugins
plugin:updateUpdates given plugins
plugin:zip-importImports a plugin from a zip file

Product-export

CommandDescription
product-export:generateGenerates a product export file

Router

CommandDescription
router:matchHelps debug routes by simulating a path info match

S3

CommandDescription
s3:set-visibilitySets the visibility of all files in the s3 filesystem to public

Sales-channel

CommandDescription
sales-channel:createCreates a new sales channel
sales-channel:create:storefrontCreates a new storefront sales channel
sales-channel:listLists all sales channels
sales-channel:maintenance:disableDisables maintenance mode for a sales channel
sales-channel:maintenance:enableEnables maintenance mode for a sales channel
sales-channel:update:domainUpdates a sales channel domain

Scheduled-task

CommandDescriptionVersion
scheduled-task:registerRegisters all scheduled tasks
scheduled-task:runRuns scheduled tasks
scheduled-task:run-singleRuns single scheduled tasks6.5.5.0
scheduled-task:listLists all scheduled tasks6.5.5.0

Secrets

CommandDescription
secrets:decrypt-to-localDecrypts all secrets and stores them in the local vault
secrets:encrypt-from-localEncrypts all local secrets to the vault
secrets:generate-keysGenerates new encryption keys
secrets:listLists all secrets
secrets:removeRemoves a secret from the vault
secrets:setSets a secret in the vault

Sitemap

CommandDescription
sitemap:generateGenerates sitemaps for a given shop (or all active ones)

Snippets

CommandDescription
snippets:validateValidates snippets

State-machine

CommandDescription
state-machine:dumpDumps a state machine to a graphviz file

Store

CommandDescription
store:downloadDownloads a plugin from the store
store:loginLogin for the store

System

CommandDescription
system:config:getGets a config value
system:config:setSets a config value
system:configure-shopConfigures the shop
system:generate-app-secretGenerates a new app secret
system:generate-jwt-secretGenerates a new JWT secret
system:installInstalls the Shopware 6 system
system:setupSetup the system
system:update:finishFinishes the update process
system:update:preparePrepares the update process

Theme

CommandDescription
theme:changeChanges the active theme for a sales channel
theme:compileCompiles the theme
theme:createCreates a theme skeleton
theme:dumpDumps the theme configuration
theme:prepare-iconsPrepares the theme icons
theme:refreshRefreshes the theme configuration

User

CommandDescription
user:change-passwordChanges the password of a user
user:createCreates a new user