Magento CLI

This reference contains 65 commands available through the bin/magento command-line tool. The initial list is auto generated using bin/magento list command at the Magento Open Source edition.

`help`

Displays help for a command

bin/magento help [--xml] [--format FORMAT] [--raw] [--] [<command_name>]

Arguments

`command_name`

Description: The command name
Default: help

Options

xml

Option: --xml
Description: To output help as XML
Default: false
Does not accept a value

format

Option: --format
Description: The output format (txt, xml, json, or md)
Default: txt
Requires a value

raw

Option: --raw
Description: To output raw command help
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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`list`

Lists commands

bin/magento list [--xml] [--raw] [--format FORMAT] [--] [<namespace>]

Arguments

`namespace`

Description: The namespace name

Options

xml

Option: --xml
Description: To output list as XML
Default: false
Does not accept a value

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

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

bin/magento admin:user:unlock <username>

Arguments

`username`

Description: The admin username to unlock
Required

Options

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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`app:config:dump`

Create dump of application

bin/magento app:config:dump

`cache:clean`

Cleans cache type(s)

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

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

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

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

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

`cache:disable`

Disables cache type(s)

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

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

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

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

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

`cache:enable`

Enables cache type(s)

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

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

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

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

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

`cache:flush`

Flushes cache storage used by cache type(s)

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

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

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

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

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

`cache:status`

Checks cache status

bin/magento cache:status [--bootstrap BOOTSTRAP]

`catalog:images:resize`

Creates resized product images

bin/magento catalog:images:resize

`catalog:product:attributes:cleanup`

Removes unused product attributes.

bin/magento catalog:product:attributes:cleanup

`cron:install`

Generates and installs crontab for current user

bin/magento cron:install [-f|--force]

`cron:remove`

Removes tasks from crontab

bin/magento cron:remove

`cron:run`

Runs jobs by schedule

bin/magento cron:run [--group GROUP] [--bootstrap BOOTSTRAP]

`customer:hash:upgrade`

Upgrade customer’s hash according to the latest algorithm

bin/magento customer:hash:upgrade

`deploy:mode:set`

Set application mode.

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

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

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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`deploy:mode:show`

Displays current application mode.

bin/magento deploy:mode:show

`dev:source-theme:deploy`

Collects and publishes source files for theme.

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

locale

Option: --locale
Description: Locale: [en_US]
Default: en_US
Requires a value

area

Option: --area
Description: Area: [frontend adminhtml]
Default: frontend
Requires a value

theme

Option: --theme
Description: Theme: [Vendor/theme]
Default: Magento/luma
Requires 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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`dev:tests:run`

Runs tests

bin/magento dev:tests:run [<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

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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`dev:urn-catalog:generate`

Generates the catalog of URNs to *.xsd mappings for the IDE to highlight xml.

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

ide

Option: --ide
Description: Format in which catalog will be generated. Supported: [phpstorm]
Default: phpstorm
Requires 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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`dev:xml:convert`

Converts XML file using XSL style sheets

bin/magento dev:xml:convert [-o|--overwrite] [--] <xml-file> <processor>

Arguments

`xml-file`

Description: Path to XML file that going to be transformed
Required

`processor`

Description: Path to XSL style sheet that going to be applied to XML file
Required

Options

overwrite

Option: --overwrite
Shortcut: -o
Description: Overwrite XML file
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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`i18n:collect-phrases`

Discovers phrases in the codebase

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

output

Option: --output
Shortcut: -o
Description: Path (including filename) to an output file. With no file specified, defaults to stdout.
Requires 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

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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`i18n:pack`

Saves language package

bin/magento i18n:pack [-m|--mode MODE] [-d|--allow-duplicates] [--] <source> <locale>

Arguments

`source`

Description: Path to source dictionary file with translations
Required

`locale`

Description: Target locale for dictionary, for example “de_DE”
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

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

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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`i18n:uninstall`

Uninstalls language packages

bin/magento i18n:uninstall [-b|--backup-code] [--] <package> (<package>)...

Arguments

`package`

Description: Language package name
Default: []
Required
Array

Options

backup-code

Option: --backup-code
Shortcut: -b
Description: Take code and configuration files backup (excluding temporary 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

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

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

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

`indexer:info`

Shows allowed Indexers

bin/magento indexer:info

`indexer:reindex`

Reindexes Data

bin/magento indexer:reindex [<index>]...

Arguments

`index`

Description: Space-separated list of index types or omit to apply to all indexes.
Default: []
Array

Options

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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`indexer:reset`

Resets indexer status to invalid

bin/magento indexer:reset [<index>]...

Arguments

`index`

Description: Space-separated list of index types or omit to apply to all indexes.
Default: []
Array

Options

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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`indexer:set-mode`

Sets index mode type

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

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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`indexer:show-mode`

Shows Index Mode

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

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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`indexer:status`

Shows status of Indexer

bin/magento indexer:status [<index>]...

Arguments

`index`

Description: Space-separated list of index types or omit to apply to all indexes.
Default: []
Array

Options

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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`info:adminuri`

Displays the Magento Admin URI

bin/magento info:adminuri

`info:backups:list`

Prints list of available backup files

bin/magento info:backups:list

`info:currency:list`

Displays the list of available currencies

bin/magento info:currency:list

`info:dependencies:show-framework`

Shows number of dependencies on Magento framework

bin/magento info:dependencies:show-framework [-o|--output OUTPUT]

`info:dependencies:show-modules`

Shows number of dependencies between modules

bin/magento info:dependencies:show-modules [-o|--output OUTPUT]

`info:dependencies:show-modules-circular`

Shows number of circular dependencies between modules

bin/magento info:dependencies:show-modules-circular [-o|--output OUTPUT]

`info:language:list`

Displays the list of available language locales

bin/magento info:language:list

`info:timezone:list`

Displays the list of available timezones

bin/magento info:timezone:list

`maintenance:allow-ips`

Sets maintenance mode exempt IPs

bin/magento maintenance:allow-ips [--none] [--magento-init-params MAGENTO-INIT-PARAMS] [--] [<ip>]...

Arguments

`ip`

Description: Allowed IP addresses
Default: []
Array

Options

none

Option: --none
Description: Clear allowed IP addresses
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

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

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

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

`maintenance:disable`

Disables maintenance mode

bin/magento maintenance:disable [--ip IP] [--magento-init-params MAGENTO-INIT-PARAMS]

`maintenance:enable`

Enables maintenance mode

bin/magento maintenance:enable [--ip IP] [--magento-init-params MAGENTO-INIT-PARAMS]

`maintenance:status`

Displays maintenance mode status

bin/magento maintenance:status [--magento-init-params MAGENTO-INIT-PARAMS]

`module:disable`

Disables specified modules

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

force

Option: --force
Shortcut: -f
Description: Bypass dependencies check
Default: false
Does not accept a value

all

Option: --all
Description: Disable all modules
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

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

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

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

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

`module:enable`

Enables specified modules

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

force

Option: --force
Shortcut: -f
Description: Bypass dependencies check
Default: false
Does not accept a value

all

Option: --all
Description: Enable all modules
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

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

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

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

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

`module:status`

Displays status of modules

bin/magento module:status [--magento-init-params MAGENTO-INIT-PARAMS]

`module:uninstall`

Uninstalls modules installed by composer

bin/magento module:uninstall [-r|--remove-data] [--backup-code] [--backup-media] [--backup-db] [-c|--clear-static-content] [--magento-init-params MAGENTO-INIT-PARAMS] [--] <module> (<module>)...

Arguments

`module`

Description: Name of the module
Default: []
Required
Array

Options

remove-data

Option: --remove-data
Shortcut: -r
Description: Remove data installed by module(s)
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

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

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

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

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

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

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

`sampledata:deploy`

Deploy sample data modules

bin/magento sampledata:deploy

`sampledata:remove`

Remove all sample data packages from composer.json

bin/magento sampledata:remove

`sampledata:reset`

Reset all sample data modules for re-installation

bin/magento sampledata:reset

`setup:backup`

Takes backup of Magento Application code base, media and database

bin/magento setup:backup [--code] [--media] [--db] [--magento-init-params MAGENTO-INIT-PARAMS]

`setup:config:set`

Creates or modifies the deployment configuration

bin/magento setup:config:set [--backend-frontname BACKEND-FRONTNAME] [--key KEY] [--session-save SESSION-SAVE] [--definition-format DEFINITION-FORMAT] [--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] [--magento-init-params MAGENTO-INIT-PARAMS]

`setup:cron:run`

Runs cron job scheduled for setup application

bin/magento setup:cron:run [--magento-init-params MAGENTO-INIT-PARAMS]

`setup:db-data:upgrade`

Installs and upgrades data in the DB

bin/magento setup:db-data:upgrade [--magento-init-params MAGENTO-INIT-PARAMS]

`setup:db-schema:upgrade`

Installs and upgrades the DB schema

bin/magento setup:db-schema:upgrade [--magento-init-params MAGENTO-INIT-PARAMS]

`setup:db:status`

Checks if DB schema or data requires upgrade

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

bin/magento setup:di:compile

`setup:install`

Installs the Magento application

bin/magento setup:install [--backend-frontname BACKEND-FRONTNAME] [--key KEY] [--session-save SESSION-SAVE] [--definition-format DEFINITION-FORMAT] [--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] [--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] [--magento-init-params MAGENTO-INIT-PARAMS]

`setup:performance:generate-fixtures`

Generates fixtures

bin/magento setup:performance:generate-fixtures [-s|--skip-reindex] [--] <profile>

Arguments

`profile`

Description: Path to profile configuration file
Required

Options

skip-reindex

Option: --skip-reindex
Shortcut: -s
Description: Skip reindex
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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`setup:rollback`

Rolls back Magento Application codebase, media and database

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

bin/magento setup:static-content:deploy [-d|--dry-run] [--no-javascript] [--no-css] [--no-less] [--no-images] [--no-fonts] [--no-html] [--no-misc] [--no-html-minify] [-t|--theme [THEME]] [--exclude-theme [EXCLUDE-THEME]] [-l|--language [LANGUAGE]] [--exclude-language [EXCLUDE-LANGUAGE]] [-a|--area [AREA]] [--exclude-area [EXCLUDE-AREA]] [-j|--jobs [JOBS]] [--symlink-locale] [--] [<languages>]...

Arguments

`languages`

Description: Space-separated list of ISO-636 language codes for which to output static view files.
Default: []
Array

Options

dry-run

Option: --dry-run
Shortcut: -d
Description: If specified, then no files will be actually deployed.
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

no-css

Option: --no-css
Description: Do not deploy CSS 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-images

Option: --no-images
Description: Do not deploy images.
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

no-html

Option: --no-html
Description: Do not deploy HTML files.
Default: false
Does not accept a value

no-misc

Option: --no-misc
Description: Do not deploy other types of files (.md, .jbf, .csv, etc…).
Default: false
Does not accept 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

exclude-theme

Option: --exclude-theme
Description: Do not generate files for the specified themes.
Default: none
Accepts multiple values

language

Option: --language
Shortcut: -l
Description: Generate files only for the specified languages.
Default: all
Accepts multiple values

exclude-language

Option: --exclude-language
Description: Do not generate files for the specified languages.
Default: none
Accepts multiple values

area

Option: --area
Shortcut: -a
Description: Generate files only for the specified areas.
Default: all
Accepts multiple values

exclude-area

Option: --exclude-area
Description: Do not generate files for the specified areas.
Default: none
Accepts multiple values

jobs

Option: --jobs
Shortcut: -j
Description: Enable parallel processing using the specified number of jobs.
Default: 4
Accepts 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

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

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

ansi

Option: --ansi
Description: Force ANSI output
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

`setup:store-config:set`

Installs the store configuration

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

bin/magento setup:uninstall [--magento-init-params MAGENTO-INIT-PARAMS]

`setup:upgrade`

Upgrades the Magento application, DB data, and schema

bin/magento setup:upgrade [--keep-generated] [--magento-init-params MAGENTO-INIT-PARAMS]

`theme:uninstall`

Uninstalls theme

bin/magento theme:uninstall [--backup-code] [-c|--clear-static-content] [--] <theme> (<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

clear-static-content

Option: --clear-static-content
Shortcut: -c
Description: Clear generated static view 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

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

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

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