bin/magento (Open Source)
Version: 2.3.5
This reference contains 106 commands available through the bin/magento
command-line tool.
The initial list is auto generated using the bin/magento list
command at the Magento Open Source edition.
Use the “Add CLI commands” guide to add a custom Magento CLI command.
You can call Magento CLI commands using shortcuts instead of the full command name. For example, you can call bin/magento setup:upgrade
using bin/magento s:up
, bin/magento s:upg
. See shortcut syntax to understand how to use shortcuts with any Magento CLI command.
Reference
This reference is generated from the Magento codebase. To change the content, you can update the source code for the corresponding command implementation in Magento codebase repository and submit your changes for review. Another way is to Give us feedback (find the link at the upper right). For contribution guidelines, see Magento Code Contributions.
help
Displays help for a command
1
bin/magento help [--format FORMAT] [--raw] [--] [<command_name>]
Arguments
command_name
-
Description: The command name
-
Default:
help
Options
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
format
-
Option:
--format
-
Description: The output format (txt, xml, json, or md)
-
Default:
txt
-
Requires a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
raw
-
Option:
--raw
-
Description: To output raw command help
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
list
Lists commands
1
bin/magento list [--raw] [--format FORMAT] [--] [<namespace>]
Arguments
namespace
- Description: The namespace name
Options
raw
-
Option:
--raw
-
Description: To output raw command list
-
Default:
false
-
Does not accept a value
format
-
Option:
--format
-
Description: The output format (txt, xml, json, or md)
-
Default:
txt
-
Requires a value
admin:user:create
Creates an administrator
1
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]
admin:user:unlock
Unlock Admin Account
1
bin/magento admin:user:unlock <username>
Arguments
username
-
Description: The admin username to unlock
-
Required
Options
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
app:config:dump
Create dump of application
1
bin/magento app:config:dump [<config-types>...]
Arguments
config-types
-
Description: Space-separated list of config types or omit to dump all [scopes, system, themes, i18n]
-
Default:
[]
-
Array
Options
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
app:config:import
Import data from shared configuration files to appropriate data storage
1
bin/magento app:config:import
app:config:status
Checks if config propagation requires update
1
bin/magento app:config:status
cache:clean
Cleans cache type(s)
1
bin/magento cache:clean [--bootstrap BOOTSTRAP] [--] [<types>...]
Arguments
types
-
Description: Space-separated list of cache types or omit to apply to all cache types.
-
Default:
[]
-
Array
Options
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
bootstrap
-
Option:
--bootstrap
-
Description: add or override parameters of the bootstrap
-
Requires a value
cache:disable
Disables cache type(s)
1
bin/magento cache:disable [--bootstrap BOOTSTRAP] [--] [<types>...]
Arguments
types
-
Description: Space-separated list of cache types or omit to apply to all cache types.
-
Default:
[]
-
Array
Options
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
bootstrap
-
Option:
--bootstrap
-
Description: add or override parameters of the bootstrap
-
Requires a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
cache:enable
Enables cache type(s)
1
bin/magento cache:enable [--bootstrap BOOTSTRAP] [--] [<types>...]
Arguments
types
-
Description: Space-separated list of cache types or omit to apply to all cache types.
-
Default:
[]
-
Array
Options
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
bootstrap
-
Option:
--bootstrap
-
Description: add or override parameters of the bootstrap
-
Requires a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
cache:flush
Flushes cache storage used by cache type(s)
1
bin/magento cache:flush [--bootstrap BOOTSTRAP] [--] [<types>...]
Arguments
types
-
Description: Space-separated list of cache types or omit to apply to all cache types.
-
Default:
[]
-
Array
Options
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
bootstrap
-
Option:
--bootstrap
-
Description: add or override parameters of the bootstrap
-
Requires a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
cache:status
Checks cache status
1
bin/magento cache:status [--bootstrap BOOTSTRAP]
catalog:images:resize
Creates resized product images
1
bin/magento catalog:images:resize
catalog:product:attributes:cleanup
Removes unused product attributes.
1
bin/magento catalog:product:attributes:cleanup
config:sensitive:set
Set sensitive configuration values
1
bin/magento config:sensitive:set [-i|--interactive] [--scope [SCOPE]] [--scope-code [SCOPE-CODE]] [--] [<path> [<value>]]
Arguments
path
- Description: Configuration path for example group/section/field_name
value
- Description: Configuration value
Options
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
scope-code
-
Option:
--scope-code
-
Description: Scope code for configuration, empty string by default
-
Default: ``
-
Accepts a value
interactive
-
Option:
--interactive
-
Shortcut:
-i
-
Description: Enable interactive mode to set all sensitive variables
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
scope
-
Option:
--scope
-
Description: Scope for configuration, if not set use ‘default’
-
Default:
default
-
Accepts a value
config:set
Change system configuration
1
bin/magento config:set [--scope SCOPE] [--scope-code SCOPE-CODE] [-e|--lock-env] [-c|--lock-config] [-l|--lock] [--] <path> <value>
Arguments
path
-
Description: Configuration path in format section/group/field_name
-
Required
value
-
Description: Configuration value
-
Required
Options
lock
-
Option:
--lock
-
Shortcut:
-l
-
Description: Deprecated, use the –lock-env option instead.
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
scope-code
-
Option:
--scope-code
-
Description: Scope code (required only if scope is not ‘default’)
-
Requires a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
lock-config
-
Option:
--lock-config
-
Shortcut:
-c
-
Description: 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-env
-
Option:
--lock-env
-
Shortcut:
-e
-
Description: Lock value which prevents modification in the Admin (will be saved in app/etc/env.php)
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
scope
-
Option:
--scope
-
Description: Configuration scope (default, website, or store)
-
Default:
default
-
Requires a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
config:show
Shows configuration value for given path. If path is not specified, all saved values will be shown
1
bin/magento config:show [--scope [SCOPE]] [--scope-code [SCOPE-CODE]] [--] [<path>]
Arguments
path
- Description: Configuration path, for example section_id/group_id/field_id
Options
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
scope
-
Option:
--scope
-
Description: Scope for configuration, if not specified, then ‘default’ scope will be used
-
Default:
default
-
Accepts a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
scope-code
-
Option:
--scope-code
-
Description: Scope code (required only if scope is not
default
) -
Default: ``
-
Accepts a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
cron:install
Generates and installs crontab for current user
1
bin/magento cron:install [-f|--force] [-d|--non-optional]
cron:remove
Removes tasks from crontab
1
bin/magento cron:remove
cron:run
Runs jobs by schedule
1
bin/magento cron:run [--group GROUP] [--bootstrap BOOTSTRAP]
customer:hash:upgrade
Upgrade customer’s hash according to the latest algorithm
1
bin/magento customer:hash:upgrade
deploy:mode:set
Set application mode.
1
bin/magento deploy:mode:set [-s|--skip-compilation] [--] <mode>
Arguments
mode
-
Description: The application mode to set. Available options are “developer” or “production”
-
Required
Options
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
skip-compilation
-
Option:
--skip-compilation
-
Shortcut:
-s
-
Description: Skips the clearing and regeneration of static content (generated code, preprocessed CSS, and assets in pub/static/)
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
deploy:mode:show
Displays current application mode.
1
bin/magento deploy:mode:show
dev:di:info
Provides information on Dependency Injection configuration for the Command.
1
bin/magento dev:di:info <class>
Arguments
class
-
Description: Class name
-
Required
Options
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
dev:profiler:disable
Disable the profiler.
1
bin/magento dev:profiler:disable
dev:profiler:enable
Enable the profiler.
1
bin/magento dev:profiler:enable [<type>]
Arguments
type
- Description: Profiler type
Options
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
dev:query-log:disable
Disable DB query logging
1
bin/magento dev:query-log:disable
dev:query-log:enable
Enable DB query logging
1
bin/magento dev:query-log:enable [--include-all-queries [INCLUDE-ALL-QUERIES]] [--query-time-threshold [QUERY-TIME-THRESHOLD]] [--include-call-stack [INCLUDE-CALL-STACK]]
dev:source-theme:deploy
Collects and publishes source files for theme.
1
bin/magento dev:source-theme:deploy [--type TYPE] [--locale LOCALE] [--area AREA] [--theme THEME] [--] [<file>...]
Arguments
file
-
Description: Files to pre-process (file should be specified without extension)
-
Default:
css/styles-mcss/styles-l
-
Array
Options
type
-
Option:
--type
-
Description: Type of source files: [less]
-
Default:
less
-
Requires a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
theme
-
Option:
--theme
-
Description: Theme: [Vendor/theme]
-
Default:
Magento/luma
-
Requires a value
area
-
Option:
--area
-
Description: Area: [frontend|adminhtml]
-
Default:
frontend
-
Requires a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
locale
-
Option:
--locale
-
Description: Locale: [en_US]
-
Default:
en_US
-
Requires a value
dev:template-hints:disable
Disable frontend template hints. A cache flush might be required.
1
bin/magento dev:template-hints:disable
dev:template-hints:enable
Enable frontend template hints. A cache flush might be required.
1
bin/magento dev:template-hints:enable
dev:tests:run
Runs tests
1
bin/magento dev:tests:run [-c|--arguments ARGUMENTS] [--] [<type>]
Arguments
type
-
Description: Type of test to run. Available types: all, unit, integration, integration-all, static, static-all, integrity, legacy, default
-
Default:
default
Options
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
arguments
-
Option:
--arguments
-
Shortcut:
-c
-
Description: Additional arguments for PHPUnit. Example: “-c’–filter=MyTest’” (no spaces)
-
Default: ``
-
Requires a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
dev:urn-catalog:generate
Generates the catalog of URNs to *.xsd mappings for the IDE to highlight xml.
1
bin/magento dev:urn-catalog:generate [--ide IDE] [--] <path>
Arguments
path
-
Description: Path to file to output the catalog. For PhpStorm use .idea/misc.xml
-
Required
Options
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
ide
-
Option:
--ide
-
Description: Format in which catalog will be generated. Supported: [phpstorm]
-
Default:
phpstorm
-
Requires a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
dev:xml:convert
Converts XML file using XSL style sheets
1
bin/magento dev:xml:convert [-o|--overwrite] [--] <xml-file> <processor>
Arguments
processor
-
Description: Path to XSL style sheet that going to be applied to XML file
-
Required
xml-file
-
Description: Path to XML file that going to be transformed
-
Required
Options
overwrite
-
Option:
--overwrite
-
Shortcut:
-o
-
Description: Overwrite XML file
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
dotdigital:connector:automap
Auto-map data fields
1
bin/magento dotdigital:connector:automap
dotdigital:connector:enable
Add Dotdigital API credentials and enable the connector
1
bin/magento dotdigital:connector:enable [--username USERNAME] [--password PASSWORD] [--automap-datafields [AUTOMAP-DATAFIELDS]] [--enable-syncs [ENABLE-SYNCS]] [--remove-ip-restriction [REMOVE-IP-RESTRICTION]] [--enable-email-capture [ENABLE-EMAIL-CAPTURE]]
dotdigital:migrate
Migrate data into email_ tables to sync with Engagement Cloud
1
bin/magento dotdigital:migrate
dotdigital:sync
Run syncs to populate email_ tables before importing to Engagement Cloud
1
bin/magento dotdigital:sync [--from [FROM]] [--] [<sync>]
Arguments
sync
- Description: The name of the sync to run
Options
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
from
-
Option:
--from
-
Description: Specify a date/time (parsable by \DateTime) to run a sync from (if supported)
-
Accepts a value
downloadable:domains:add
Add domains to the downloadable domains whitelist
1
bin/magento downloadable:domains:add [<domains>...]
Arguments
domains
-
Description: Domains name
-
Default:
[]
-
Array
Options
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
downloadable:domains:remove
Remove domains from the downloadable domains whitelist
1
bin/magento downloadable:domains:remove [<domains>...]
Arguments
domains
-
Description: Domain names
-
Default:
[]
-
Array
Options
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
downloadable:domains:show
Display downloadable domains whitelist
1
bin/magento downloadable:domains:show
encryption:payment-data:update
Re-encrypts encrypted credit card data with latest encryption cipher.
1
bin/magento encryption:payment-data:update
i18n:collect-phrases
Discovers phrases in the codebase
1
bin/magento i18n:collect-phrases [-o|--output OUTPUT] [-m|--magento] [--] [<directory>]
Arguments
directory
- Description: Directory path to parse. Not needed if –magento flag is set
Options
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
magento
-
Option:
--magento
-
Shortcut:
-m
-
Description: 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
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
output
-
Option:
--output
-
Shortcut:
-o
-
Description: Path (including filename) to an output file. With no file specified, defaults to stdout.
-
Requires a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
i18n:pack
Saves language package
1
bin/magento i18n:pack [-m|--mode MODE] [-d|--allow-duplicates] [--] <source> <locale>
Arguments
locale
-
Description: Target locale for dictionary, for example “de_DE”
-
Required
source
-
Description: Path to source dictionary file with translations
-
Required
Options
mode
-
Option:
--mode
-
Shortcut:
-m
-
Description: Save mode for dictionary - “replace” - replace language pack by new one - “merge” - merge language packages, by default “replace”
-
Default:
replace
-
Requires a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
allow-duplicates
-
Option:
--allow-duplicates
-
Shortcut:
-d
-
Description: Use the –allow-duplicates parameter to allow saving duplicates of translate. Otherwise omit the parameter.
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
i18n:uninstall
Uninstalls language packages
1
bin/magento i18n:uninstall [-b|--backup-code] [--] <package>...
Arguments
package
-
Description: Language package name
-
Default:
[]
-
Required
-
Array
Options
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
backup-code
-
Option:
--backup-code
-
Shortcut:
-b
-
Description: Take code and configuration files backup (excluding temporary files)
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
indexer:info
Shows allowed Indexers
1
bin/magento indexer:info
indexer:reindex
Reindexes Data
1
bin/magento indexer:reindex [<index>...]
Arguments
index
-
Description: Space-separated list of index types or omit to apply to all indexes.
-
Default:
[]
-
Array
Options
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
indexer:reset
Resets indexer status to invalid
1
bin/magento indexer:reset [<index>...]
Arguments
index
-
Description: Space-separated list of index types or omit to apply to all indexes.
-
Default:
[]
-
Array
Options
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
indexer:set-dimensions-mode
Set Indexer Dimensions Mode
1
bin/magento indexer:set-dimensions-mode [<indexer> [<mode>]]
Arguments
indexer
- Description: Indexer name [catalog_product_price]
mode
- Description: Indexer dimension modes catalog_product_price none,website,customer_group,website_and_customer_group
Options
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
indexer:set-mode
Sets index mode type
1
bin/magento indexer:set-mode [<mode> [<index>...]]
Arguments
mode
-
Description: Indexer mode type [realtime schedule]
index
-
Description: Space-separated list of index types or omit to apply to all indexes.
-
Default:
[]
-
Array
Options
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
indexer:show-dimensions-mode
Shows Indexer Dimension Mode
1
bin/magento indexer:show-dimensions-mode [<indexer>...]
Arguments
indexer
-
Description: Space-separated list of index types or omit to apply to all indexes (catalog_product_price)
-
Default:
[]
-
Array
Options
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
indexer:show-mode
Shows Index Mode
1
bin/magento indexer:show-mode [<index>...]
Arguments
index
-
Description: Space-separated list of index types or omit to apply to all indexes.
-
Default:
[]
-
Array
Options
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
indexer:status
Shows status of Indexer
1
bin/magento indexer:status [<index>...]
Arguments
index
-
Description: Space-separated list of index types or omit to apply to all indexes.
-
Default:
[]
-
Array
Options
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
info:adminuri
Displays the Magento Admin URI
1
bin/magento info:adminuri
info:backups:list
Prints list of available backup files
1
bin/magento info:backups:list
info:currency:list
Displays the list of available currencies
1
bin/magento info:currency:list
info:dependencies:show-framework
Shows number of dependencies on Magento framework
1
bin/magento info:dependencies:show-framework [-o|--output OUTPUT]
info:dependencies:show-modules
Shows number of dependencies between modules
1
bin/magento info:dependencies:show-modules [-o|--output OUTPUT]
info:dependencies:show-modules-circular
Shows number of circular dependencies between modules
1
bin/magento info:dependencies:show-modules-circular [-o|--output OUTPUT]
info:language:list
Displays the list of available language locales
1
bin/magento info:language:list
info:timezone:list
Displays the list of available timezones
1
bin/magento info:timezone:list
inventory:reservation:create-compensations
Create reservations by provided compensation arguments
1
bin/magento inventory:reservation:create-compensations [-r|--raw] [--] [<compensations>...]
Arguments
compensations
-
Description: List of compensation arguments in format “
: : : " -
Default:
[]
-
Array
Options
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
raw
-
Option:
--raw
-
Shortcut:
-r
-
Description: Raw output
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
inventory:reservation:list-inconsistencies
Show all orders and products with salable quantity inconsistencies
1
bin/magento inventory:reservation:list-inconsistencies [-c|--complete-orders] [-i|--incomplete-orders] [-b|--bunch-size [BUNCH-SIZE]] [-r|--raw]
inventory-geonames:import
Download and import geo names for source selection algorithm
1
bin/magento inventory-geonames:import <countries>...
Arguments
countries
-
Description: List of country codes to import
-
Default:
[]
-
Required
-
Array
Options
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
maintenance:allow-ips
Sets maintenance mode exempt IPs
1
bin/magento maintenance:allow-ips [--none] [--add] [--magento-init-params MAGENTO-INIT-PARAMS] [--] [<ip>...]
Arguments
ip
-
Description: Allowed IP addresses
-
Default:
[]
-
Array
Options
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
none
-
Option:
--none
-
Description: Clear allowed IP addresses
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
add
-
Option:
--add
-
Description: Add the IP address to existing list
-
Default:
false
-
Does not accept a value
magento-init-params
-
Option:
--magento-init-params
-
Description: 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
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
maintenance:disable
Disables maintenance mode
1
bin/magento maintenance:disable [--ip IP] [--magento-init-params MAGENTO-INIT-PARAMS]
maintenance:enable
Enables maintenance mode
1
bin/magento maintenance:enable [--ip IP] [--magento-init-params MAGENTO-INIT-PARAMS]
maintenance:status
Displays maintenance mode status
1
bin/magento maintenance:status [--magento-init-params MAGENTO-INIT-PARAMS]
module:config:status
Checks the modules configuration in the ‘app/etc/config.php’ file and reports if they are up to date or not
1
bin/magento module:config:status
module:disable
Disables specified modules
1
bin/magento module:disable [-f|--force] [--all] [-c|--clear-static-content] [--magento-init-params MAGENTO-INIT-PARAMS] [--] [<module>...]
Arguments
module
-
Description: Name of the module
-
Default:
[]
-
Array
Options
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
magento-init-params
-
Option:
--magento-init-params
-
Description: 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
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
clear-static-content
-
Option:
--clear-static-content
-
Shortcut:
-c
-
Description: Clear generated static view files. Necessary, if the module(s) have static view files
-
Default:
false
-
Does not accept a value
force
-
Option:
--force
-
Shortcut:
-f
-
Description: Bypass dependencies check
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
all
-
Option:
--all
-
Description: Disable all modules
-
Default:
false
-
Does not accept a value
module:enable
Enables specified modules
1
bin/magento module:enable [-f|--force] [--all] [-c|--clear-static-content] [--magento-init-params MAGENTO-INIT-PARAMS] [--] [<module>...]
Arguments
module
-
Description: Name of the module
-
Default:
[]
-
Array
Options
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
magento-init-params
-
Option:
--magento-init-params
-
Description: 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
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
all
-
Option:
--all
-
Description: Enable all modules
-
Default:
false
-
Does not accept a value
force
-
Option:
--force
-
Shortcut:
-f
-
Description: Bypass dependencies check
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
clear-static-content
-
Option:
--clear-static-content
-
Shortcut:
-c
-
Description: Clear generated static view files. Necessary, if the module(s) have static view files
-
Default:
false
-
Does not accept a value
module:status
Displays status of modules
1
bin/magento module:status [--enabled] [--disabled] [--magento-init-params MAGENTO-INIT-PARAMS] [--] [<module>]
Arguments
module
- Description: Optional module name
Options
enabled
-
Option:
--enabled
-
Description: Print only enabled modules
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
disabled
-
Option:
--disabled
-
Description: Print only disabled modules
-
Default:
false
-
Does not accept a value
magento-init-params
-
Option:
--magento-init-params
-
Description: 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
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
module:uninstall
Uninstalls modules installed by composer
1
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>...
Arguments
module
-
Description: Name of the module
-
Default:
[]
-
Required
-
Array
Options
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
backup-media
-
Option:
--backup-media
-
Description: Take media backup
-
Default:
false
-
Does not accept a value
backup-db
-
Option:
--backup-db
-
Description: Take complete database backup
-
Default:
false
-
Does not accept a value
magento-init-params
-
Option:
--magento-init-params
-
Description: 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
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
remove-data
-
Option:
--remove-data
-
Shortcut:
-r
-
Description: Remove data installed by module(s)
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
backup-code
-
Option:
--backup-code
-
Description: Take code and configuration files backup (excluding temporary files)
-
Default:
false
-
Does not accept a value
non-composer
-
Option:
--non-composer
-
Description: All modules, that will be past here will be non composer based
-
Default:
false
-
Does not accept a value
clear-static-content
-
Option:
--clear-static-content
-
Shortcut:
-c
-
Description: Clear generated static view files. Necessary, if the module(s) have static view files
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
msp:security:recaptcha:disable
Disable backend reCaptcha
1
bin/magento msp:security:recaptcha:disable
msp:security:tfa:disable
Globally disable two factor auth
1
bin/magento msp:security:tfa:disable
msp:security:tfa:providers
List all available providers
1
bin/magento msp:security:tfa:providers
msp:security:tfa:reset
Reset configuration for one user
1
bin/magento msp:security:tfa:reset <user> <provider>
Arguments
provider
-
Description: Provider code
-
Required
user
-
Description: Username
-
Required
Options
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
newrelic:create:deploy-marker
Check the deploy queue for entries and create an appropriate deploy marker.
1
bin/magento newrelic:create:deploy-marker <message> <change_log> [<user>]
Arguments
change_log
-
Description: Change Log?
-
Required
message
-
Description: Deploy Message?
-
Required
user
- Description: Deployment User
Options
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
queue:consumers:list
List of MessageQueue consumers
1
bin/magento queue:consumers:list
queue:consumers:start
Start MessageQueue consumer
1
bin/magento queue:consumers:start [--max-messages MAX-MESSAGES] [--batch-size BATCH-SIZE] [--area-code AREA-CODE] [--single-thread] [--pid-file-path PID-FILE-PATH] [--] <consumer>
Arguments
consumer
-
Description: The name of the consumer to be started.
-
Required
Options
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
area-code
-
Option:
--area-code
-
Description: The preferred area (global, adminhtml, etc…) default is global.
-
Requires a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
max-messages
-
Option:
--max-messages
-
Description: 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
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
single-thread
-
Option:
--single-thread
-
Description: This option prevents running multiple copies of one consumer simultaneously.
-
Default:
false
-
Does not accept a value
batch-size
-
Option:
--batch-size
-
Description: The number of messages per batch. Applicable for the batch consumer only.
-
Requires a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
pid-file-path
-
Option:
--pid-file-path
-
Description: The file path for saving PID (This option is deprecated, use –single-thread instead)
-
Requires a value
sampledata:deploy
Deploy sample data modules for composer-based Magento installations
1
bin/magento sampledata:deploy [--no-update]
sampledata:remove
Remove all sample data packages from composer.json
1
bin/magento sampledata:remove [--no-update]
sampledata:reset
Reset all sample data modules for re-installation
1
bin/magento sampledata:reset
setup:backup
Takes backup of Magento Application code base, media and database
1
bin/magento setup:backup [--code] [--media] [--db] [--magento-init-params MAGENTO-INIT-PARAMS]
setup:config:set
Creates or modifies the deployment configuration
1
bin/magento setup:config:set [--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] [--enable-debug-logging ENABLE-DEBUG-LOGGING] [--enable-syslog-logging ENABLE-SYSLOG-LOGGING] [--backend-frontname BACKEND-FRONTNAME] [--consumers-wait-for-messages CONSUMERS-WAIT-FOR-MESSAGES] [--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-retires SESSION-SAVE-REDIS-SENTINEL-CONNECT-RETIRES] [--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-id-prefix CACHE-ID-PREFIX] [--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] [--magento-init-params MAGENTO-INIT-PARAMS]
setup:cron:run
Runs cron job scheduled for setup application
1
bin/magento setup:cron:run [--magento-init-params MAGENTO-INIT-PARAMS]
setup:db-data:upgrade
Installs and upgrades data in the DB
1
bin/magento setup:db-data:upgrade [--magento-init-params MAGENTO-INIT-PARAMS]
setup:db-declaration:generate-patch
Generate patch and put it in specific folder.
1
bin/magento setup:db-declaration:generate-patch [--revertable [REVERTABLE]] [--type [TYPE]] [--] <module> <patch>
Arguments
patch
-
Description: Patch name
-
Required
module
-
Description: Module name
-
Required
Options
revertable
-
Option:
--revertable
-
Description: Check whether patch is revertable or not.
-
Default:
false
-
Accepts a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
type
-
Option:
--type
-
Description: Find out what type of patch should be generated. Available values:
data
,schema
. -
Default:
data
-
Accepts a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
setup:db-declaration:generate-whitelist
Generate whitelist of tables and columns that are allowed to be edited by declaration installer
1
bin/magento setup:db-declaration:generate-whitelist [--module-name [MODULE-NAME]]
setup:db-schema:upgrade
Installs and upgrades the DB schema
1
bin/magento setup:db-schema:upgrade [--convert-old-scripts [CONVERT-OLD-SCRIPTS]] [--magento-init-params MAGENTO-INIT-PARAMS]
setup:db:status
Checks if DB schema or data requires upgrade
1
bin/magento setup:db:status [--magento-init-params MAGENTO-INIT-PARAMS]
setup:di:compile
Generates DI configuration and all missing classes that can be auto-generated
1
bin/magento setup:di:compile
setup:install
Installs the Magento application
1
bin/magento setup:install [--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] [--enable-debug-logging ENABLE-DEBUG-LOGGING] [--enable-syslog-logging ENABLE-SYSLOG-LOGGING] [--backend-frontname BACKEND-FRONTNAME] [--consumers-wait-for-messages CONSUMERS-WAIT-FOR-MESSAGES] [--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-retires SESSION-SAVE-REDIS-SENTINEL-CONNECT-RETIRES] [--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-id-prefix CACHE-ID-PREFIX] [--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] [--base-url BASE-URL] [--language LANGUAGE] [--timezone TIMEZONE] [--currency CURRENCY] [--use-rewrites USE-REWRITES] [--use-secure USE-SECURE] [--base-url-secure BASE-URL-SECURE] [--use-secure-admin USE-SECURE-ADMIN] [--admin-use-security-key ADMIN-USE-SECURITY-KEY] [--admin-user [ADMIN-USER]] [--admin-password [ADMIN-PASSWORD]] [--admin-email [ADMIN-EMAIL]] [--admin-firstname [ADMIN-FIRSTNAME]] [--admin-lastname [ADMIN-LASTNAME]] [--cleanup-database] [--sales-order-increment-prefix SALES-ORDER-INCREMENT-PREFIX] [--use-sample-data] [--enable-modules [ENABLE-MODULES]] [--disable-modules [DISABLE-MODULES]] [--convert-old-scripts [CONVERT-OLD-SCRIPTS]] [-i|--interactive] [--safe-mode [SAFE-MODE]] [--data-restore [DATA-RESTORE]] [--dry-run [DRY-RUN]] [--magento-init-params MAGENTO-INIT-PARAMS]
setup:performance:generate-fixtures
Generates fixtures
1
bin/magento setup:performance:generate-fixtures [-s|--skip-reindex] [--] <profile>
Arguments
profile
-
Description: Path to profile configuration file
-
Required
Options
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
skip-reindex
-
Option:
--skip-reindex
-
Shortcut:
-s
-
Description: Skip reindex
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
setup:rollback
Rolls back Magento Application codebase, media and database
1
bin/magento setup:rollback [-c|--code-file CODE-FILE] [-m|--media-file MEDIA-FILE] [-d|--db-file DB-FILE] [--magento-init-params MAGENTO-INIT-PARAMS]
setup:static-content:deploy
Deploys static view files
1
bin/magento setup:static-content:deploy [-f|--force] [-s|--strategy [STRATEGY]] [-a|--area [AREA]] [--exclude-area [EXCLUDE-AREA]] [-t|--theme [THEME]] [--exclude-theme [EXCLUDE-THEME]] [-l|--language [LANGUAGE]] [--exclude-language [EXCLUDE-LANGUAGE]] [-j|--jobs [JOBS]] [--max-execution-time [MAX-EXECUTION-TIME]] [--symlink-locale] [--content-version CONTENT-VERSION] [--refresh-content-version-only] [--no-javascript] [--no-js-bundle] [--no-css] [--no-less] [--no-images] [--no-fonts] [--no-html] [--no-misc] [--no-html-minify] [--] [<languages>...]
Arguments
languages
-
Description: Space-separated list of ISO-639 language codes for which to output static view files.
-
Default:
[]
-
Array
Options
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
strategy
-
Option:
--strategy
-
Shortcut:
-s
-
Description: Deploy files using specified strategy.
-
Default:
quick
-
Accepts a value
no-html-minify
-
Option:
--no-html-minify
-
Description: Do not minify HTML files.
-
Default:
false
-
Does not accept a value
theme
-
Option:
--theme
-
Shortcut:
-t
-
Description: Generate static view files for only the specified themes.
-
Default:
all
-
Accepts multiple values
force
-
Option:
--force
-
Shortcut:
-f
-
Description: Deploy files in any mode.
-
Default:
false
-
Does not accept a value
max-execution-time
-
Option:
--max-execution-time
-
Description: The maximum expected execution time of deployment static process (in seconds).
-
Default:
400
-
Accepts a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
area
-
Option:
--area
-
Shortcut:
-a
-
Description: Generate files only for the specified areas.
-
Default:
all
-
Accepts multiple values
refresh-content-version-only
-
Option:
--refresh-content-version-only
-
Description: Refreshing the version of static content only can be used to refresh static content in browser cache and CDN cache.
-
Default:
false
-
Does not accept a value
exclude-language
-
Option:
--exclude-language
-
Description: Do not generate files for the specified languages.
-
Default:
none
-
Accepts multiple values
jobs
-
Option:
--jobs
-
Shortcut:
-j
-
Description: Enable parallel processing using the specified number of jobs.
-
Default:
0
-
Accepts a value
no-images
-
Option:
--no-images
-
Description: Do not deploy images.
-
Default:
false
-
Does not accept a value
content-version
-
Option:
--content-version
-
Description: Custom version of static content can be used if running deployment on multiple nodes to ensure that static content version is identical and caching works properly.
-
Requires a value
language
-
Option:
--language
-
Shortcut:
-l
-
Description: Generate files only for the specified languages.
-
Default:
all
-
Accepts multiple values
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
exclude-area
-
Option:
--exclude-area
-
Description: Do not generate files for the specified areas.
-
Default:
none
-
Accepts multiple values
no-js-bundle
-
Option:
--no-js-bundle
-
Description: Do not deploy JavaScript bundle files.
-
Default:
false
-
Does not accept a value
no-less
-
Option:
--no-less
-
Description: Do not deploy LESS files.
-
Default:
false
-
Does not accept a value
no-css
-
Option:
--no-css
-
Description: Do not deploy CSS files.
-
Default:
false
-
Does not accept a value
no-misc
-
Option:
--no-misc
-
Description: Do not deploy files of other types (.md, .jbf, .csv, etc.).
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
symlink-locale
-
Option:
--symlink-locale
-
Description: Create symlinks for the files of those locales, which are passed for deployment, but have no customizations.
-
Default:
false
-
Does not accept a value
no-html
-
Option:
--no-html
-
Description: Do not deploy HTML files.
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
no-javascript
-
Option:
--no-javascript
-
Description: Do not deploy JavaScript files.
-
Default:
false
-
Does not accept a value
exclude-theme
-
Option:
--exclude-theme
-
Description: Do not generate files for the specified themes.
-
Default:
none
-
Accepts multiple values
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
no-fonts
-
Option:
--no-fonts
-
Description: Do not deploy font files.
-
Default:
false
-
Does not accept a value
setup:store-config:set
Installs the store configuration. Deprecated since 2.2.0. Use config:set instead
1
bin/magento setup:store-config:set [--base-url BASE-URL] [--language LANGUAGE] [--timezone TIMEZONE] [--currency CURRENCY] [--use-rewrites USE-REWRITES] [--use-secure USE-SECURE] [--base-url-secure BASE-URL-SECURE] [--use-secure-admin USE-SECURE-ADMIN] [--admin-use-security-key ADMIN-USE-SECURITY-KEY] [--magento-init-params MAGENTO-INIT-PARAMS]
setup:uninstall
Uninstalls the Magento application
1
bin/magento setup:uninstall [--magento-init-params MAGENTO-INIT-PARAMS]
setup:upgrade
Upgrades the Magento application, DB data, and schema
1
bin/magento setup:upgrade [--keep-generated] [--convert-old-scripts [CONVERT-OLD-SCRIPTS]] [--safe-mode [SAFE-MODE]] [--data-restore [DATA-RESTORE]] [--dry-run [DRY-RUN]] [--magento-init-params MAGENTO-INIT-PARAMS]
store:list
Displays the list of stores
1
bin/magento store:list
store:website:list
Displays the list of websites
1
bin/magento store:website:list
theme:uninstall
Uninstalls theme
1
bin/magento theme:uninstall [--backup-code] [-c|--clear-static-content] [--] <theme>...
Arguments
theme
-
Description: Path of the theme. Theme path should be specified as full path which is area/vendor/name. For example, frontend/Magento/blank
-
Default:
[]
-
Required
-
Array
Options
backup-code
-
Option:
--backup-code
-
Description: Take code backup (excluding temporary files)
-
Default:
false
-
Does not accept a value
version
-
Option:
--version
-
Shortcut:
-V
-
Description: Display this application version
-
Default:
false
-
Does not accept a value
clear-static-content
-
Option:
--clear-static-content
-
Shortcut:
-c
-
Description: Clear generated static view files.
-
Default:
false
-
Does not accept a value
verbose
-
Option:
--verbose
-
Shortcut:
-v|-vv|-vvv
-
Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
-
Default:
false
-
Does not accept a value
no-ansi
-
Option:
--no-ansi
-
Description: Disable ANSI output
-
Default:
false
-
Does not accept a value
no-interaction
-
Option:
--no-interaction
-
Shortcut:
-n
-
Description: Do not ask any interactive question
-
Default:
false
-
Does not accept a value
quiet
-
Option:
--quiet
-
Shortcut:
-q
-
Description: Do not output any message
-
Default:
false
-
Does not accept a value
ansi
-
Option:
--ansi
-
Description: Force ANSI output
-
Default:
false
-
Does not accept a value
help
-
Option:
--help
-
Shortcut:
-h
-
Description: Display this help message
-
Default:
false
-
Does not accept a value
varnish:vcl:generate
Generates Varnish VCL and echos it to the command line
1
bin/magento varnish:vcl:generate [--access-list ACCESS-LIST] [--backend-host BACKEND-HOST] [--backend-port BACKEND-PORT] [--export-version EXPORT-VERSION] [--grace-period GRACE-PERIOD] [--output-file OUTPUT-FILE]
yotpo:reset
Reset Yotpo sync flags &/or configurations
1
bin/magento yotpo:reset [-e|--entity [ENTITY]]
yotpo:sync
Sync Yotpo manually (reviews module)
1
bin/magento yotpo:sync [-e|--entity ENTITY] [-l|--limit [LIMIT]]
yotpo:update-metadata
Manually send platform metadata to Yotpo
1
bin/magento yotpo:update-metadata