bin/magento (Commerce)

Version: 2.3.7

This reference contains 114 commands available through the bin/magento command-line tool. The initial list is auto generated using the bin/magento list command at the Adobe Commerce 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.

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

Display help for a command

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

command_name

The command name

• Default: help

--format

The output format (txt, xml, json, or md)

• Default: txt

• Requires a value

--raw

To output raw command help

• Default: false

• Does not accept a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

list

List commands

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

namespace

The namespace name

--raw

To output raw command list

• Default: false

• Does not accept a value

--format

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

(Required) Admin user

• Requires a value

--admin-password

(Required) Admin password

• Requires a value

--admin-email

(Required) Admin email

• Requires a value

--admin-firstname

(Required) Admin first name

• Requires a value

--admin-lastname

(Required) Admin last name

• Requires a value

--magento-init-params

Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

admin:user:unlock

Unlock Admin Account

1
bin/magento admin:user:unlock <username>

username

The admin username to unlock

• Required

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

app:config:dump

Create dump of application

1
bin/magento app:config:dump [<config-types>...]

config-types

Space-separated list of config types or omit to dump all [scopes, themes, system, i18n]

• Default: []

• Array

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• 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

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

app:config:status

Checks if config propagation requires update

1
bin/magento app:config:status

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

cache:clean

Cleans cache type(s)

1
bin/magento cache:clean [--bootstrap BOOTSTRAP] [--] [<types>...]

types

Space-separated list of cache types or omit to apply to all cache types.

• Default: []

• Array

--bootstrap

add or override parameters of the bootstrap

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

cache:disable

Disables cache type(s)

1
bin/magento cache:disable [--bootstrap BOOTSTRAP] [--] [<types>...]

types

Space-separated list of cache types or omit to apply to all cache types.

• Default: []

• Array

--bootstrap

add or override parameters of the bootstrap

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

cache:enable

Enables cache type(s)

1
bin/magento cache:enable [--bootstrap BOOTSTRAP] [--] [<types>...]

types

Space-separated list of cache types or omit to apply to all cache types.

• Default: []

• Array

--bootstrap

add or override parameters of the bootstrap

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• 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>...]

types

Space-separated list of cache types or omit to apply to all cache types.

• Default: []

• Array

--bootstrap

add or override parameters of the bootstrap

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

cache:status

Checks cache status

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

--bootstrap

add or override parameters of the bootstrap

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

catalog:images:resize

Creates resized product images

1
bin/magento catalog:images:resize

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

catalog:product:attributes:cleanup

Removes unused product attributes.

1
bin/magento catalog:product:attributes:cleanup

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

cms:wysiwyg:restrict

Set whether to enforce user HTML content validation or show a warning instead

1
bin/magento cms:wysiwyg:restrict <restrict>

restrict

y\n

• Required

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

config:sensitive:set

Set sensitive configuration values

1
bin/magento config:sensitive:set [-i|--interactive] [--scope [SCOPE]] [--scope-code [SCOPE-CODE]] [--] [<path> [<value>]]

path

Configuration path for example group/section/field_name

value

Configuration value

--interactive, -i

Enable interactive mode to set all sensitive variables

• Default: false

• Does not accept a value

--scope

Scope for configuration, if not set use ‘default’

• Default: default

• Accepts a value

--scope-code

Scope code for configuration, empty string by default

• Default: ``

• Accepts a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept 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>

path

Configuration path in format section/group/field_name

• Required

value

Configuration value

• Required

--scope

Configuration scope (default, website, or store)

• Default: default

• Requires a value

--scope-code

Scope code (required only if scope is not ‘default’)

• Requires a value

--lock-env, -e

Lock value which prevents modification in the Admin (will be saved in app/etc/env.php)

• Default: false

• Does not accept a value

--lock-config, -c

Lock and share value with other installations, prevents modification in the Admin (will be saved in app/etc/config.php)

• Default: false

• Does not accept a value

--lock, -l

Deprecated, use the –lock-env option instead.

• Default: false

• Does not accept a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

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>]

path

Configuration path, for example section_id/group_id/field_id

--scope

Scope for configuration, if not specified, then ‘default’ scope will be used

• Default: default

• Accepts a value

--scope-code

Scope code (required only if scope is not default)

• Default: ``

• Accepts a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• 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]

--force, -f

Force install tasks

• Default: false

• Does not accept a value

--non-optional, -d

Install only the non-optional (default) tasks

• Default: false

• Does not accept a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

cron:remove

Removes tasks from crontab

1
bin/magento cron:remove

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

cron:run

Runs jobs by schedule

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

--group

Run jobs only from specified group

• Requires a value

--bootstrap

Add or override parameters of the bootstrap

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

customer:hash:upgrade

Upgrade customer’s hash according to the latest algorithm

1
bin/magento customer:hash:upgrade

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

deploy:mode:set

Set application mode.

1
bin/magento deploy:mode:set [-s|--skip-compilation] [--] <mode>

mode

The application mode to set. Available options are “developer” or “production”

• Required

--skip-compilation, -s

Skips the clearing and regeneration of static content (generated code, preprocessed CSS, and assets in pub/static/)

• Default: false

• Does not accept a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

deploy:mode:show

Displays current application mode.

1
bin/magento deploy:mode:show

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

dev:di:info

Provides information on Dependency Injection configuration for the Command.

1
bin/magento dev:di:info <class>

class

Class name

• Required

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

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

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

dev:profiler:enable

Enable the profiler.

1
bin/magento dev:profiler:enable [<type>]

type

Profiler type

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

dev:query-log:disable

Disable DB query logging

1
bin/magento dev:query-log:disable

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

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]]

--include-all-queries

Log all queries. [true|false]

• Default: true

• Accepts a value

--query-time-threshold

Query time thresholds.

• Default: 0.001

• Accepts a value

--include-call-stack

Include call stack. [true|false]

• Default: true

• Accepts a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

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>...]

file

Files to pre-process (file should be specified without extension)

• Default: css/styles-mcss/styles-l

• Array

--type

Type of source files: [less]

• Default: less

• Requires a value

--locale

Locale: [en_US]

• Default: en_US

• Requires a value

--area

Area: [frontend|adminhtml]

• Default: frontend

• Requires a value

--theme

Theme: [Vendor/theme]

• Default: Magento/luma

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

dev:template-hints:disable

Disable frontend template hints. A cache flush might be required.

1
bin/magento dev:template-hints:disable

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

dev:template-hints:enable

Enable frontend template hints. A cache flush might be required.

1
bin/magento dev:template-hints:enable

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

dev:tests:run

Runs tests

1
bin/magento dev:tests:run [-c|--arguments ARGUMENTS] [--] [<type>]

type

Type of test to run. Available types: all, unit, integration, integration-all, static, static-all, integrity, legacy, default

• Default: default

--arguments, -c

Additional arguments for PHPUnit. Example: “-c’–filter=MyTest’” (no spaces)

• Default: ``

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

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>

path

Path to file to output the catalog. For PhpStorm use .idea/misc.xml

• Required

--ide

Format in which catalog will be generated. Supported: [phpstorm]

• Default: phpstorm

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• 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>

xml-file

Path to XML file that going to be transformed

• Required

processor

Path to XSL style sheet that going to be applied to XML file

• Required

--overwrite, -o

Overwrite XML file

• Default: false

• Does not accept a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

dotdigital:connector:automap

Auto-map data fields

1
bin/magento dotdigital:connector:automap

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

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]]

--username

API username

• Requires a value

--password

API password

• Requires a value

--automap-datafields

Automap data fields

• Accepts a value

--enable-syncs

Enable syncs

• Accepts a value

--remove-ip-restriction

Remove IP restriction

• Accepts a value

--enable-email-capture

Enable email capture

• Accepts a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

dotdigital:migrate

Migrate data into email_ tables to sync with Engagement Cloud

1
bin/magento dotdigital:migrate

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

dotdigital:sync

Run syncs to populate email_ tables before importing to Engagement Cloud

1
bin/magento dotdigital:sync [--from [FROM]] [--] [<sync>]

sync

The name of the sync to run

--from

Specify a date/time (parsable by \DateTime) to run a sync from (if supported)

• Accepts a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

downloadable:domains:add

Add domains to the downloadable domains whitelist

1
bin/magento downloadable:domains:add [<domains>...]

domains

Domains name

• Default: []

• Array

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

downloadable:domains:remove

Remove domains from the downloadable domains whitelist

1
bin/magento downloadable:domains:remove [<domains>...]

domains

Domain names

• Default: []

• Array

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

downloadable:domains:show

Display downloadable domains whitelist

1
bin/magento downloadable:domains:show

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

encryption:payment-data:update

Re-encrypts encrypted credit card data with latest encryption cipher.

1
bin/magento encryption:payment-data:update

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

i18n:collect-phrases

Discovers phrases in the codebase

1
bin/magento i18n:collect-phrases [-o|--output OUTPUT] [-m|--magento] [--] [<directory>]

directory

Directory path to parse. Not needed if –magento flag is set

--output, -o

Path (including filename) to an output file. With no file specified, defaults to stdout.

• Requires a value

--magento, -m

Use the –magento parameter to parse the current Magento codebase. Omit the parameter if a directory is specified.

• Default: false

• Does not accept a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• 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>

source

Path to source dictionary file with translations

• Required

locale

Target locale for dictionary, for example “de_DE”

• Required

--mode, -m

Save mode for dictionary - “replace” - replace language pack by new one - “merge” - merge language packages, by default “replace”

• Default: replace

• Requires a value

--allow-duplicates, -d

Use the –allow-duplicates parameter to allow saving duplicates of translate. Otherwise omit the parameter.

• Default: false

• Does not accept a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

i18n:uninstall

Uninstalls language packages

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

package

Language package name

• Default: []

• Required

• Array

--backup-code, -b

Take code and configuration files backup (excluding temporary files)

• Default: false

• Does not accept a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

indexer:info

Shows allowed Indexers

1
bin/magento indexer:info

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

indexer:reindex

Reindexes Data

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

index

Space-separated list of index types or omit to apply to all indexes.

• Default: []

• Array

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

indexer:reset

Resets indexer status to invalid

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

index

Space-separated list of index types or omit to apply to all indexes.

• Default: []

• Array

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

indexer:set-dimensions-mode

Set Indexer Dimensions Mode

1
bin/magento indexer:set-dimensions-mode [<indexer> [<mode>]]

indexer

Indexer name [catalog_product_price]

mode

Indexer dimension modes catalog_product_price none,website,customer_group,website_and_customer_group

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

indexer:set-mode

Sets index mode type

1
bin/magento indexer:set-mode [<mode> [<index>...]]

mode

Indexer mode type [realtime|schedule]

index

Space-separated list of index types or omit to apply to all indexes.

• Default: []

• Array

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

indexer:show-dimensions-mode

Shows Indexer Dimension Mode

1
bin/magento indexer:show-dimensions-mode [<indexer>...]

indexer

Space-separated list of index types or omit to apply to all indexes (catalog_product_price)

• Default: []

• Array

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

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>...]

index

Space-separated list of index types or omit to apply to all indexes.

• Default: []

• Array

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

indexer:status

Shows status of Indexer

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

index

Space-separated list of index types or omit to apply to all indexes.

• Default: []

• Array

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

info:adminuri

Displays the Magento Admin URI

1
bin/magento info:adminuri

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

info:backups:list

Prints list of available backup files

1
bin/magento info:backups:list

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

info:currency:list

Displays the list of available currencies

1
bin/magento info:currency:list

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

info:dependencies:show-framework

Shows number of dependencies on Magento framework

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

--output, -o

Report filename

• Default: framework-dependencies.csv

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

info:dependencies:show-modules

Shows number of dependencies between modules

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

--output, -o

Report filename

• Default: modules-dependencies.csv

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

info:dependencies:show-modules-circular

Shows number of circular dependencies between modules

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

--output, -o

Report filename

• Default: modules-circular-dependencies.csv

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

info:language:list

Displays the list of available language locales

1
bin/magento info:language:list

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

info:timezone:list

Displays the list of available timezones

1
bin/magento info:timezone:list

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

inventory:reservation:create-compensations

Create reservations by provided compensation arguments

1
bin/magento inventory:reservation:create-compensations [-r|--raw] [--] [<compensations>...]

compensations

List of compensation arguments in format “:::"

• Default: []

• Array

--raw, -r

Raw output

• Default: false

• Does not accept a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• 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]

--complete-orders, -c

Show only inconsistencies for complete orders

• Default: false

• Does not accept a value

--incomplete-orders, -i

Show only inconsistencies for incomplete orders

• Default: false

• Does not accept a value

--bunch-size, -b

Defines how many orders will be loaded at once

• Default: 50

• Accepts a value

--raw, -r

Raw output

• Default: false

• Does not accept a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

inventory-geonames:import

Download and import geo names for source selection algorithm

1
bin/magento inventory-geonames:import <countries>...

countries

List of country codes to import

• Default: []

• Required

• Array

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• 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>...]

ip

Allowed IP addresses

• Default: []

• Array

--none

Clear allowed IP addresses

• Default: false

• Does not accept a value

--add

Add the IP address to existing list

• Default: false

• Does not accept a value

--magento-init-params

Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

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]

--ip

Allowed IP addresses (use ‘none’ to clear allowed IP list)

• Default: []

• Requires a value

--magento-init-params

Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

maintenance:enable

Enables maintenance mode

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

--ip

Allowed IP addresses (use ‘none’ to clear allowed IP list)

• Default: []

• Requires a value

--magento-init-params

Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

maintenance:status

Displays maintenance mode status

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

--magento-init-params

Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

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

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

module:disable

Disables specified modules

1
bin/magento module:disable [-f|--force] [--all] [-c|--clear-static-content] [--magento-init-params MAGENTO-INIT-PARAMS] [--] [<module>...]

module

Name of the module

• Default: []

• Array

--force, -f

Bypass dependencies check

• Default: false

• Does not accept a value

--all

Disable all modules

• Default: false

• Does not accept a value

--clear-static-content, -c

Clear generated static view files. Necessary, if the module(s) have static view files

• Default: false

• Does not accept a value

--magento-init-params

Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• 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>...]

module

Name of the module

• Default: []

• Array

--force, -f

Bypass dependencies check

• Default: false

• Does not accept a value

--all

Enable all modules

• Default: false

• Does not accept a value

--clear-static-content, -c

Clear generated static view files. Necessary, if the module(s) have static view files

• Default: false

• Does not accept a value

--magento-init-params

Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• 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>]

module

Optional module name

--enabled

Print only enabled modules

• Default: false

• Does not accept a value

--disabled

Print only disabled modules

• Default: false

• Does not accept a value

--magento-init-params

Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

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>...

module

Name of the module

• Default: []

• Required

• Array

--remove-data, -r

Remove data installed by module(s)

• Default: false

• Does not accept a value

--backup-code

Take code and configuration files backup (excluding temporary files)

• Default: false

• Does not accept a value

--backup-media

Take media backup

• Default: false

• Does not accept a value

--backup-db

Take complete database backup

• Default: false

• Does not accept a value

--non-composer

All modules, that will be past here will be non composer based

• Default: false

• Does not accept a value

--clear-static-content, -c

Clear generated static view files. Necessary, if the module(s) have static view files

• Default: false

• Does not accept a value

--magento-init-params

Add to any command to customize Magento initialization parameters For example: “MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache”

• Requires a value

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

msp:security:recaptcha:disable

Disable backend reCaptcha

1
bin/magento msp:security:recaptcha:disable

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

msp:security:tfa:disable

Globally disable two factor auth

1
bin/magento msp:security:tfa:disable

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

msp:security:tfa:providers

List all available providers

1
bin/magento msp:security:tfa:providers

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value

--no-interaction, -n

Do not ask any interactive question

• Default: false

• Does not accept a value

msp:security:tfa:reset

Reset configuration for one user

1
bin/magento msp:security:tfa:reset <user> <provider>

user

Username

• Required

provider

Provider code

• Required

--help, -h

Display this help message

• Default: false

• Does not accept a value

--quiet, -q

Do not output any message

• Default: false

• Does not accept a value

--verbose, -v|-vv|-vvv

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, -V

Display this application version

• Default: false

• Does not accept a value

--ansi

Force ANSI output

• Default: false

• Does not accept a value

--no-ansi

Disable ANSI output

• Default: false

• Does not accept a value