bin/magento (Commerce)

Version: 2.4.0

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

Reference

This reference is generated from the Magento codebase. To change the content, you can update the source code for the corresponding command implementation in Magento codebase repository and submit your changes for review. Another way is to Give us feedback (find the link at the upper right). For contribution guidelines, see Magento Code Contributions.

help

Displays help for a command

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

Arguments

command_name

The command name

  • Default: help

Options

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

Lists commands

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

Arguments

namespace

The namespace name

Options

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

Options

--admin-user

(Required) Admin user

  • Requires a value
--admin-password

(Required) Admin password

  • Requires a value
--admin-email

(Required) Admin email

  • Requires a value
--admin-firstname

(Required) Admin first name

  • Requires a value
--admin-lastname

(Required) Admin last name

  • Requires a value
--magento-init-params

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

  • Requires a value
--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>

Arguments

username

The admin username to unlock

  • Required

Options

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

Arguments

config-types

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

  • Default: []

  • Array

Options

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

Options

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

Options

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

braintree:migrate

Migrate stored cards from a Magento 1 database

1
bin/magento braintree:migrate [--host HOST] [--dbname DBNAME] [--username USERNAME] [--password PASSWORD]

Options

--host

Hostname/IP. Port is optional

  • Requires a value
--dbname

Database name

  • Requires a value
--username

Database username. Must have read access

  • Requires a value
--password

Password

  • Requires a value
--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>...]

Arguments

types

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

  • Default: []

  • Array

Options

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

Arguments

types

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

  • Default: []

  • Array

Options

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

Arguments

types

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

  • Default: []

  • Array

Options

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

Arguments

types

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

  • Default: []

  • Array

Options

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

Options

--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 [-a|--async]

Options

--async, -a

Resize image in asynchronous mode

  • 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

catalog:product:attributes:cleanup

Removes unused product attributes.

1
bin/magento catalog:product:attributes:cleanup

Options

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

Arguments

path

Configuration path for example group/section/field_name

value

Configuration value

Options

--interactive, -i

Enable interactive mode to set all sensitive variables

  • Default: false

  • Does not accept a value

--scope

Scope for configuration, if not set use ‘default’

  • Default: default

  • Accepts a value

--scope-code

Scope code for configuration, empty string by default

  • Default: ``

  • Accepts a value

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

Arguments

path

Configuration path in format section/group/field_name

  • Required

value

Configuration value

  • Required

Options

--scope

Configuration scope (default, website, or store)

  • Default: default

  • Requires a value

--scope-code

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

  • Requires a value
--lock-env, -e

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

  • Default: false

  • Does not accept a value

--lock-config, -c

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

  • Default: false

  • Does not accept a value

--lock, -l

Deprecated, use the –lock-env option instead.

  • Default: false

  • Does not accept a value

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

Arguments

path

Configuration path, for example section_id/group_id/field_id

Options

--scope

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

  • Default: default

  • Accepts a value

--scope-code

Scope code (required only if scope is not default)

  • Default: ``

  • Accepts a value

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

Options

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

Options

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

Options

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

Options

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

Arguments

mode

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

  • Required

Options

--skip-compilation, -s

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

  • Default: false

  • Does not accept a value

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

Options

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

Arguments

class

Class name

  • Required

Options

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

Options

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

Arguments

type

Profiler type

Options

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

Options

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

Options

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

Arguments

file

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

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

  • Array

Options

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

Options

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

Options

--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:status

Show frontend template hints status.

1
bin/magento dev:template-hints:status

Options

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

Arguments

type

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

  • Default: default

Options

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

Arguments

path

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

  • Required

Options

--ide

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

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

Arguments

xml-file

Path to XML file that going to be transformed

  • Required

processor

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

  • Required

Options

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

Options

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

Options

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

Options

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

Arguments

sync

The name of the sync to run

Options

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

Arguments

domains

Domains name

  • Default: []

  • Array

Options

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

Arguments

domains

Domain names

  • Default: []

  • Array

Options

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

Options

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

Options

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

Arguments

directory

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

Options

--output, -o

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

  • Requires a value
--magento, -m

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

  • Default: false

  • Does not accept a value

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

Arguments

source

Path to source dictionary file with translations

  • Required

locale

Target locale for dictionary, for example “de_DE”

  • Required

Options

--mode, -m

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

  • Default: replace

  • Requires a value

--allow-duplicates, -d

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

  • Default: false

  • Does not accept a value

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

Arguments

package

Language package name

  • Default: []

  • Required

  • Array

Options

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

Options

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

Arguments

index

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

  • Default: []

  • Array

Options

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

Arguments

index

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

  • Default: []

  • Array

Options

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

Arguments

indexer

Indexer name [catalog_product_price]

mode

Indexer dimension modes catalog_product_price none,website,customer_group,website_and_customer_group

Options

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

Arguments

mode
Indexer mode type [realtime schedule]

index

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

  • Default: []

  • Array

Options

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

Arguments

indexer

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

  • Default: []

  • Array

Options

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

Arguments

index

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

  • Default: []

  • Array

Options

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

Arguments

index

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

  • Default: []

  • Array

Options

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

Options

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

Options

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

Options

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

Options

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

Options

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

Options

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

Options

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

Options

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

Arguments

compensations

List of compensation arguments in format “:::"

  • Default: []

  • Array

Options

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

Options

--complete-orders, -c

Show only inconsistencies for complete orders

  • Default: false

  • Does not accept a value

--incomplete-orders, -i

Show only inconsistencies for incomplete orders

  • Default: false

  • Does not accept a value

--bunch-size, -b

Defines how many orders will be loaded at once

  • Default: 50

  • Accepts a value

--raw, -r

Raw output

  • Default: false

  • Does not accept a value

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

Arguments

countries

List of country codes to import

  • Default: []

  • Required

  • Array

Options

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

Arguments

ip

Allowed IP addresses

  • Default: []

  • Array

Options

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

Options

--ip

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

  • Default: []

  • Requires a value

--magento-init-params

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

  • Requires a value
--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]

Options

--ip

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

  • Default: []

  • Requires a value

--magento-init-params

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

  • Requires a value
--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]

Options

--magento-init-params

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

  • Requires a value
--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

media-content:sync

Synchronize content with assets

1
bin/magento media-content:sync

Options

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

media-gallery:sync

Synchronize media storage and media assets in the database

1
bin/magento media-gallery:sync

Options

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

Options

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

Arguments

module

Name of the module

  • Default: []

  • Array

Options

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

Arguments

module

Name of the module

  • Default: []

  • Array

Options

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

Arguments

module

Optional module name

Options

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

Arguments

module

Name of the module

  • Default: []

  • Required

  • Array

Options

--remove-data, -r

Remove data installed by module(s)

  • Default: false

  • Does not accept a value

--backup-code

Take code and configuration files backup (excluding temporary files)

  • Default: false

  • Does not accept a value

--backup-media

Take media backup

  • Default: false

  • Does not accept a value

--backup-db

Take complete database backup

  • Default: false

  • Does not accept a value

--non-composer

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

  • Default: false

  • Does not accept a value

--clear-static-content, -c

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

  • Default: false

  • Does not accept a value

--magento-init-params

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

  • Requires a value
--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

newrelic:create:deploy-marker

Check the deploy queue for entries and create an appropriate deploy marker.

1
bin/magento newrelic:create:deploy-marker <message> <change_log> [<user>]

Arguments

message

Deploy Message?

  • Required

change_log

Change Log?

  • Required

user

Deployment User

Options

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

queue:consumers:list

List of MessageQueue consumers

1
bin/magento queue:consumers:list

Options

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

queue:consumers:start

Start MessageQueue consumer

1
bin/magento queue:consumers:start [--max-messages MAX-MESSAGES] [--batch-size BATCH-SIZE] [--area-code AREA-CODE] [--single-thread] [--pid-file-path PID-FILE-PATH] [--] <consumer>

Arguments

consumer

The name of the consumer to be started.

  • Required

Options

--max-messages

The number of messages to be processed by the consumer before process termination. If not specified - terminate after processing all queued messages.

  • Requires a value
--batch-size

The number of messages per batch. Applicable for the batch consumer only.

  • Requires a value
--area-code

The preferred area (global, adminhtml, etc…) default is global.

  • Requires a value
--single-thread

This option prevents running multiple copies of one consumer simultaneously.

  • Default: false

  • Does not accept a value

--pid-file-path

The file path for saving PID (This option is deprecated, use –single-thread instead)

  • 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

sampledata:deploy

Deploy sample data modules for composer-based Magento installations

1
bin/magento sampledata:deploy [--no-update]

Options

--no-update

Update composer.json without executing composer update

  • 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

sampledata:remove

Remove all sample data packages from composer.json

1
bin/magento sampledata:remove [--no-update]

Options

--no-update

Update composer.json without executing composer update

  • 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

sampledata:reset

Reset all sample data modules for re-installation

1
bin/magento sampledata:reset

Options

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

security:recaptcha:disable-for-user-forgot-password

Disable reCAPTCHA for admin user forgot password form

1
bin/magento security:recaptcha:disable-for-user-forgot-password

Options

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

security:recaptcha:disable-for-user-login

Disable reCAPTCHA for admin user login form

1
bin/magento security:recaptcha:disable-for-user-login

Options

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

security:tfa:google:set-secret

Set the secret used for Google OTP generation.

1
bin/magento security:tfa:google:set-secret <user> <secret>

Arguments

user

Username

  • Required

secret

Secret

  • Required

Options

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

security:tfa:providers

List all available providers

1
bin/magento security:tfa:providers

Options

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

security:tfa:reset

Reset configuration for one user

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

Arguments

user

Username

  • Required

provider

Provider code

  • Required

Options

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

setup:backup

Takes backup of Magento Application code base, media and database

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

Options

--code

Take code and configuration files backup (excluding temporary files)

  • Default: false

  • Does not accept a value

--media

Take media backup

  • Default: false

  • Does not accept a value

--db

Take complete database backup

  • Default: false

  • Does not accept a value

--magento-init-params

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

  • Requires a value
--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

setup:config:set

Creates or modifies the deployment configuration

1
bin/magento setup:config:set [--backend-frontname BACKEND-FRONTNAME] [--amqp-host AMQP-HOST] [--amqp-port AMQP-PORT] [--amqp-user AMQP-USER] [--amqp-password AMQP-PASSWORD] [--amqp-virtualhost AMQP-VIRTUALHOST] [--amqp-ssl AMQP-SSL] [--amqp-ssl-options AMQP-SSL-OPTIONS] [--enable-debug-logging ENABLE-DEBUG-LOGGING] [--enable-syslog-logging ENABLE-SYSLOG-LOGGING] [--consumers-wait-for-messages CONSUMERS-WAIT-FOR-MESSAGES] [--key KEY] [--db-host DB-HOST] [--db-name DB-NAME] [--db-user DB-USER] [--db-engine DB-ENGINE] [--db-password DB-PASSWORD] [--db-prefix DB-PREFIX] [--db-model DB-MODEL] [--db-init-statements DB-INIT-STATEMENTS] [-s|--skip-db-validation] [--http-cache-hosts HTTP-CACHE-HOSTS] [--db-ssl-key DB-SSL-KEY] [--db-ssl-cert DB-SSL-CERT] [--db-ssl-ca DB-SSL-CA] [--db-ssl-verify] [--session-save SESSION-SAVE] [--session-save-redis-host SESSION-SAVE-REDIS-HOST] [--session-save-redis-port SESSION-SAVE-REDIS-PORT] [--session-save-redis-password SESSION-SAVE-REDIS-PASSWORD] [--session-save-redis-timeout SESSION-SAVE-REDIS-TIMEOUT] [--session-save-redis-persistent-id SESSION-SAVE-REDIS-PERSISTENT-ID] [--session-save-redis-db SESSION-SAVE-REDIS-DB] [--session-save-redis-compression-threshold SESSION-SAVE-REDIS-COMPRESSION-THRESHOLD] [--session-save-redis-compression-lib SESSION-SAVE-REDIS-COMPRESSION-LIB] [--session-save-redis-log-level SESSION-SAVE-REDIS-LOG-LEVEL] [--session-save-redis-max-concurrency SESSION-SAVE-REDIS-MAX-CONCURRENCY] [--session-save-redis-break-after-frontend SESSION-SAVE-REDIS-BREAK-AFTER-FRONTEND] [--session-save-redis-break-after-adminhtml SESSION-SAVE-REDIS-BREAK-AFTER-ADMINHTML] [--session-save-redis-first-lifetime SESSION-SAVE-REDIS-FIRST-LIFETIME] [--session-save-redis-bot-first-lifetime SESSION-SAVE-REDIS-BOT-FIRST-LIFETIME] [--session-save-redis-bot-lifetime SESSION-SAVE-REDIS-BOT-LIFETIME] [--session-save-redis-disable-locking SESSION-SAVE-REDIS-DISABLE-LOCKING] [--session-save-redis-min-lifetime SESSION-SAVE-REDIS-MIN-LIFETIME] [--session-save-redis-max-lifetime SESSION-SAVE-REDIS-MAX-LIFETIME] [--session-save-redis-sentinel-master SESSION-SAVE-REDIS-SENTINEL-MASTER] [--session-save-redis-sentinel-servers SESSION-SAVE-REDIS-SENTINEL-SERVERS] [--session-save-redis-sentinel-verify-master SESSION-SAVE-REDIS-SENTINEL-VERIFY-MASTER] [--session-save-redis-sentinel-connect-retires SESSION-SAVE-REDIS-SENTINEL-CONNECT-RETIRES] [--cache-backend CACHE-BACKEND] [--cache-backend-redis-server CACHE-BACKEND-REDIS-SERVER] [--cache-backend-redis-db CACHE-BACKEND-REDIS-DB] [--cache-backend-redis-port CACHE-BACKEND-REDIS-PORT] [--cache-backend-redis-password CACHE-BACKEND-REDIS-PASSWORD] [--cache-backend-redis-compress-data CACHE-BACKEND-REDIS-COMPRESS-DATA] [--cache-backend-redis-compression-lib CACHE-BACKEND-REDIS-COMPRESSION-LIB] [--cache-id-prefix CACHE-ID-PREFIX] [--allow-parallel-generation] [--page-cache PAGE-CACHE] [--page-cache-redis-server PAGE-CACHE-REDIS-SERVER] [--page-cache-redis-db PAGE-CACHE-REDIS-DB] [--page-cache-redis-port PAGE-CACHE-REDIS-PORT] [--page-cache-redis-password PAGE-CACHE-REDIS-PASSWORD] [--page-cache-redis-compress-data PAGE-CACHE-REDIS-COMPRESS-DATA] [--page-cache-redis-compression-lib PAGE-CACHE-REDIS-COMPRESSION-LIB] [--page-cache-id-prefix PAGE-CACHE-ID-PREFIX] [--lock-provider LOCK-PROVIDER] [--lock-db-prefix LOCK-DB-PREFIX] [--lock-zookeeper-host LOCK-ZOOKEEPER-HOST] [--lock-zookeeper-path LOCK-ZOOKEEPER-PATH] [--lock-file-path LOCK-FILE-PATH] [--magento-init-params MAGENTO-INIT-PARAMS]

Options

--backend-frontname

Backend frontname (will be autogenerated if missing)

  • Requires a value
--amqp-host

Amqp server host

  • Default: ``

  • Requires a value

--amqp-port

Amqp server port

  • Default: 5672

  • Requires a value

--amqp-user

Amqp server username

  • Default: ``

  • Requires a value

--amqp-password

Amqp server password

  • Default: ``

  • Requires a value

--amqp-virtualhost

Amqp virtualhost

  • Default: /

  • Requires a value

--amqp-ssl

Amqp SSL

  • Default: ``

  • Requires a value

--amqp-ssl-options

Amqp SSL Options (JSON)

  • Default: ``

  • Requires a value

--enable-debug-logging

Enable debug logging

  • Requires a value
--enable-syslog-logging

Enable syslog logging

  • Requires a value
--consumers-wait-for-messages

Should consumers wait for a message from the queue? 1 - Yes, 0 - No

  • Requires a value
--key

Encryption key

  • Requires a value
--db-host

Database server host

  • Requires a value
--db-name

Database name

  • Requires a value
--db-user

Database server username

  • Requires a value
--db-engine

Database server engine

  • Requires a value
--db-password

Database server password

  • Requires a value
--db-prefix

Database table prefix

  • Requires a value
--db-model

Database type

  • Requires a value
--db-init-statements

Database initial set of commands

  • Requires a value
--skip-db-validation, -s

If specified, then db connection validation will be skipped

  • Default: false

  • Does not accept a value

--http-cache-hosts

http Cache hosts

  • Requires a value
--db-ssl-key

Full path of client key file in order to establish db connection through SSL

  • Default: ``

  • Requires a value

--db-ssl-cert

Full path of client certificate file in order to establish db connection through SSL

  • Default: ``

  • Requires a value

--db-ssl-ca

Full path of server certificate file in order to establish db connection through SSL

  • Default: ``

  • Requires a value

--db-ssl-verify

Verify server certification

  • Default: false

  • Does not accept a value

--session-save

Session save handler

  • Requires a value
--session-save-redis-host

Fully qualified host name, IP address, or absolute path if using UNIX sockets

  • Requires a value
--session-save-redis-port

Redis server listen port

  • Requires a value
--session-save-redis-password

Redis server password

  • Requires a value
--session-save-redis-timeout

Connection timeout, in seconds

  • Requires a value
--session-save-redis-persistent-id

Unique string to enable persistent connections

  • Requires a value
--session-save-redis-db

Redis database number

  • Requires a value
--session-save-redis-compression-threshold

Redis compression threshold

  • Requires a value
--session-save-redis-compression-lib

Redis compression library. Values: gzip (default), lzf, lz4, snappy

  • Requires a value
--session-save-redis-log-level

Redis log level. Values: 0 (least verbose) to 7 (most verbose)

  • Requires a value
--session-save-redis-max-concurrency

Maximum number of processes that can wait for a lock on one session

  • Requires a value
--session-save-redis-break-after-frontend

Number of seconds to wait before trying to break a lock for frontend session

  • Requires a value
--session-save-redis-break-after-adminhtml

Number of seconds to wait before trying to break a lock for Admin session

  • Requires a value
--session-save-redis-first-lifetime

Lifetime, in seconds, of session for non-bots on the first write (use 0 to disable)

  • Requires a value
--session-save-redis-bot-first-lifetime

Lifetime, in seconds, of session for bots on the first write (use 0 to disable)

  • Requires a value
--session-save-redis-bot-lifetime

Lifetime of session for bots on subsequent writes (use 0 to disable)

  • Requires a value
--session-save-redis-disable-locking

Redis disable locking. Values: false (default), true

  • Requires a value
--session-save-redis-min-lifetime

Redis min session lifetime, in seconds

  • Requires a value
--session-save-redis-max-lifetime

Redis max session lifetime, in seconds

  • Requires a value
--session-save-redis-sentinel-master

Redis Sentinel master

  • Requires a value
--session-save-redis-sentinel-servers

Redis Sentinel servers, comma separated

  • Requires a value
--session-save-redis-sentinel-verify-master

Redis Sentinel verify master. Values: false (default), true

  • Requires a value
--session-save-redis-sentinel-connect-retires

Redis Sentinel connect retries.

  • Requires a value
--cache-backend

Default cache handler

  • Requires a value
--cache-backend-redis-server

Redis server

  • Requires a value
--cache-backend-redis-db

Database number for the cache

  • Requires a value
--cache-backend-redis-port

Redis server listen port

  • Requires a value
--cache-backend-redis-password

Redis server password

  • Requires a value
--cache-backend-redis-compress-data

Set to 0 to disable compression (default is 1, enabled)

  • Requires a value
--cache-backend-redis-compression-lib

Compression lib to use [snappy,lzf,l4z,zstd,gzip] (leave blank to determine automatically)

  • Requires a value
--cache-id-prefix

ID prefix for cache keys

  • Requires a value
--allow-parallel-generation

Allow generate cache in non-blocking way

  • Default: false

  • Does not accept a value

--page-cache

Default cache handler

  • Requires a value
--page-cache-redis-server

Redis server

  • Requires a value
--page-cache-redis-db

Database number for the cache

  • Requires a value
--page-cache-redis-port

Redis server listen port

  • Requires a value
--page-cache-redis-password

Redis server password

  • Requires a value
--page-cache-redis-compress-data

Set to 1 to compress the full page cache (use 0 to disable)

  • Requires a value
--page-cache-redis-compression-lib

Compression library to use [snappy,lzf,l4z,zstd,gzip] (leave blank to determine automatically)

  • Requires a value
--page-cache-id-prefix

ID prefix for cache keys

  • Requires a value
--lock-provider

Lock provider name

  • Requires a value
--lock-db-prefix

Installation specific lock prefix to avoid lock conflicts

  • Requires a value
--lock-zookeeper-host

Host and port to connect to Zookeeper cluster. For example: 127.0.0.1:2181

  • Requires a value
--lock-zookeeper-path

The path where Zookeeper will save locks. The default path is: /magento/locks

  • Requires a value
--lock-file-path

The path where file locks will be saved.

  • 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

setup:db-data:upgrade

Installs and upgrades data in the DB

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

Options

--magento-init-params

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

  • Requires a value
--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

setup:db-declaration:generate-patch

Generate patch and put it in specific folder.

1
bin/magento setup:db-declaration:generate-patch [--revertable [REVERTABLE]] [--type [TYPE]] [--] <module> <patch>

Arguments

module

Module name

  • Required

patch

Patch name

  • Required

Options

--revertable

Check whether patch is revertable or not.

  • Default: false

  • Accepts a value

--type

Find out what type of patch should be generated. Available values: data, schema.

  • Default: data

  • 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

setup:db-declaration:generate-whitelist

Generate whitelist of tables and columns that are allowed to be edited by declaration installer

1
bin/magento setup:db-declaration:generate-whitelist [--module-name [MODULE-NAME]]

Options

--module-name

Name of the module where whitelist will be generated

  • Default: all

  • 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

setup:db-schema:add-slave

Move checkout quote related tables to a separate DB server

1
bin/magento setup:db-schema:add-slave [--host HOST] [--dbname DBNAME] [--username USERNAME] [--password [PASSWORD]] [--connection [CONNECTION]] [--resource [RESOURCE]] [--maxAllowedLag [MAXALLOWEDLAG]]

Options

--host

Slave DB Server host

  • Default: localhost

  • Requires a value

--dbname

Slave Database Name

  • Requires a value
--username

Slave DB user name

  • Default: root

  • Requires a value

--password

Slave DB user password

  • Accepts a value
--connection

Slave connection name

  • Default: default

  • Accepts a value

--resource

Slave Resource name

  • Default: default

  • Accepts a value

--maxAllowedLag

Max Allowed Lag Slave Connection (in seconds)

  • 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

setup:db-schema:split-quote

Move checkout quote related tables to a separate DB server

1
bin/magento setup:db-schema:split-quote [--host HOST] [--dbname DBNAME] [--username USERNAME] [--password [PASSWORD]] [--connection [CONNECTION]] [--resource [RESOURCE]] [--magento-init-params MAGENTO-INIT-PARAMS]

Options

--host

Checkout DB Server host

  • Requires a value
--dbname

Checkout Database Name

  • Requires a value
--username

Checkout DB user name

  • Requires a value
--password

Checkout DB user password

  • Accepts a value
--connection

Checkout connection name

  • Default: checkout

  • Accepts a value

--resource

Checkout resource name

  • Default: checkout

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

setup:db-schema:split-sales

Move sales related tables to a separate DB server

1
bin/magento setup:db-schema:split-sales [--host HOST] [--dbname DBNAME] [--username USERNAME] [--password [PASSWORD]] [--connection [CONNECTION]] [--resource [RESOURCE]] [--magento-init-params MAGENTO-INIT-PARAMS]

Options

--host

Sales DB Server host

  • Requires a value
--dbname

Sales Database Name

  • Requires a value
--username

Sales DB user name

  • Requires a value
--password

Sales DB user passowrd

  • Accepts a value
--connection

Sales connection name

  • Default: sales

  • Accepts a value

--resource

Sales resource name

  • Default: sales

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

setup:db-schema:upgrade

Installs and upgrades the DB schema

1
bin/magento setup:db-schema:upgrade [--convert-old-scripts [CONVERT-OLD-SCRIPTS]] [--magento-init-params MAGENTO-INIT-PARAMS]

Options

--convert-old-scripts

Allows to convert old scripts (InstallSchema, UpgradeSchema) to db_schema.xml format

  • Default: false

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

setup:db:status

Checks if DB schema or data requires upgrade

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

Options

--magento-init-params

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

  • Requires a value
--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

setup:di:compile

Generates DI configuration and all missing classes that can be auto-generated

1
bin/magento setup:di:compile

Options

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

setup:install

Installs the Magento application

1
bin/magento setup:install [--backend-frontname BACKEND-FRONTNAME] [--amqp-host AMQP-HOST] [--amqp-port AMQP-PORT] [--amqp-user AMQP-USER] [--amqp-password AMQP-PASSWORD] [--amqp-virtualhost AMQP-VIRTUALHOST] [--amqp-ssl AMQP-SSL] [--amqp-ssl-options AMQP-SSL-OPTIONS] [--enable-debug-logging ENABLE-DEBUG-LOGGING] [--enable-syslog-logging ENABLE-SYSLOG-LOGGING] [--consumers-wait-for-messages CONSUMERS-WAIT-FOR-MESSAGES] [--key KEY] [--db-host DB-HOST] [--db-name DB-NAME] [--db-user DB-USER] [--db-engine DB-ENGINE] [--db-password DB-PASSWORD] [--db-prefix DB-PREFIX] [--db-model DB-MODEL] [--db-init-statements DB-INIT-STATEMENTS] [-s|--skip-db-validation] [--http-cache-hosts HTTP-CACHE-HOSTS] [--db-ssl-key DB-SSL-KEY] [--db-ssl-cert DB-SSL-CERT] [--db-ssl-ca DB-SSL-CA] [--db-ssl-verify] [--session-save SESSION-SAVE] [--session-save-redis-host SESSION-SAVE-REDIS-HOST] [--session-save-redis-port SESSION-SAVE-REDIS-PORT] [--session-save-redis-password SESSION-SAVE-REDIS-PASSWORD] [--session-save-redis-timeout SESSION-SAVE-REDIS-TIMEOUT] [--session-save-redis-persistent-id SESSION-SAVE-REDIS-PERSISTENT-ID] [--session-save-redis-db SESSION-SAVE-REDIS-DB] [--session-save-redis-compression-threshold SESSION-SAVE-REDIS-COMPRESSION-THRESHOLD] [--session-save-redis-compression-lib SESSION-SAVE-REDIS-COMPRESSION-LIB] [--session-save-redis-log-level SESSION-SAVE-REDIS-LOG-LEVEL] [--session-save-redis-max-concurrency SESSION-SAVE-REDIS-MAX-CONCURRENCY] [--session-save-redis-break-after-frontend SESSION-SAVE-REDIS-BREAK-AFTER-FRONTEND] [--session-save-redis-break-after-adminhtml SESSION-SAVE-REDIS-BREAK-AFTER-ADMINHTML] [--session-save-redis-first-lifetime SESSION-SAVE-REDIS-FIRST-LIFETIME] [--session-save-redis-bot-first-lifetime SESSION-SAVE-REDIS-BOT-FIRST-LIFETIME] [--session-save-redis-bot-lifetime SESSION-SAVE-REDIS-BOT-LIFETIME] [--session-save-redis-disable-locking SESSION-SAVE-REDIS-DISABLE-LOCKING] [--session-save-redis-min-lifetime SESSION-SAVE-REDIS-MIN-LIFETIME] [--session-save-redis-max-lifetime SESSION-SAVE-REDIS-MAX-LIFETIME] [--session-save-redis-sentinel-master SESSION-SAVE-REDIS-SENTINEL-MASTER] [--session-save-redis-sentinel-servers SESSION-SAVE-REDIS-SENTINEL-SERVERS] [--session-save-redis-sentinel-verify-master SESSION-SAVE-REDIS-SENTINEL-VERIFY-MASTER] [--session-save-redis-sentinel-connect-retires SESSION-SAVE-REDIS-SENTINEL-CONNECT-RETIRES] [--cache-backend CACHE-BACKEND] [--cache-backend-redis-server CACHE-BACKEND-REDIS-SERVER] [--cache-backend-redis-db CACHE-BACKEND-REDIS-DB] [--cache-backend-redis-port CACHE-BACKEND-REDIS-PORT] [--cache-backend-redis-password CACHE-BACKEND-REDIS-PASSWORD] [--cache-backend-redis-compress-data CACHE-BACKEND-REDIS-COMPRESS-DATA] [--cache-backend-redis-compression-lib CACHE-BACKEND-REDIS-COMPRESSION-LIB] [--cache-id-prefix CACHE-ID-PREFIX] [--allow-parallel-generation] [--page-cache PAGE-CACHE] [--page-cache-redis-server PAGE-CACHE-REDIS-SERVER] [--page-cache-redis-db PAGE-CACHE-REDIS-DB] [--page-cache-redis-port PAGE-CACHE-REDIS-PORT] [--page-cache-redis-password PAGE-CACHE-REDIS-PASSWORD] [--page-cache-redis-compress-data PAGE-CACHE-REDIS-COMPRESS-DATA] [--page-cache-redis-compression-lib PAGE-CACHE-REDIS-COMPRESSION-LIB] [--page-cache-id-prefix PAGE-CACHE-ID-PREFIX] [--lock-provider LOCK-PROVIDER] [--lock-db-prefix LOCK-DB-PREFIX] [--lock-zookeeper-host LOCK-ZOOKEEPER-HOST] [--lock-zookeeper-path LOCK-ZOOKEEPER-PATH] [--lock-file-path LOCK-FILE-PATH] [--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]] [--search-engine SEARCH-ENGINE] [--elasticsearch-host ELASTICSEARCH-HOST] [--elasticsearch-port ELASTICSEARCH-PORT] [--elasticsearch-enable-auth ELASTICSEARCH-ENABLE-AUTH] [--elasticsearch-username ELASTICSEARCH-USERNAME] [--elasticsearch-password ELASTICSEARCH-PASSWORD] [--elasticsearch-index-prefix ELASTICSEARCH-INDEX-PREFIX] [--elasticsearch-timeout ELASTICSEARCH-TIMEOUT] [--cleanup-database] [--sales-order-increment-prefix SALES-ORDER-INCREMENT-PREFIX] [--use-sample-data] [--enable-modules [ENABLE-MODULES]] [--disable-modules [DISABLE-MODULES]] [--convert-old-scripts [CONVERT-OLD-SCRIPTS]] [-i|--interactive] [--safe-mode [SAFE-MODE]] [--data-restore [DATA-RESTORE]] [--dry-run [DRY-RUN]] [--magento-init-params MAGENTO-INIT-PARAMS]

Options

--backend-frontname

Backend frontname (will be autogenerated if missing)

  • Requires a value
--amqp-host

Amqp server host

  • Default: ``

  • Requires a value

--amqp-port

Amqp server port

  • Default: 5672

  • Requires a value

--amqp-user

Amqp server username

  • Default: ``

  • Requires a value

--amqp-password

Amqp server password

  • Default: ``

  • Requires a value

--amqp-virtualhost

Amqp virtualhost

  • Default: /

  • Requires a value

--amqp-ssl

Amqp SSL

  • Default: ``

  • Requires a value

--amqp-ssl-options

Amqp SSL Options (JSON)

  • Default: ``

  • Requires a value

--enable-debug-logging

Enable debug logging

  • Requires a value
--enable-syslog-logging

Enable syslog logging

  • Requires a value
--consumers-wait-for-messages

Should consumers wait for a message from the queue? 1 - Yes, 0 - No

  • Requires a value
--key

Encryption key

  • Requires a value
--db-host

Database server host

  • Requires a value
--db-name

Database name

  • Requires a value
--db-user

Database server username

  • Requires a value
--db-engine

Database server engine

  • Requires a value
--db-password

Database server password

  • Requires a value
--db-prefix

Database table prefix

  • Requires a value
--db-model

Database type

  • Requires a value
--db-init-statements

Database initial set of commands

  • Requires a value
--skip-db-validation, -s

If specified, then db connection validation will be skipped

  • Default: false

  • Does not accept a value

--http-cache-hosts

http Cache hosts

  • Requires a value
--db-ssl-key

Full path of client key file in order to establish db connection through SSL

  • Default: ``

  • Requires a value

--db-ssl-cert

Full path of client certificate file in order to establish db connection through SSL

  • Default: ``

  • Requires a value

--db-ssl-ca

Full path of server certificate file in order to establish db connection through SSL

  • Default: ``

  • Requires a value

--db-ssl-verify

Verify server certification

  • Default: false

  • Does not accept a value

--session-save

Session save handler

  • Requires a value
--session-save-redis-host

Fully qualified host name, IP address, or absolute path if using UNIX sockets

  • Requires a value
--session-save-redis-port

Redis server listen port

  • Requires a value
--session-save-redis-password

Redis server password

  • Requires a value
--session-save-redis-timeout

Connection timeout, in seconds

  • Requires a value
--session-save-redis-persistent-id

Unique string to enable persistent connections

  • Requires a value
--session-save-redis-db

Redis database number

  • Requires a value
--session-save-redis-compression-threshold

Redis compression threshold

  • Requires a value
--session-save-redis-compression-lib

Redis compression library. Values: gzip (default), lzf, lz4, snappy

  • Requires a value
--session-save-redis-log-level

Redis log level. Values: 0 (least verbose) to 7 (most verbose)

  • Requires a value
--session-save-redis-max-concurrency

Maximum number of processes that can wait for a lock on one session

  • Requires a value
--session-save-redis-break-after-frontend

Number of seconds to wait before trying to break a lock for frontend session

  • Requires a value
--session-save-redis-break-after-adminhtml

Number of seconds to wait before trying to break a lock for Admin session

  • Requires a value
--session-save-redis-first-lifetime

Lifetime, in seconds, of session for non-bots on the first write (use 0 to disable)

  • Requires a value
--session-save-redis-bot-first-lifetime

Lifetime, in seconds, of session for bots on the first write (use 0 to disable)

  • Requires a value
--session-save-redis-bot-lifetime

Lifetime of session for bots on subsequent writes (use 0 to disable)

  • Requires a value
--session-save-redis-disable-locking

Redis disable locking. Values: false (default), true

  • Requires a value
--session-save-redis-min-lifetime

Redis min session lifetime, in seconds

  • Requires a value
--session-save-redis-max-lifetime

Redis max session lifetime, in seconds

  • Requires a value
--session-save-redis-sentinel-master

Redis Sentinel master

  • Requires a value
--session-save-redis-sentinel-servers

Redis Sentinel servers, comma separated

  • Requires a value
--session-save-redis-sentinel-verify-master

Redis Sentinel verify master. Values: false (default), true

  • Requires a value
--session-save-redis-sentinel-connect-retires

Redis Sentinel connect retries.

  • Requires a value
--cache-backend

Default cache handler

  • Requires a value
--cache-backend-redis-server

Redis server

  • Requires a value
--cache-backend-redis-db

Database number for the cache

  • Requires a value
--cache-backend-redis-port

Redis server listen port

  • Requires a value
--cache-backend-redis-password

Redis server password

  • Requires a value
--cache-backend-redis-compress-data

Set to 0 to disable compression (default is 1, enabled)

  • Requires a value
--cache-backend-redis-compression-lib

Compression lib to use [snappy,lzf,l4z,zstd,gzip] (leave blank to determine automatically)

  • Requires a value
--cache-id-prefix

ID prefix for cache keys

  • Requires a value
--allow-parallel-generation

Allow generate cache in non-blocking way

  • Default: false

  • Does not accept a value

--page-cache

Default cache handler

  • Requires a value
--page-cache-redis-server

Redis server

  • Requires a value
--page-cache-redis-db

Database number for the cache

  • Requires a value
--page-cache-redis-port

Redis server listen port

  • Requires a value
--page-cache-redis-password

Redis server password

  • Requires a value
--page-cache-redis-compress-data

Set to 1 to compress the full page cache (use 0 to disable)

  • Requires a value
--page-cache-redis-compression-lib

Compression library to use [snappy,lzf,l4z,zstd,gzip] (leave blank to determine automatically)

  • Requires a value
--page-cache-id-prefix

ID prefix for cache keys

  • Requires a value
--lock-provider

Lock provider name

  • Requires a value
--lock-db-prefix

Installation specific lock prefix to avoid lock conflicts

  • Requires a value
--lock-zookeeper-host

Host and port to connect to Zookeeper cluster. For example: 127.0.0.1:2181

  • Requires a value
--lock-zookeeper-path

The path where Zookeeper will save locks. The default path is: /magento/locks

  • Requires a value
--lock-file-path

The path where file locks will be saved.

  • Requires a value
--base-url

URL the store is supposed to be available at. Deprecated, use config:set with path web/unsecure/base_url

  • Requires a value
--language

Default language code. Deprecated, use config:set with path general/locale/code

  • Requires a value
--timezone

Default time zone code. Deprecated, use config:set with path general/locale/timezone

  • Requires a value
--currency

Default currency code. Deprecated, use config:set with path currency/options/base, currency/options/default and currency/options/allow

  • Requires a value
--use-rewrites

Use rewrites. Deprecated, use config:set with path web/seo/use_rewrites

  • Requires a value
--use-secure

Use secure URLs. Enable this option only if SSL is available. Deprecated, use config:set with path web/secure/use_in_frontend

  • Requires a value
--base-url-secure

Base URL for SSL connection. Deprecated, use config:set with path web/secure/base_url

  • Requires a value
--use-secure-admin

Run admin interface with SSL. Deprecated, use config:set with path web/secure/use_in_adminhtml

  • Requires a value
--admin-use-security-key

Whether to use a “security key” feature in Magento Admin URLs and forms. Deprecated, use config:set with path admin/security/use_form_key

  • Requires a value
--admin-user

Admin user

  • Accepts a value
--admin-password

Admin password

  • Accepts a value
--admin-email

Admin email

  • Accepts a value
--admin-firstname

Admin first name

  • Accepts a value
--admin-lastname

Admin last name

  • Accepts a value
--search-engine

Search engine. Values: elasticsearch5, elasticsearch6, elasticsearch7

  • Requires a value
--elasticsearch-host

Elasticsearch server host.

  • Requires a value
--elasticsearch-port

Elasticsearch server port.

  • Requires a value
--elasticsearch-enable-auth

Set to 1 to enable authentication. (default is 0, disabled)

  • Requires a value
--elasticsearch-username

Elasticsearch username. Only applicable if HTTP auth is enabled

  • Requires a value
--elasticsearch-password

Elasticsearch password. Only applicable if HTTP auth is enabled

  • Requires a value
--elasticsearch-index-prefix

Elasticsearch index prefix.

  • Requires a value
--elasticsearch-timeout

Elasticsearch server timeout.

  • Requires a value
--cleanup-database

Cleanup the database before installation

  • Default: false

  • Does not accept a value

--sales-order-increment-prefix

Sales order number prefix

  • Requires a value
--use-sample-data

Use sample data

  • Default: false

  • Does not accept a value

--enable-modules

List of comma-separated module names. That must be included during installation. Available magic param “all”.

  • Accepts a value
--disable-modules

List of comma-separated module names. That must be avoided during installation. Available magic param “all”.

  • Accepts a value
--convert-old-scripts

Allows to convert old scripts (InstallSchema, UpgradeSchema) to db_schema.xml format

  • Default: false

  • Accepts a value

--interactive, -i

Interactive Magento installation

  • Default: false

  • Does not accept a value

--safe-mode

Safe installation of Magento with dumps on destructive operations, like column removal

  • Accepts a value
--data-restore

Restore removed data from dumps

  • Accepts a value
--dry-run

Magento Installation will be run in dry-run mode

  • Default: false

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

setup:performance:generate-fixtures

Generates fixtures

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

Arguments

profile

Path to profile configuration file

  • Required

Options

--skip-reindex, -s

Skip reindex

  • 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

setup:rollback

Rolls back Magento Application codebase, media and database

1
bin/magento setup:rollback [-c|--code-file CODE-FILE] [-m|--media-file MEDIA-FILE] [-d|--db-file DB-FILE] [--magento-init-params MAGENTO-INIT-PARAMS]

Options

--code-file, -c

Basename of the code backup file in var/backups

  • Requires a value
--media-file, -m

Basename of the media backup file in var/backups

  • Requires a value
--db-file, -d

Basename of the db backup file in var/backups

  • 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

setup:static-content:deploy

Deploys static view files

1
bin/magento setup:static-content:deploy [-f|--force] [-s|--strategy [STRATEGY]] [-a|--area [AREA]] [--exclude-area [EXCLUDE-AREA]] [-t|--theme [THEME]] [--exclude-theme [EXCLUDE-THEME]] [-l|--language [LANGUAGE]] [--exclude-language [EXCLUDE-LANGUAGE]] [-j|--jobs [JOBS]] [--max-execution-time [MAX-EXECUTION-TIME]] [--symlink-locale] [--content-version CONTENT-VERSION] [--refresh-content-version-only] [--no-javascript] [--no-js-bundle] [--no-css] [--no-less] [--no-images] [--no-fonts] [--no-html] [--no-misc] [--no-html-minify] [--] [<languages>...]

Arguments

languages

Space-separated list of ISO-639 language codes for which to output static view files.

  • Default: []

  • Array

Options

--force, -f

Deploy files in any mode.

  • Default: false

  • Does not accept a value

--strategy, -s

Deploy files using specified strategy.

  • Default: quick

  • Accepts a value

--area, -a

Generate files only for the specified areas.

  • Default: all

  • Accepts multiple values

--exclude-area

Do not generate files for the specified areas.

  • Default: none

  • Accepts multiple values

--theme, -t

Generate static view files for only the specified themes.

  • Default: all

  • Accepts multiple values

--exclude-theme

Do not generate files for the specified themes.

  • Default: none

  • Accepts multiple values

--language, -l

Generate files only for the specified languages.

  • Default: all

  • Accepts multiple values

--exclude-language

Do not generate files for the specified languages.

  • Default: none

  • Accepts multiple values

--jobs, -j

Enable parallel processing using the specified number of jobs.

  • Default: 0

  • Accepts a value

--max-execution-time

The maximum expected execution time of deployment static process (in seconds).

  • Default: 400

  • Accepts a value

Create symlinks for the files of those locales, which are passed for deployment, but have no customizations.

  • Default: false

  • Does not accept a value

--content-version

Custom version of static content can be used if running deployment on multiple nodes to ensure that static content version is identical and caching works properly.

  • Requires a value
--refresh-content-version-only

Refreshing the version of static content only can be used to refresh static content in browser cache and CDN cache.

  • Default: false

  • Does not accept a value

--no-javascript

Do not deploy JavaScript files.

  • Default: false

  • Does not accept a value

--no-js-bundle

Do not deploy JavaScript bundle files.

  • Default: false

  • Does not accept a value

--no-css

Do not deploy CSS files.

  • Default: false

  • Does not accept a value

--no-less

Do not deploy LESS files.

  • Default: false

  • Does not accept a value

--no-images

Do not deploy images.

  • Default: false

  • Does not accept a value

--no-fonts

Do not deploy font files.

  • Default: false

  • Does not accept a value

--no-html

Do not deploy HTML files.

  • Default: false

  • Does not accept a value

--no-misc

Do not deploy files of other types (.md, .jbf, .csv, etc.).

  • Default: false

  • Does not accept a value

--no-html-minify

Do not minify HTML 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

setup:store-config:set

Installs the store configuration. Deprecated since 2.2.0. Use config:set instead

1
bin/magento setup:store-config:set [--base-url BASE-URL] [--language LANGUAGE] [--timezone TIMEZONE] [--currency CURRENCY] [--use-rewrites USE-REWRITES] [--use-secure USE-SECURE] [--base-url-secure BASE-URL-SECURE] [--use-secure-admin USE-SECURE-ADMIN] [--admin-use-security-key ADMIN-USE-SECURITY-KEY] [--magento-init-params MAGENTO-INIT-PARAMS]

Options

--base-url

URL the store is supposed to be available at. Deprecated, use config:set with path web/unsecure/base_url

  • Requires a value
--language

Default language code. Deprecated, use config:set with path general/locale/code

  • Requires a value
--timezone

Default time zone code. Deprecated, use config:set with path general/locale/timezone

  • Requires a value
--currency

Default currency code. Deprecated, use config:set with path currency/options/base, currency/options/default and currency/options/allow

  • Requires a value
--use-rewrites

Use rewrites. Deprecated, use config:set with path web/seo/use_rewrites

  • Requires a value
--use-secure

Use secure URLs. Enable this option only if SSL is available. Deprecated, use config:set with path web/secure/use_in_frontend

  • Requires a value
--base-url-secure

Base URL for SSL connection. Deprecated, use config:set with path web/secure/base_url

  • Requires a value
--use-secure-admin

Run admin interface with SSL. Deprecated, use config:set with path web/secure/use_in_adminhtml

  • Requires a value
--admin-use-security-key

Whether to use a “security key” feature in Magento Admin URLs and forms. Deprecated, use config:set with path admin/security/use_form_key

  • 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

setup:uninstall

Uninstalls the Magento application

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

Options

--magento-init-params

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

  • Requires a value
--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

setup:upgrade

Upgrades the Magento application, DB data, and schema

1
bin/magento setup:upgrade [--keep-generated] [--convert-old-scripts [CONVERT-OLD-SCRIPTS]] [--safe-mode [SAFE-MODE]] [--data-restore [DATA-RESTORE]] [--dry-run [DRY-RUN]] [--magento-init-params MAGENTO-INIT-PARAMS]

Options

--keep-generated

Prevents generated files from being deleted. We discourage using this option except when deploying to production. Consult your system integrator or administrator for more information.

  • Default: false

  • Does not accept a value

--convert-old-scripts

Allows to convert old scripts (InstallSchema, UpgradeSchema) to db_schema.xml format

  • Default: false

  • Accepts a value

--safe-mode

Safe installation of Magento with dumps on destructive operations, like column removal

  • Accepts a value
--data-restore

Restore removed data from dumps

  • Accepts a value
--dry-run

Magento Installation will be run in dry-run mode

  • Default: false

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

store:list

Displays the list of stores

1
bin/magento store:list

Options

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

store:website:list

Displays the list of websites

1
bin/magento store:website:list

Options

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

support:backup:code

Create Code backup

1
bin/magento support:backup:code [--name [NAME]] [-o|--output [OUTPUT]] [-l|--logs]

Options

--name

Dump name

  • Accepts a value
--output, -o

Output path

  • Accepts a value
--logs, -l

Include logs

  • 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

support:backup:db

Create DB backup

1
bin/magento support:backup:db [--name [NAME]] [-o|--output [OUTPUT]] [-l|--logs] [-i|--ignore-sanitize]

Options

--name

Dump name

  • Accepts a value
--output, -o

Output path

  • Accepts a value
--logs, -l

Include logs

  • Default: false

  • Does not accept a value

--ignore-sanitize, -i

Ignore sanitize

  • 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

support:utility:check

Check required backup utilities

1
bin/magento support:utility:check [--hide-paths]

Options

--hide-paths

Only check required console utilities

  • 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

support:utility:paths

Create utilities paths list

1
bin/magento support:utility:paths [-f|--force]

Options

--force, -f

Force

  • 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

theme:uninstall

Uninstalls theme

1
bin/magento theme:uninstall [--backup-code] [-c|--clear-static-content] [--] <theme>...

Arguments

theme

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

Take code backup (excluding temporary files)

  • Default: false

  • Does not accept a value

--clear-static-content, -c

Clear generated static view 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

varnish:vcl:generate

Generates Varnish VCL and echos it to the command line

1
bin/magento varnish:vcl:generate [--access-list ACCESS-LIST] [--backend-host BACKEND-HOST] [--backend-port BACKEND-PORT] [--export-version EXPORT-VERSION] [--grace-period GRACE-PERIOD] [--output-file OUTPUT-FILE]

Options

--access-list

IPs access list that can purge Varnish

  • Default: localhost

  • Requires a value

--backend-host

Host of the web backend

  • Default: localhost

  • Requires a value

--backend-port

Port of the web backend

  • Default: 8080

  • Requires a value

--export-version

The version of Varnish file

  • Default: 4

  • Requires a value

--grace-period

Grace period in seconds

  • Default: 300

  • Requires a value

--output-file

Path to the file to write vcl

  • 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

yotpo:reset

Reset Yotpo sync flags &/or configurations

1
bin/magento yotpo:reset [-e|--entity [ENTITY]]

Options

--entity, -e

Entity type (orders)

  • Default: orders

  • 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

yotpo:sync

Sync Yotpo manually (reviews module)

1
bin/magento yotpo:sync [-e|--entity ENTITY] [-l|--limit [LIMIT]]

Options

--entity, -e

Entity type (allowed options: orders)

  • Default: orders

  • Requires a value

--limit, -l

Max entity items to sync. WARNING: Setting a high sync limit (or no limit) may result in a high server load (0=no limit).

  • 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

yotpo:update-metadata

Manually send platform metadata to Yotpo

1
bin/magento yotpo:update-metadata

Options

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