--version, -V
Display this application version
- Default:
false - Does not accept a value
--ansi
Force (or disable --no-ansi) ANSI output
- Does not accept a value
--no-ansi
Negate the “–ansi” option
- Default:
false - Does not accept a value
--no-interaction, -n
Do not ask any interactive question
- Default:
false - Does not accept a value
_complete
bin/magento _complete [-s|--shell SHELL] [-i|--input INPUT] [-c|--current CURRENT] [-a|--api-version API-VERSION] [-S|--symfony SYMFONY]
Internal command to provide shell completion suggestions
Options
For global options, see Global options.
--shell, -s
The shell type (“bash”, “fish”, “zsh”)
- Requires a value
--input, -i
An array of input tokens (e.g. COMP_WORDS or argv)
- Default:
[] - Requires a value
--current, -c
The index of the “input” array that the cursor is in (e.g. COMP_CWORD)
- Requires a value
--api-version, -a
The API version of the completion script
- Requires a value
--symfony, -S
deprecated
- Requires a value
completion
bin/magento completion [--debug] [--] [<shell>]
Dump the shell completion script
The completion command dumps the shell completion script required
to use shell autocompletion (currently, bash, fish, zsh completion are supported).
Static installation
-------------------
Dump the script to a global completion file and restart your shell:
bin/magento completion | sudo tee /etc/bash_completion.d/magento
Or dump the script to a local file and source it:
bin/magento completion > completion.sh
# source the file whenever you use the project
source completion.sh
# or add this line at the end of your "~/.bashrc" file:
source /path/to/completion.sh
Dynamic installation
--------------------
Add this to the end of your shell configuration file (e.g. "~/.bashrc"):
eval "$(/var/www/html/magento2/bin/magento completion )"
Arguments
shell
The shell type (e.g. “bash”), the value of the “$SHELL” env var will be used if this is not given
Options
For global options, see Global options.
--debug
Tail the completion debug log
- Default:
false - Does not accept a value
help
bin/magento help [--format FORMAT] [--raw] [--] [<command_name>]
Display help for a command
The help command displays help for a given command:
bin/magento help list
You can also output the help in other formats by using the --format option:
bin/magento help --format=xml list
To display the list of available commands, please use the list command.
Arguments
command_name
The command name
- Default:
help
- Default:
txt - Requires a value
--raw
To output raw command help
- Default:
false - Does not accept a value
list
bin/magento list [--raw] [--format FORMAT] [--short] [--] [<namespace>]
List commands
The list command lists all commands:
bin/magento list
You can also display the commands for a specific namespace:
bin/magento list test
You can also output the information in other formats by using the --format option:
bin/magento list --format=xml
It's also possible to get raw list of commands (useful for embedding command runner):
bin/magento list --raw
Arguments
namespace
The namespace name
- Default:
false - Does not accept a value
--format
The output format (txt, xml, json, or md)
- Default:
txt - Requires a value
--short
To skip describing commands’ arguments
- Default:
false - Does not accept a value
admin:adobe-ims:disable
bin/magento admin:adobe-ims:disable
bin/magento admin:adobe-ims:enable [-o|--organization-id [ORGANIZATION-ID]] [-c|--client-id [CLIENT-ID]] [-s|--client-secret [CLIENT-SECRET]] [-t|--2fa [2FA]]
Enable Adobe IMS Module.
Options
For global options, see Global options.
--organization-id, -o
Set Organization ID for Adobe IMS configuration. Required when enabling the module
- Accepts a value
--client-id, -c
Set the client ID for Adobe IMS configuration. Required when enabling the module
- Accepts a value
--client-secret, -s
Set the client Secret for Adobe IMS configuration. Required when enabling the module
- Accepts a value
--2fa, -t
Check if 2FA is enabled for Organization in Adobe Admin Console. Required when enabling the module
- Accepts a value
admin:adobe-ims:info
bin/magento admin:adobe-ims:info
admin:adobe-ims:status
bin/magento admin:adobe-ims:status
bin/magento admin:user:create [--admin-user ADMIN-USER] [--admin-password ADMIN-PASSWORD] [--admin-email ADMIN-EMAIL] [--admin-firstname ADMIN-FIRSTNAME] [--admin-lastname ADMIN-LASTNAME] [--magento-init-params MAGENTO-INIT-PARAMS]
Creates an administrator
Options
For global options, see Global options.
--admin-user
(Required) Admin user
- Requires a value
--admin-password
(Required) Admin password
- Requires a value
--admin-email
(Required) Admin email
- Requires a value
--admin-firstname
(Required) Admin first name
- Requires a value
--admin-lastname
(Required) Admin last name
- Requires a value
--magento-init-params
Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”
- Requires a value
admin:user:unlock
bin/magento admin:user:unlock <username>
Unlock Admin Account
This command unlocks an admin account by its username.
To unlock:
bin/magento admin:user:unlock username
Arguments
username
The admin username to unlock
- Required
bin/magento app:config:dump [<config-types>...]
Create dump of application
Arguments
config-types
Space-separated list of config types or omit to dump all [scopes, system, themes, i18n]
- Default:
[] - Array
bin/magento app:config:import
Import data from shared configuration files to appropriate data storage
Options
For global options, see Global options.
app:config:status
bin/magento app:config:status
Checks if config propagation requires update
Options
For global options, see Global options.
braintree:migrate
bin/magento braintree:migrate [--host HOST] [--dbname DBNAME] [--username USERNAME] [--password PASSWORD]
Migrate stored cards from a Magento 1 database
Options
For global options, see Global options.
--host
Hostname/IP. Port is optional
- Requires a value
--dbname
Database name
- Requires a value
--username
Database username. Must have read access
- Requires a value
--password
Password
- Requires a value
cache:clean
bin/magento cache:clean [--bootstrap BOOTSTRAP] [--] [<types>...]
Cleans cache type(s)
Arguments
types
Space-separated list of cache types or omit to apply to all cache types.
- Default:
[] - Array
Options
For global options, see Global options.
--bootstrap
add or override parameters of the bootstrap
- Requires a value
cache:disable
bin/magento cache:disable [--bootstrap BOOTSTRAP] [--] [<types>...]
Disables cache type(s)
Arguments
types
Space-separated list of cache types or omit to apply to all cache types.
- Default:
[] - Array
Options
For global options, see Global options.
--bootstrap
add or override parameters of the bootstrap
- Requires a value
cache:enable
bin/magento cache:enable [--bootstrap BOOTSTRAP] [--] [<types>...]
Enables cache type(s)
Arguments
types
Space-separated list of cache types or omit to apply to all cache types.
- Default:
[] - Array
Options
For global options, see Global options.
--bootstrap
add or override parameters of the bootstrap
- Requires a value
cache:flush
bin/magento cache:flush [--bootstrap BOOTSTRAP] [--] [<types>...]
Flushes cache storage used by cache type(s)
Arguments
types
Space-separated list of cache types or omit to apply to all cache types.
- Default:
[] - Array
Options
For global options, see Global options.
--bootstrap
add or override parameters of the bootstrap
- Requires a value
cache:status
bin/magento cache:status [--bootstrap BOOTSTRAP]
Checks cache status
Options
For global options, see Global options.
--bootstrap
add or override parameters of the bootstrap
- Requires a value
catalog:images:resize
bin/magento catalog:images:resize [-a|--async] [--skip_hidden_images]
Creates resized product images
Options
For global options, see Global options.
--async, -a
Resize image in asynchronous mode
- Default:
false - Does not accept a value
--skip_hidden_images
Do not process images marked as hidden from product page
- Default:
false - Does not accept a value
catalog:product:attributes:cleanup
bin/magento catalog:product:attributes:cleanup
Removes unused product attributes.
Options
For global options, see Global options.
cms:wysiwyg:restrict
bin/magento cms:wysiwyg:restrict <restrict>
Set whether to enforce user HTML content validation or show a warning instead
Arguments
restrict
y\n
- Required
bin/magento config:sensitive:set [-i|--interactive] [--scope [SCOPE]] [--scope-code [SCOPE-CODE]] [--] [<path> [<value>]]
Set sensitive configuration values
Arguments
path
Configuration path for example group/section/field_name
value
Configuration value
Options
For global options, see Global options.
--interactive, -i
Enable interactive mode to set all sensitive variables
- Default:
false - Does not accept a value
--scope
Scope for configuration, if not set use ‘default’
- Default:
default - Accepts a value
--scope-code
Scope code for configuration, empty string by default
- Default: ``
- Accepts a value
config:set
bin/magento config:set [--scope SCOPE] [--scope-code SCOPE-CODE] [-e|--lock-env] [-c|--lock-config] [-l|--lock] [--] <path> <value>
Change system configuration
Arguments
path
Configuration path in format section/group/field_name
- Required
value
Configuration value
- Required
Options
For global options, see Global options.
--scope
Configuration scope (default, website, or store)
- Default:
default - Requires a value
--scope-code
Scope code (required only if scope is not ‘default’)
- Requires a value
--lock-env, -e
Lock value which prevents modification in the Admin (will be saved in app/etc/env.php)
- Default:
false - Does not accept a value
--lock-config, -c
Lock and share value with other installations, prevents modification in the Admin (will be saved in app/etc/config.php)
- Default:
false - Does not accept a value
--lock, -l
Deprecated, use the --lock-env option instead.
- Default:
false - Does not accept a value
config:show
bin/magento config:show [--scope [SCOPE]] [--scope-code [SCOPE-CODE]] [--] [<path>]
Shows configuration value for given path. If path is not specified, all saved values will be shown
Arguments
path
Configuration path, for example section_id/group_id/field_id
Options
For global options, see Global options.
--scope
Scope for configuration, if not specified, then ‘default’ scope will be used
- Default:
default - Accepts a value
--scope-code
Scope code (required only if scope is not default)
- Default: ``
- Accepts a value
cron:install
bin/magento cron:install [-f|--force] [-d|--non-optional]
Generates and installs crontab for current user
- Default:
false - Does not accept a value
--non-optional, -d
Install only the non-optional (default) tasks
- Default:
false - Does not accept a value
cron:remove
bin/magento cron:remove
bin/magento cron:run [--group GROUP] [--exclude-group [EXCLUDE-GROUP]] [--bootstrap BOOTSTRAP]
Runs jobs by schedule
Options
For global options, see Global options.
--group
Run jobs only from specified group
- Requires a value
--exclude-group
Exclude jobs from the specified group
- Default:
[] - Accepts multiple values
--bootstrap
Add or override parameters of the bootstrap
- Requires a value
customer:hash:upgrade
bin/magento customer:hash:upgrade
Upgrade customer’s hash according to the latest algorithm
Options
For global options, see Global options.
deploy:mode:set
bin/magento deploy:mode:set [-s|--skip-compilation] [--] <mode>
Set application mode.
Arguments
mode
The application mode to set. Available options are “developer” or “production”
- Required
Options
For global options, see Global options.
--skip-compilation, -s
Skips the clearing and regeneration of static content (generated code, preprocessed CSS, and assets in pub/static/)
- Default:
false - Does not accept a value
deploy:mode:show
bin/magento deploy:mode:show
bin/magento dev:di:info <class>
Provides information on Dependency Injection configuration for the Command.
Arguments
class
Class name
- Required
bin/magento dev:email:newsletter-compatibility-check
Scans newsletter templates for potential variable usage compatibility issues
Options
For global options, see Global options.
dev:email:override-compatibility-check
bin/magento dev:email:override-compatibility-check
Scans email template overrides for potential variable usage compatibility issues
Options
For global options, see Global options.
dev:profiler:disable
bin/magento dev:profiler:disable
bin/magento dev:profiler:enable [<type>]
Enable the profiler.
Arguments
type
Profiler type
Options
For global options, see Global options.
dev:query-log:disable
bin/magento dev:query-log:disable
bin/magento dev:query-log:enable [--include-all-queries [INCLUDE-ALL-QUERIES]] [--query-time-threshold [QUERY-TIME-THRESHOLD]] [--include-call-stack [INCLUDE-CALL-STACK]]
--include-all-queries
Log all queries. [true|false]
- Default:
true - Accepts a value
--query-time-threshold
Query time thresholds.
- Default:
0.001 - Accepts a value
--include-call-stack
Include call stack. [true|false]
- Default:
true - Accepts a value
dev:source-theme:deploy
bin/magento dev:source-theme:deploy [--type TYPE] [--locale LOCALE] [--area AREA] [--theme THEME] [--] [<file>...]
Collects and publishes source files for theme.
Arguments
file
Files to pre-process (file should be specified without extension)
-
Default:
css/styles-mcss/styles-l -
Array
- Default:
less - Requires a value
--locale
Locale: [en_US]
- Default:
en_US - Requires a value
--area
Area: [frontend|adminhtml]
- Default:
frontend - Requires a value
--theme
Theme: [Vendor/theme]
- Default:
Magento/luma - Requires a value
dev:template-hints:disable
bin/magento dev:template-hints:disable
Disable frontend template hints. A cache flush might be required.
Options
For global options, see Global options.
dev:template-hints:enable
bin/magento dev:template-hints:enable
Enable frontend template hints. A cache flush might be required.
Options
For global options, see Global options.
dev:template-hints:status
bin/magento dev:template-hints:status
bin/magento dev:tests:run [-c|--arguments ARGUMENTS] [--] [<type>]
Runs tests
Arguments
type
Type of test to run. Available types: all, unit, integration, integration-all, static, static-all, integrity, legacy, default
- Default:
default
Options
For global options, see Global options.
--arguments, -c
Additional arguments for PHPUnit. Example: “-c’–filter=MyTest’” (no spaces)
- Default: ``
- Requires a value
dev:urn-catalog:generate
bin/magento dev:urn-catalog:generate [--ide IDE] [--] <path>
Generates the catalog of URNs to *.xsd mappings for the IDE to highlight xml.
Arguments
path
Path to file to output the catalog. For PhpStorm use .idea/misc.xml
- Required
Options
For global options, see Global options.
--ide
Format in which catalog will be generated. Supported: [phpstorm, vscode]
- Default:
phpstorm - Requires a value
dev:xml:convert
bin/magento dev:xml:convert [-o|--overwrite] [--] <xml-file> <processor>
Converts XML file using XSL style sheets
Arguments
xml-file
Path to XML file that going to be transformed
- Required
processor
Path to XSL style sheet that going to be applied to XML file
- Required
- Default:
false - Does not accept a value
downloadable:domains:add
bin/magento downloadable:domains:add [<domains>...]
Add domains to the downloadable domains whitelist
Arguments
domains
Domains name
- Default:
[] - Array
bin/magento downloadable:domains:remove [<domains>...]
Remove domains from the downloadable domains whitelist
Arguments
domains
Domain names
- Default:
[] - Array
bin/magento downloadable:domains:show
Display downloadable domains whitelist
Options
For global options, see Global options.
encryption:payment-data:update
bin/magento encryption:payment-data:update
Re-encrypts encrypted credit card data with latest encryption cipher.
Options
For global options, see Global options.
events:create-event-provider
bin/magento events:create-event-provider [--label [LABEL]] [--description [DESCRIPTION]]events:provider:create
Create a custom event provider in Adobe I/O Events for this instance. If you do not specify the label and description options, they must be defined in the system app/etc/event-types.json file.
Options
For global options, see Global options.
--label
A label to define your custom provider.
- Accepts a value
--description
A description of your provider.
- Accepts a value
events:generate:module
bin/magento events:generate:module
Generate module based on plugins list
bin/magento events:info [--depth [DEPTH]] [--] <event-code>
Returns the payload of the specified event.
Arguments
event-code
Event code
- Required
Options
For global options, see Global options.
--depth
The number of levels in the event payload to return
- Default:
2 - Accepts a value
events:list
bin/magento events:list
bin/magento events:list:all <module_name>
Returns a list of subscribable events defined in the specified module
Arguments
module_name
Module name
- Required
bin/magento events:metadata:populate
Creates metadata in Adobe I/O from the configuration list (XML and application configurations)
Options
For global options, see Global options.
events:provider:info
bin/magento events:provider:info
Returns details about the configured event provider
Options
For global options, see Global options.
events:registrations:list
bin/magento events:registrations:list
Lists event registrations in your App Builder project
Options
For global options, see Global options.
events:subscribe
bin/magento events:subscribe [-f|--force] [--fields FIELDS] [--parent PARENT] [--rules RULES] [-p|--priority] [-d|--destination DESTINATION] [--hipaaAuditRequired] [--] <event-code>
Subscribes to the event
Arguments
event-code
Event code
- Required
Options
For global options, see Global options.
--force, -f
Forces the specified event to be subscribed, even if it hasn’t been defined locally.
- Default:
false - Does not accept a value
--fields
The list of fields in the event data payload.
- Default:
[] - Requires a value
--parent
The parent event code for an event subscription with rules.
- Requires a value
--rules
The list of rules for the event subscription, where each rule is formatted as “field|operator|value”.
- Default:
[] - Requires a value
--priority, -p
Expedites the transmission of this event. Specify this option for events that need to be delivered immediately. By default, events are sent by cron once per minute.
- Default:
false - Does not accept a value
--destination, -d
The destination of this event. Specify this option for the events that should be delivered to the custom destination.
- Default:
default - Requires a value
--hipaaAuditRequired
Indicates the event contains data that is subject to HIPAA auditing.
- Default:
false - Does not accept a value
events:sync-events-metadata
bin/magento events:sync-events-metadata [-d|--delete]
Synchronise event metadata for this instance
Options
For global options, see Global options.
--delete, -d
Delete events metadata no longer required
- Default:
false - Does not accept a value
events:unsubscribe
bin/magento events:unsubscribe <event-code>
Removes the subscription to the supplied event
Arguments
event-code
Event code to unsubscribe from
- Required
bin/magento i18n:collect-phrases [-o|--output OUTPUT] [-m|--magento] [--] [<directory>]
Discovers phrases in the codebase
Arguments
directory
Directory path to parse. Not needed if --magento flag is set
Options
For global options, see Global options.
--output, -o
Path (including filename) to an output file. With no file specified, defaults to stdout.
- Requires a value
--magento, -m
Use the --magento parameter to parse the current Magento codebase. Omit the parameter if a directory is specified.
- Default:
false - Does not accept a value
i18n:pack
bin/magento i18n:pack [-m|--mode MODE] [-d|--allow-duplicates] [--] <source> <locale>
Saves language package
Arguments
source
Path to source dictionary file with translations
- Required
locale
Target locale for dictionary, for example “de_DE”
- Required
Options
For global options, see Global options.
--mode, -m
Save mode for dictionary - “replace” - replace language pack by new one - “merge” - merge language packages, by default “replace”
- Default:
replace - Requires a value
--allow-duplicates, -d
Use the --allow-duplicates parameter to allow saving duplicates of translate. Otherwise omit the parameter.
- Default:
false - Does not accept a value
i18n:uninstall
bin/magento i18n:uninstall [-b|--backup-code] [--] <package>...
Uninstalls language packages
Arguments
package
Language package name
-
Default:
[] -
Required
-
Array
Options
For global options, see Global options.
--backup-code, -b
Take code and configuration files backup (excluding temporary files)
- Default:
false - Does not accept a value
indexer:info
bin/magento indexer:info
bin/magento indexer:reindex [<index>...]
Reindexes Data
Arguments
index
Space-separated list of index types or omit to apply to all indexes.
- Default:
[] - Array
bin/magento indexer:reset [<index>...]
Resets indexer status to invalid
Arguments
index
Space-separated list of index types or omit to apply to all indexes.
- Default:
[] - Array
bin/magento indexer:set-dimensions-mode [<indexer> [<mode>]]
Set Indexer Dimensions Mode
Arguments
indexer
Indexer name [catalog_product_price|catalogpermissions_category]
mode
Indexer dimension modes catalog_product_price none,website,customer_group,website_and_customer_group catalogpermissions_category none,customer_group
Options
For global options, see Global options.
indexer:set-mode
bin/magento indexer:set-mode [<mode> [<index>...]]
Sets index mode type
Arguments
mode
Indexer mode type [realtime|schedule]
index
Space-separated list of index types or omit to apply to all indexes.
- Default:
[] - Array
bin/magento indexer:set-status <status> [<index>...]
Sets the specified indexer status
Arguments
status
Indexer status type [invalid|suspended|valid]
- Required
index
Space-separated list of index types or omit to apply to all indexes.
- Default:
[] - Array
bin/magento indexer:show-dimensions-mode [<indexer>...]
Shows Indexer Dimension Mode
Arguments
indexer
Space-separated list of index types or omit to apply to all indexes (catalog_product_price,catalogpermissions_category)
- Default:
[] - Array
bin/magento indexer:show-mode [<index>...]
Shows Index Mode
Arguments
index
Space-separated list of index types or omit to apply to all indexes.
- Default:
[] - Array
bin/magento indexer:status [<index>...]
Shows status of Indexer
Arguments
index
Space-separated list of index types or omit to apply to all indexes.
- Default:
[] - Array
bin/magento info:adminuri
bin/magento info:backups:list
Prints list of available backup files
Options
For global options, see Global options.
info:currency:list
bin/magento info:currency:list
Displays the list of available currencies
Options
For global options, see Global options.
info:dependencies:show-framework
bin/magento info:dependencies:show-framework [-o|--output OUTPUT]
Shows number of dependencies on Magento framework
Options
For global options, see Global options.
--output, -o
Report filename
- Default:
framework-dependencies.csv - Requires a value
info:dependencies:show-modules
bin/magento info:dependencies:show-modules [-o|--output OUTPUT]
Shows number of dependencies between modules
Options
For global options, see Global options.
--output, -o
Report filename
- Default:
modules-dependencies.csv - Requires a value
info:dependencies:show-modules-circular
bin/magento info:dependencies:show-modules-circular [-o|--output OUTPUT]
Shows number of circular dependencies between modules
Options
For global options, see Global options.
--output, -o
Report filename
- Default:
modules-circular-dependencies.csv - Requires a value
info:language:list
bin/magento info:language:list
Displays the list of available language locales
bin/magento info:timezone:list
Displays the list of available timezones
Options
For global options, see Global options.
inventory:reservation:create-compensations
bin/magento inventory:reservation:create-compensations [-r|--raw] [--] [<compensations>...]
Create reservations by provided compensation arguments
Arguments
compensations
List of compensation arguments in format “:::”
- Default:
[] - Array
- Default:
false - Does not accept a value
inventory:reservation:list-inconsistencies
bin/magento inventory:reservation:list-inconsistencies [-c|--complete-orders] [-i|--incomplete-orders] [-b|--bunch-size [BUNCH-SIZE]] [-r|--raw]
Show all orders and products with salable quantity inconsistencies
Options
For global options, see Global options.
--complete-orders, -c
Show only inconsistencies for complete orders
- Default:
false - Does not accept a value
--incomplete-orders, -i
Show only inconsistencies for incomplete orders
- Default:
false - Does not accept a value
--bunch-size, -b
Defines how many orders will be loaded at once
- Default:
50 - Accepts a value
--raw, -r
Raw output
- Default:
false - Does not accept a value
inventory-geonames:import
bin/magento inventory-geonames:import <countries>...
Download and import geo names for source selection algorithm
Arguments
countries
List of country codes to import
-
Default:
[] -
Required
-
Array
bin/magento maintenance:allow-ips [--none] [--add] [--magento-init-params MAGENTO-INIT-PARAMS] [--] [<ip>...]
Sets maintenance mode exempt IPs
Arguments
ip
Allowed IP addresses
- Default:
[] - Array
- Default:
false - Does not accept a value
--add
Add the IP address to existing list
- Default:
false - Does not accept a value
--magento-init-params
Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”
- Requires a value
maintenance:disable
bin/magento maintenance:disable [--ip IP] [--magento-init-params MAGENTO-INIT-PARAMS]
Disables maintenance mode
Options
For global options, see Global options.
--ip
Allowed IP addresses (use ‘none’ to clear allowed IP list)
- Default:
[] - Requires a value
--magento-init-params
Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”
- Requires a value
maintenance:enable
bin/magento maintenance:enable [--ip IP] [--magento-init-params MAGENTO-INIT-PARAMS]
Enables maintenance mode
Options
For global options, see Global options.
--ip
Allowed IP addresses (use ‘none’ to clear allowed IP list)
- Default:
[] - Requires a value
--magento-init-params
Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”
- Requires a value
maintenance:status
bin/magento maintenance:status [--magento-init-params MAGENTO-INIT-PARAMS]
Displays maintenance mode status
Options
For global options, see Global options.
--magento-init-params
Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”
- Requires a value
media-content:sync
bin/magento media-content:sync
bin/magento media-gallery:sync
Synchronize media storage and media assets in the database
Options
For global options, see Global options.
module:config:status
bin/magento module:config:status
Checks the modules configuration in the ‘app/etc/config.php’ file and reports if they are up to date or not
Options
For global options, see Global options.
module:disable
bin/magento module:disable [-f|--force] [--all] [-c|--clear-static-content] [--magento-init-params MAGENTO-INIT-PARAMS] [--] [<module>...]
Disables specified modules
Arguments
module
Name of the module
- Default:
[] - Array
- Default:
false - Does not accept a value
--all
Disable all modules
- Default:
false - Does not accept a value
--clear-static-content, -c
Clear generated static view files. Necessary, if the module(s) have static view files
- Default:
false - Does not accept a value
--magento-init-params
Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”
- Requires a value
module:enable
bin/magento module:enable [-f|--force] [--all] [-c|--clear-static-content] [--magento-init-params MAGENTO-INIT-PARAMS] [--] [<module>...]
Enables specified modules
Arguments
module
Name of the module
- Default:
[] - Array
- Default:
false - Does not accept a value
--all
Enable all modules
- Default:
false - Does not accept a value
--clear-static-content, -c
Clear generated static view files. Necessary, if the module(s) have static view files
- Default:
false - Does not accept a value
--magento-init-params
Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”
- Requires a value
module:status
bin/magento module:status [--enabled] [--disabled] [--magento-init-params MAGENTO-INIT-PARAMS] [--] [<module-names>...]
Displays status of modules
Arguments
module-names
Optional module name
- Default:
[] - Array
- Default:
false - Does not accept a value
--disabled
Print only disabled modules
- Default:
false - Does not accept a value
--magento-init-params
Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”
- Requires a value
module:uninstall
bin/magento module:uninstall [-r|--remove-data] [--backup-code] [--backup-media] [--backup-db] [--non-composer] [-c|--clear-static-content] [--magento-init-params MAGENTO-INIT-PARAMS] [--] <module>...
Uninstalls modules installed by composer
Arguments
module
Name of the module
-
Default:
[] -
Required
-
Array
Options
For global options, see Global options.
--remove-data, -r
Remove data installed by module(s)
- Default:
false - Does not accept a value
--backup-code
Take code and configuration files backup (excluding temporary files)
- Default:
false - Does not accept a value
--backup-media
Take media backup
- Default:
false - Does not accept a value
--backup-db
Take complete database backup
- Default:
false - Does not accept a value
--non-composer
All modules, that will be past here will be non composer based
- Default:
false - Does not accept a value
--clear-static-content, -c
Clear generated static view files. Necessary, if the module(s) have static view files
- Default:
false - Does not accept a value
--magento-init-params
Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”
- Requires a value
newrelic:create:deploy-marker
bin/magento newrelic:create:deploy-marker <message> <change_log> [<user> [<revision>]]
Check the deploy queue for entries and create an appropriate deploy marker.
Arguments
message
Deploy Message?
- Required
change_log
Change Log?
- Required
user
Deployment User
revision
Revision
Options
For global options, see Global options.
queue:consumers:list
bin/magento queue:consumers:list
List of MessageQueue consumers
This command shows list of MessageQueue consumers.
bin/magento queue:consumers:restart
Restart MessageQueue consumers
Command put poison pill for MessageQueue consumers and force to restart them after next status check.
bin/magento queue:consumers:start [--max-messages MAX-MESSAGES] [--batch-size BATCH-SIZE] [--area-code AREA-CODE] [--single-thread] [--multi-process [MULTI-PROCESS]] [--pid-file-path PID-FILE-PATH] [--] <consumer>
Start MessageQueue consumer
This command starts MessageQueue consumer by its name.
To start consumer which will process all queued messages and terminate execution:
bin/magento queue:consumers:start someConsumer
To specify the number of messages which should be processed by consumer before its termination:
bin/magento queue:consumers:start someConsumer --max-messages=50
To specify the number of messages per batch for the batch consumer:
bin/magento queue:consumers:start someConsumer --batch-size=500
To specify the preferred area:
bin/magento queue:consumers:start someConsumer --area-code='adminhtml'
To do not run multiple copies of one consumer simultaneously:
bin/magento queue:consumers:start someConsumer --single-thread
To save PID enter path (This option is deprecated, use --single-thread instead):
bin/magento queue:consumers:start someConsumer --pid-file-path='/var/someConsumer.pid'
To define the number of processes per consumer:
bin/magento queue:consumers:start someConsumer --multi-process=4
Arguments
consumer
The name of the consumer to be started.
- Required
Options
For global options, see Global options.
--max-messages
The number of messages to be processed by the consumer before process termination. If not specified - terminate after processing all queued messages.
- Requires a value
--batch-size
The number of messages per batch. Applicable for the batch consumer only.
- Requires a value
--area-code
The preferred area (global, adminhtml, etc…) default is global.
- Requires a value
--single-thread
This option prevents running multiple copies of one consumer simultaneously.
- Default:
false - Does not accept a value
--multi-process
The number of processes per consumer.
- Accepts a value
--pid-file-path
The file path for saving PID (This option is deprecated, use --single-thread instead)
- Requires a value
remote-storage:sync
bin/magento remote-storage:sync
Synchronize media files with remote storage.
Options
For global options, see Global options.
saas:resync
bin/magento saas:resync [--feed FEED] [--no-reindex] [--cleanup-feed] [--dry-run] [--thread-count THREAD-COUNT] [--batch-size BATCH-SIZE] [--continue-resync]
Re-syncs feed data to SaaS service.
Options
For global options, see Global options.
--feed
Feed name to fully re-sync to SaaS service. Available feeds: Payment Services Order Production, Payment Services Order Sandbox, Payment Services Order Status Production, Payment Services Order Status Sandbox, Payment Services Store Production, Payment Services Store Sandbox
- Requires a value
--no-reindex
Run re-submission of feed data to SaaS service only. Does not re-index. (This option is not applicable to the products, productoverrides, prices feeds)
- Default:
false - Does not accept a value
--cleanup-feed
Force to cleanup feed indexer table before sync.
- Default:
false - Does not accept a value
--dry-run
Dry run. Data will not be exported. To save payload to log file var/log/saas-export.log run with env variable EXPORTER_EXTENDED_LOG=1.
- Default:
false - Does not accept a value
--thread-count
Set synchronization thread count.
- Requires a value
--batch-size
Set synchronization batch size
- Requires a value
--continue-resync
Continue resync from the last stored position (This option is applicable to the products, productoverrides, prices feeds)
- Default:
false - Does not accept a value
sampledata:deploy
bin/magento sampledata:deploy [--no-update]
Deploy sample data modules for composer-based Magento installations
Options
For global options, see Global options.
--no-update
Update composer.json without executing composer update
- Default:
false - Does not accept a value
sampledata:remove
bin/magento sampledata:remove [--no-update]
Remove all sample data packages from composer.json
Options
For global options, see Global options.
--no-update
Update composer.json without executing composer update
- Default:
false - Does not accept a value
sampledata:reset
bin/magento sampledata:reset
Reset all sample data modules for re-installation
Options
For global options, see Global options.
security:recaptcha:disable-for-user-forgot-password
bin/magento security:recaptcha:disable-for-user-forgot-password
Disable reCAPTCHA for admin user forgot password form
Options
For global options, see Global options.
security:recaptcha:disable-for-user-login
bin/magento security:recaptcha:disable-for-user-login
Disable reCAPTCHA for admin user login form
Options
For global options, see Global options.
security:tfa:google:set-secret
bin/magento security:tfa:google:set-secret <user> <secret>
Set the secret used for Google OTP generation.
Arguments
user
Username
- Required
secret
Secret
- Required
bin/magento security:tfa:providers
bin/magento security:tfa:reset <user> <provider>
Reset configuration for one user
Arguments
user
Username
- Required
provider
Provider code
- Required
bin/magento server:run [-p|--port [PORT]] [-b|--background [BACKGROUND]] [-wn|--workerNum [WORKERNUM]] [-dm|--dispatchMode [DISPATCHMODE]] [-mr|--maxRequests [MAXREQUESTS]] [-a|--area [AREA]] [-mip|--magento-init-params [MAGENTO-INIT-PARAMS]] [-mwt|--maxWaitTime [MAXWAITTIME]] [--state-monitor]
Run application server
- Default:
9501 - Accepts a value
--background, -b
background mode flag
- Default:
0 - Accepts a value
--workerNum, -wn
number of worker processes to start
- Default:
4 - Accepts a value
--dispatchMode, -dm
mode of dispatching connections to the worker processes
- Default:
3 - Accepts a value
--maxRequests, -mr
max requests before worker process would be restarted
- Default:
10000 - Accepts a value
--area, -a
application server area
- Default:
graphql - Accepts a value
--magento-init-params, -mip
magento bootstrap init params
- Default: ``
- Accepts a value
--maxWaitTime, -mwt
how long to wait for workers after reload (eg. config change) before killing them
- Default:
3600 - Accepts a value
--state-monitor
Enable state monitoring. Use this only for debugging state issues!
- Default:
false - Does not accept a value
server:state-monitor:aggregate-output
bin/magento server:state-monitor:aggregate-output
Aggregate output from state monitor of ApplicationServer
Options
For global options, see Global options.
setup:backup
bin/magento setup:backup [--code] [--media] [--db] [--magento-init-params MAGENTO-INIT-PARAMS]
Takes backup of Magento Application code base, media and database
Options
For global options, see Global options.
--code
Take code and configuration files backup (excluding temporary files)
- Default:
false - Does not accept a value
--media
Take media backup
- Default:
false - Does not accept a value
--db
Take complete database backup
- Default:
false - Does not accept a value
--magento-init-params
Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”
- Requires a value
setup:config:set
bin/magento setup:config:set [--enable-debug-logging ENABLE-DEBUG-LOGGING] [--enable-syslog-logging ENABLE-SYSLOG-LOGGING] [--backend-frontname BACKEND-FRONTNAME] [--remote-storage-driver REMOTE-STORAGE-DRIVER] [--remote-storage-prefix REMOTE-STORAGE-PREFIX] [--remote-storage-endpoint REMOTE-STORAGE-ENDPOINT] [--remote-storage-bucket REMOTE-STORAGE-BUCKET] [--remote-storage-region REMOTE-STORAGE-REGION] [--remote-storage-key REMOTE-STORAGE-KEY] [--remote-storage-secret REMOTE-STORAGE-SECRET] [--remote-storage-path-style REMOTE-STORAGE-PATH-STYLE] [--id_salt ID_SALT] [--config-async CONFIG-ASYNC] [--checkout-async CHECKOUT-ASYNC] [--amqp-host AMQP-HOST] [--amqp-port AMQP-PORT] [--amqp-user AMQP-USER] [--amqp-password AMQP-PASSWORD] [--amqp-virtualhost AMQP-VIRTUALHOST] [--amqp-ssl AMQP-SSL] [--amqp-ssl-options AMQP-SSL-OPTIONS] [--consumers-wait-for-messages CONSUMERS-WAIT-FOR-MESSAGES] [--queue-default-connection QUEUE-DEFAULT-CONNECTION] [--deferred-total-calculating DEFERRED-TOTAL-CALCULATING] [--key KEY] [--db-host DB-HOST] [--db-name DB-NAME] [--db-user DB-USER] [--db-engine DB-ENGINE] [--db-password DB-PASSWORD] [--db-prefix DB-PREFIX] [--db-model DB-MODEL] [--db-init-statements DB-INIT-STATEMENTS] [-s|--skip-db-validation] [--http-cache-hosts HTTP-CACHE-HOSTS] [--db-ssl-key DB-SSL-KEY] [--db-ssl-cert DB-SSL-CERT] [--db-ssl-ca DB-SSL-CA] [--db-ssl-verify] [--session-save SESSION-SAVE] [--session-save-redis-host SESSION-SAVE-REDIS-HOST] [--session-save-redis-port SESSION-SAVE-REDIS-PORT] [--session-save-redis-password SESSION-SAVE-REDIS-PASSWORD] [--session-save-redis-timeout SESSION-SAVE-REDIS-TIMEOUT] [--session-save-redis-persistent-id SESSION-SAVE-REDIS-PERSISTENT-ID] [--session-save-redis-db SESSION-SAVE-REDIS-DB] [--session-save-redis-compression-threshold SESSION-SAVE-REDIS-COMPRESSION-THRESHOLD] [--session-save-redis-compression-lib SESSION-SAVE-REDIS-COMPRESSION-LIB] [--session-save-redis-log-level SESSION-SAVE-REDIS-LOG-LEVEL] [--session-save-redis-max-concurrency SESSION-SAVE-REDIS-MAX-CONCURRENCY] [--session-save-redis-break-after-frontend SESSION-SAVE-REDIS-BREAK-AFTER-FRONTEND] [--session-save-redis-break-after-adminhtml SESSION-SAVE-REDIS-BREAK-AFTER-ADMINHTML] [--session-save-redis-first-lifetime SESSION-SAVE-REDIS-FIRST-LIFETIME] [--session-save-redis-bot-first-lifetime SESSION-SAVE-REDIS-BOT-FIRST-LIFETIME] [--session-save-redis-bot-lifetime SESSION-SAVE-REDIS-BOT-LIFETIME] [--session-save-redis-disable-locking SESSION-SAVE-REDIS-DISABLE-LOCKING] [--session-save-redis-min-lifetime SESSION-SAVE-REDIS-MIN-LIFETIME] [--session-save-redis-max-lifetime SESSION-SAVE-REDIS-MAX-LIFETIME] [--session-save-redis-sentinel-master SESSION-SAVE-REDIS-SENTINEL-MASTER] [--session-save-redis-sentinel-servers SESSION-SAVE-REDIS-SENTINEL-SERVERS] [--session-save-redis-sentinel-verify-master SESSION-SAVE-REDIS-SENTINEL-VERIFY-MASTER] [--session-save-redis-sentinel-connect-retries SESSION-SAVE-REDIS-SENTINEL-CONNECT-RETRIES] [--cache-backend CACHE-BACKEND] [--cache-backend-redis-server CACHE-BACKEND-REDIS-SERVER] [--cache-backend-redis-db CACHE-BACKEND-REDIS-DB] [--cache-backend-redis-port CACHE-BACKEND-REDIS-PORT] [--cache-backend-redis-password CACHE-BACKEND-REDIS-PASSWORD] [--cache-backend-redis-compress-data CACHE-BACKEND-REDIS-COMPRESS-DATA] [--cache-backend-redis-compression-lib CACHE-BACKEND-REDIS-COMPRESSION-LIB] [--cache-backend-redis-use-lua CACHE-BACKEND-REDIS-USE-LUA] [--cache-id-prefix CACHE-ID-PREFIX] [--allow-parallel-generation] [--page-cache PAGE-CACHE] [--page-cache-redis-server PAGE-CACHE-REDIS-SERVER] [--page-cache-redis-db PAGE-CACHE-REDIS-DB] [--page-cache-redis-port PAGE-CACHE-REDIS-PORT] [--page-cache-redis-password PAGE-CACHE-REDIS-PASSWORD] [--page-cache-redis-compress-data PAGE-CACHE-REDIS-COMPRESS-DATA] [--page-cache-redis-compression-lib PAGE-CACHE-REDIS-COMPRESSION-LIB] [--page-cache-id-prefix PAGE-CACHE-ID-PREFIX] [--lock-provider LOCK-PROVIDER] [--lock-db-prefix LOCK-DB-PREFIX] [--lock-zookeeper-host LOCK-ZOOKEEPER-HOST] [--lock-zookeeper-path LOCK-ZOOKEEPER-PATH] [--lock-file-path LOCK-FILE-PATH] [--document-root-is-pub DOCUMENT-ROOT-IS-PUB] [--backpressure-logger BACKPRESSURE-LOGGER] [--backpressure-logger-redis-server BACKPRESSURE-LOGGER-REDIS-SERVER] [--backpressure-logger-redis-port BACKPRESSURE-LOGGER-REDIS-PORT] [--backpressure-logger-redis-timeout BACKPRESSURE-LOGGER-REDIS-TIMEOUT] [--backpressure-logger-redis-persistent BACKPRESSURE-LOGGER-REDIS-PERSISTENT] [--backpressure-logger-redis-db BACKPRESSURE-LOGGER-REDIS-DB] [--backpressure-logger-redis-password BACKPRESSURE-LOGGER-REDIS-PASSWORD] [--backpressure-logger-redis-user BACKPRESSURE-LOGGER-REDIS-USER] [--backpressure-logger-id-prefix BACKPRESSURE-LOGGER-ID-PREFIX] [--magento-init-params MAGENTO-INIT-PARAMS]
Creates or modifies the deployment configuration
- Requires a value
--enable-syslog-logging
Enable syslog logging
- Requires a value
--backend-frontname
Backend frontname (will be autogenerated if missing)
- Requires a value
--remote-storage-driver
Remote storage driver
- Requires a value
--remote-storage-prefix
Remote storage prefix
- Default: ``
- Requires a value
--remote-storage-endpoint
Remote storage endpoint
- Requires a value
--remote-storage-bucket
Remote storage bucket
- Requires a value
--remote-storage-region
Remote storage region
- Requires a value
--remote-storage-key
Remote storage access key
- Default: ``
- Requires a value
--remote-storage-secret
Remote storage secret key
- Default: ``
- Requires a value
--remote-storage-path-style
Remote storage path style
- Default:
0 - Requires a value
--id_salt
GraphQl Salt
- Requires a value
--config-async
Enable async Admin Config Save? 1 - Yes, 0 - No
- Requires a value
--checkout-async
Enable async order processing? 1 - Yes, 0 - No
- Requires a value
--amqp-host
Amqp server host
- Default: ``
- Requires a value
--amqp-port
Amqp server port
- Default:
5672 - Requires a value