bin/magento (Adobe Commerce on-premises)

Version: 2.4.7-p1

This reference contains 141 commands available through the bin/magento command-line tool.
The initial list is auto generated using the bin/magento list command at Adobe Commerce.

General

Use the “Add CLI commands” guide to add a custom CLI command.

You can call bin/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 CLI command.

This reference documentation is generated from the application source code. To change the documentation, you should open a pull request for the corresponding command in the relevant codebase repository. See Code Contributions for more information.

Global options

--help, -h

Display help for the given command. When no command is given display help for the list command

--quiet, -q

Do not output any message

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

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

--version, -V

Display this application version

--ansi

Force (or disable --no-ansi) ANSI output

--no-ansi

Negate the “–ansi” option

--no-interaction, -n

Do not ask any interactive question

_complete

bin/magento _complete [-s|--shell SHELL] [-i|--input INPUT] [-c|--current CURRENT] [-a|--api-version API-VERSION] [-S|--symfony SYMFONY]

Internal command to provide shell completion suggestions

Options

For global options, see Global options.

--shell, -s

The shell type (“bash”, “fish”, “zsh”)

--input, -i

An array of input tokens (e.g. COMP_WORDS or argv)

--current, -c

The index of the “input” array that the cursor is in (e.g. COMP_CWORD)

--api-version, -a

The API version of the completion script

--symfony, -S

deprecated

completion

bin/magento completion [--debug] [--] [<shell>]

Dump the shell completion script

The completion command dumps the shell completion script required
to use shell autocompletion (currently, bash, fish, zsh completion are supported).

Static installation
-------------------

Dump the script to a global completion file and restart your shell:

    bin/magento completion  | sudo tee /etc/bash_completion.d/magento

Or dump the script to a local file and source it:

    bin/magento completion  > completion.sh

    # source the file whenever you use the project
    source completion.sh

    # or add this line at the end of your "~/.bashrc" file:
    source /path/to/completion.sh

Dynamic installation
--------------------

Add this to the end of your shell configuration file (e.g. "~/.bashrc"):

    eval "$(/var/www/html/magento2/bin/magento completion )"

Arguments

shell

The shell type (e.g. “bash”), the value of the “$SHELL” env var will be used if this is not given

Options

For global options, see Global options.

--debug

Tail the completion debug log

help

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

Display help for a command

The help command displays help for a given command:

  bin/magento help list

You can also output the help in other formats by using the --format option:

  bin/magento help --format=xml list

To display the list of available commands, please use the list command.

Arguments

command_name

The command name

Options

For global options, see Global options.

--format

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

--raw

To output raw command help

list

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

List commands

The list command lists all commands:

  bin/magento list

You can also display the commands for a specific namespace:

  bin/magento list test

You can also output the information in other formats by using the --format option:

  bin/magento list --format=xml

It's also possible to get raw list of commands (useful for embedding command runner):

  bin/magento list --raw

Arguments

namespace

The namespace name

Options

For global options, see Global options.

--raw

To output raw command list

--format

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

--short

To skip describing commands’ arguments

admin:adobe-ims:disable

bin/magento admin:adobe-ims:disable

Disable Adobe IMS Module

Options

For global options, see Global options.

admin:adobe-ims:enable

bin/magento admin:adobe-ims:enable [-o|--organization-id [ORGANIZATION-ID]] [-c|--client-id [CLIENT-ID]] [-s|--client-secret [CLIENT-SECRET]] [-t|--2fa [2FA]]

Enable Adobe IMS Module.

Options

For global options, see Global options.

--organization-id, -o

Set Organization ID for Adobe IMS configuration. Required when enabling the module

--client-id, -c

Set the client ID for Adobe IMS configuration. Required when enabling the module

--client-secret, -s

Set the client Secret for Adobe IMS configuration. Required when enabling the module

--2fa, -t

Check if 2FA is enabled for Organization in Adobe Admin Console. Required when enabling the module

admin:adobe-ims:info

bin/magento admin:adobe-ims:info

Information of Adobe IMS Module configuration

Options

For global options, see Global options.

admin:adobe-ims:status

bin/magento admin:adobe-ims:status

Status of Adobe IMS Module

Options

For global options, see Global options.

admin:user:create

bin/magento admin:user:create [--admin-user ADMIN-USER] [--admin-password ADMIN-PASSWORD] [--admin-email ADMIN-EMAIL] [--admin-firstname ADMIN-FIRSTNAME] [--admin-lastname ADMIN-LASTNAME] [--magento-init-params MAGENTO-INIT-PARAMS]

Creates an administrator

Options

For global options, see Global options.

--admin-user

(Required) Admin user

--admin-password

(Required) Admin password

--admin-email

(Required) Admin email

--admin-firstname

(Required) Admin first name

--admin-lastname

(Required) Admin last name

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

admin:user:unlock

bin/magento admin:user:unlock <username>

Unlock Admin Account

This command unlocks an admin account by its username.
To unlock:
      bin/magento admin:user:unlock username

Arguments

username

The admin username to unlock

Options

For global options, see Global options.

app:config:dump

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

Create dump of application

Arguments

config-types

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

Options

For global options, see Global options.

app:config:import

bin/magento app:config:import

Import data from shared configuration files to appropriate data storage

Options

For global options, see Global options.

app:config:status

bin/magento app:config:status

Checks if config propagation requires update

Options

For global options, see Global options.

braintree:migrate

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

Migrate stored cards from a Magento 1 database

Options

For global options, see Global options.

--host

Hostname/IP. Port is optional

--dbname

Database name

--username

Database username. Must have read access

--password

Password

cache:clean

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

Cleans cache type(s)

Arguments

types

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

Options

For global options, see Global options.

--bootstrap

add or override parameters of the bootstrap

cache:disable

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

Disables cache type(s)

Arguments

types

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

Options

For global options, see Global options.

--bootstrap

add or override parameters of the bootstrap

cache:enable

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

Enables cache type(s)

Arguments

types

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

Options

For global options, see Global options.

--bootstrap

add or override parameters of the bootstrap

cache:flush

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

Flushes cache storage used by cache type(s)

Arguments

types

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

Options

For global options, see Global options.

--bootstrap

add or override parameters of the bootstrap

cache:status

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

Checks cache status

Options

For global options, see Global options.

--bootstrap

add or override parameters of the bootstrap

catalog:images:resize

bin/magento catalog:images:resize [-a|--async] [--skip_hidden_images]

Creates resized product images

Options

For global options, see Global options.

--async, -a

Resize image in asynchronous mode

--skip_hidden_images

Do not process images marked as hidden from product page

catalog:product:attributes:cleanup

bin/magento catalog:product:attributes:cleanup

Removes unused product attributes.

Options

For global options, see Global options.

cms:wysiwyg:restrict

bin/magento cms:wysiwyg:restrict <restrict>

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

Arguments

restrict

y\n

Options

For global options, see Global options.

config:sensitive:set

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

Set sensitive configuration values

Arguments

path

Configuration path for example group/section/field_name

value

Configuration value

Options

For global options, see Global options.

--interactive, -i

Enable interactive mode to set all sensitive variables

--scope

Scope for configuration, if not set use ‘default’

--scope-code

Scope code for configuration, empty string by default

config:set

bin/magento config:set [--scope SCOPE] [--scope-code SCOPE-CODE] [-e|--lock-env] [-c|--lock-config] [-l|--lock] [--] <path> <value>

Change system configuration

Arguments

path

Configuration path in format section/group/field_name

value

Configuration value

Options

For global options, see Global options.

--scope

Configuration scope (default, website, or store)

--scope-code

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

--lock-env, -e

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

--lock-config, -c

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

--lock, -l

Deprecated, use the --lock-env option instead.

config:show

bin/magento config:show [--scope [SCOPE]] [--scope-code [SCOPE-CODE]] [--] [<path>]

Shows configuration value for given path. If path is not specified, all saved values will be shown

Arguments

path

Configuration path, for example section_id/group_id/field_id

Options

For global options, see Global options.

--scope

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

--scope-code

Scope code (required only if scope is not default)

cron:install

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

Generates and installs crontab for current user

Options

For global options, see Global options.

--force, -f

Force install tasks

--non-optional, -d

Install only the non-optional (default) tasks

cron:remove

bin/magento cron:remove

Removes tasks from crontab

Options

For global options, see Global options.

cron:run

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

Runs jobs by schedule

Options

For global options, see Global options.

--group

Run jobs only from specified group

--exclude-group

Exclude jobs from the specified group

--bootstrap

Add or override parameters of the bootstrap

customer:hash:upgrade

bin/magento customer:hash:upgrade

Upgrade customer’s hash according to the latest algorithm

Options

For global options, see Global options.

deploy:mode:set

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

Set application mode.

Arguments

mode

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

Options

For global options, see Global options.

--skip-compilation, -s

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

deploy:mode:show

bin/magento deploy:mode:show

Displays current application mode.

Options

For global options, see Global options.

dev:di:info

bin/magento dev:di:info <class>

Provides information on Dependency Injection configuration for the Command.

Arguments

class

Class name

Options

For global options, see Global options.

dev:email:newsletter-compatibility-check

bin/magento dev:email:newsletter-compatibility-check

Scans newsletter templates for potential variable usage compatibility issues

Options

For global options, see Global options.

dev:email:override-compatibility-check

bin/magento dev:email:override-compatibility-check

Scans email template overrides for potential variable usage compatibility issues

Options

For global options, see Global options.

dev:profiler:disable

bin/magento dev:profiler:disable

Disable the profiler.

Options

For global options, see Global options.

dev:profiler:enable

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

Enable the profiler.

Arguments

type

Profiler type

Options

For global options, see Global options.

dev:query-log:disable

bin/magento dev:query-log:disable

Disable DB query logging

Options

For global options, see Global options.

dev:query-log:enable

bin/magento dev:query-log:enable [--include-all-queries [INCLUDE-ALL-QUERIES]] [--query-time-threshold [QUERY-TIME-THRESHOLD]] [--include-call-stack [INCLUDE-CALL-STACK]]

Enable DB query logging

Options

For global options, see Global options.

--include-all-queries

Log all queries. [true|false]

--query-time-threshold

Query time thresholds.

--include-call-stack

Include call stack. [true|false]

dev:source-theme:deploy

bin/magento dev:source-theme:deploy [--type TYPE] [--locale LOCALE] [--area AREA] [--theme THEME] [--] [<file>...]

Collects and publishes source files for theme.

Arguments

file

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

Options

For global options, see Global options.

--type

Type of source files: [less]

--locale

Locale: [en_US]

--area

Area: [frontend|adminhtml]

--theme

Theme: [Vendor/theme]

dev:template-hints:disable

bin/magento dev:template-hints:disable

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

Options

For global options, see Global options.

dev:template-hints:enable

bin/magento dev:template-hints:enable

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

Options

For global options, see Global options.

dev:template-hints:status

bin/magento dev:template-hints:status

Show frontend template hints status.

Options

For global options, see Global options.

dev:tests:run

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

Runs tests

Arguments

type

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

Options

For global options, see Global options.

--arguments, -c

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

dev:urn-catalog:generate

bin/magento dev:urn-catalog:generate [--ide IDE] [--] <path>

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

Arguments

path

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

Options

For global options, see Global options.

--ide

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

dev:xml:convert

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

Converts XML file using XSL style sheets

Arguments

xml-file

Path to XML file that going to be transformed

processor

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

Options

For global options, see Global options.

--overwrite, -o

Overwrite XML file

downloadable:domains:add

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

Add domains to the downloadable domains whitelist

Arguments

domains

Domains name

Options

For global options, see Global options.

downloadable:domains:remove

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

Remove domains from the downloadable domains whitelist

Arguments

domains

Domain names

Options

For global options, see Global options.

downloadable:domains:show

bin/magento downloadable:domains:show

Display downloadable domains whitelist

Options

For global options, see Global options.

encryption:payment-data:update

bin/magento encryption:payment-data:update

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

Options

For global options, see Global options.

events:create-event-provider

bin/magento events:create-event-provider [--label [LABEL]] [--description [DESCRIPTION]]events:provider:create

Create a custom event provider in Adobe I/O Events for this instance. If you do not specify the label and description options, they must be defined in the system app/etc/event-types.json file.

Options

For global options, see Global options.

--label

A label to define your custom provider.

--description

A description of your provider.

events:generate:module

bin/magento events:generate:module

Generate module based on plugins list

Options

For global options, see Global options.

events:info

bin/magento events:info [--depth [DEPTH]] [--] <event-code>

Returns the payload of the specified event.

Arguments

event-code

Event code

Options

For global options, see Global options.

--depth

The number of levels in the event payload to return

events:list

bin/magento events:list

Shows list of subscribed events

Options

For global options, see Global options.

events:list:all

bin/magento events:list:all <module_name>

Returns a list of subscribable events defined in the specified module

Arguments

module_name

Module name

Options

For global options, see Global options.

events:metadata:populate

bin/magento events:metadata:populate

Creates metadata in Adobe I/O from the configuration list (XML and application configurations)

Options

For global options, see Global options.

events:provider:info

bin/magento events:provider:info

Returns details about the configured event provider

Options

For global options, see Global options.

events:registrations:list

bin/magento events:registrations:list

Lists event registrations in your App Builder project

Options

For global options, see Global options.

events:subscribe

bin/magento events:subscribe [-f|--force] [--fields FIELDS] [--parent PARENT] [--rules RULES] [-p|--priority] [-d|--destination DESTINATION] [--hipaaAuditRequired] [--] <event-code>

Subscribes to the event

Arguments

event-code

Event code

Options

For global options, see Global options.

--force, -f

Forces the specified event to be subscribed, even if it hasn’t been defined locally.

--fields

The list of fields in the event data payload.

--parent

The parent event code for an event subscription with rules.

--rules

The list of rules for the event subscription, where each rule is formatted as “field|operator|value”.

--priority, -p

Expedites the transmission of this event. Specify this option for events that need to be delivered immediately. By default, events are sent by cron once per minute.

--destination, -d

The destination of this event. Specify this option for the events that should be delivered to the custom destination.

--hipaaAuditRequired

Indicates the event contains data that is subject to HIPAA auditing.

events:sync-events-metadata

bin/magento events:sync-events-metadata [-d|--delete]

Synchronise event metadata for this instance

Options

For global options, see Global options.

--delete, -d

Delete events metadata no longer required

events:unsubscribe

bin/magento events:unsubscribe <event-code>

Removes the subscription to the supplied event

Arguments

event-code

Event code to unsubscribe from

Options

For global options, see Global options.

i18n:collect-phrases

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

Discovers phrases in the codebase

Arguments

directory

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

Options

For global options, see Global options.

--output, -o

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

--magento, -m

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

i18n:pack

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

Saves language package

Arguments

source

Path to source dictionary file with translations

locale

Target locale for dictionary, for example “de_DE”

Options

For global options, see Global options.

--mode, -m

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

--allow-duplicates, -d

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

i18n:uninstall

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

Uninstalls language packages

Arguments

package

Language package name

Options

For global options, see Global options.

--backup-code, -b

Take code and configuration files backup (excluding temporary files)

indexer:info

bin/magento indexer:info

Shows allowed Indexers

Options

For global options, see Global options.

indexer:reindex

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

Reindexes Data

Arguments

index

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

Options

For global options, see Global options.

indexer:reset

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

Resets indexer status to invalid

Arguments

index

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

Options

For global options, see Global options.

indexer:set-dimensions-mode

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

Set Indexer Dimensions Mode

Arguments

indexer

Indexer name [catalog_product_price|catalogpermissions_category]

mode

Indexer dimension modes catalog_product_price none,website,customer_group,website_and_customer_group catalogpermissions_category none,customer_group

Options

For global options, see Global options.

indexer:set-mode

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

Sets index mode type

Arguments

mode

Indexer mode type [realtime|schedule]

index

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

Options

For global options, see Global options.

indexer:set-status

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

Sets the specified indexer status

Arguments

status

Indexer status type [invalid|suspended|valid]

index

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

Options

For global options, see Global options.

indexer:show-dimensions-mode

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

Shows Indexer Dimension Mode

Arguments

indexer

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

Options

For global options, see Global options.

indexer:show-mode

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

Shows Index Mode

Arguments

index

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

Options

For global options, see Global options.

indexer:status

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

Shows status of Indexer

Arguments

index

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

Options

For global options, see Global options.

info:adminuri

bin/magento info:adminuri

Displays the Magento Admin URI

Options

For global options, see Global options.

info:backups:list

bin/magento info:backups:list

Prints list of available backup files

Options

For global options, see Global options.

info:currency:list

bin/magento info:currency:list

Displays the list of available currencies

Options

For global options, see Global options.

info:dependencies:show-framework

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

Shows number of dependencies on Magento framework

Options

For global options, see Global options.

--output, -o

Report filename

info:dependencies:show-modules

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

Shows number of dependencies between modules

Options

For global options, see Global options.

--output, -o

Report filename

info:dependencies:show-modules-circular

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

Shows number of circular dependencies between modules

Options

For global options, see Global options.

--output, -o

Report filename

info:language:list

bin/magento info:language:list

Displays the list of available language locales

Options

For global options, see Global options.

info:timezone:list

bin/magento info:timezone:list

Displays the list of available timezones

Options

For global options, see Global options.

inventory:reservation:create-compensations

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

Create reservations by provided compensation arguments

Arguments

compensations

List of compensation arguments in format “:::”

Options

For global options, see Global options.

--raw, -r

Raw output

inventory:reservation:list-inconsistencies

bin/magento inventory:reservation:list-inconsistencies [-c|--complete-orders] [-i|--incomplete-orders] [-b|--bunch-size [BUNCH-SIZE]] [-r|--raw]

Show all orders and products with salable quantity inconsistencies

Options

For global options, see Global options.

--complete-orders, -c

Show only inconsistencies for complete orders

--incomplete-orders, -i

Show only inconsistencies for incomplete orders

--bunch-size, -b

Defines how many orders will be loaded at once

--raw, -r

Raw output

inventory-geonames:import

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

Download and import geo names for source selection algorithm

Arguments

countries

List of country codes to import

Options

For global options, see Global options.

maintenance:allow-ips

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

Sets maintenance mode exempt IPs

Arguments

ip

Allowed IP addresses

Options

For global options, see Global options.

--none

Clear allowed IP addresses

--add

Add the IP address to existing list

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

maintenance:disable

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

Disables maintenance mode

Options

For global options, see Global options.

--ip

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

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

maintenance:enable

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

Enables maintenance mode

Options

For global options, see Global options.

--ip

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

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

maintenance:status

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

Displays maintenance mode status

Options

For global options, see Global options.

--magento-init-params

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

media-content:sync

bin/magento media-content:sync

Synchronize content with assets

Options

For global options, see Global options.

media-gallery:sync

bin/magento media-gallery:sync

Synchronize media storage and media assets in the database

Options

For global options, see Global options.

module:config:status

bin/magento module:config:status

Checks the modules configuration in the ‘app/etc/config.php’ file and reports if they are up to date or not

Options

For global options, see Global options.

module:disable

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

Disables specified modules

Arguments

module

Name of the module

Options

For global options, see Global options.

--force, -f

Bypass dependencies check

--all

Disable all modules

--clear-static-content, -c

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

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

module:enable

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

Enables specified modules

Arguments

module

Name of the module

Options

For global options, see Global options.

--force, -f

Bypass dependencies check

--all

Enable all modules

--clear-static-content, -c

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

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

module:status

bin/magento module:status [--enabled] [--disabled] [--magento-init-params MAGENTO-INIT-PARAMS] [--] [<module-names>...]

Displays status of modules

Arguments

module-names

Optional module name

Options

For global options, see Global options.

--enabled

Print only enabled modules

--disabled

Print only disabled modules

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

module:uninstall

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

Uninstalls modules installed by composer

Arguments

module

Name of the module

Options

For global options, see Global options.

--remove-data, -r

Remove data installed by module(s)

--backup-code

Take code and configuration files backup (excluding temporary files)

--backup-media

Take media backup

--backup-db

Take complete database backup

--non-composer

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

--clear-static-content, -c

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

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

newrelic:create:deploy-marker

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

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

Arguments

message

Deploy Message?

change_log

Change Log?

user

Deployment User

revision

Revision

Options

For global options, see Global options.

queue:consumers:list

bin/magento queue:consumers:list

List of MessageQueue consumers

This command shows list of MessageQueue consumers.

Options

For global options, see Global options.

queue:consumers:restart

bin/magento queue:consumers:restart

Restart MessageQueue consumers

Command put poison pill for MessageQueue consumers and force to restart them after next status check.

Options

For global options, see Global options.

queue:consumers:start

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

Start MessageQueue consumer

This command starts MessageQueue consumer by its name.

To start consumer which will process all queued messages and terminate execution:

    bin/magento queue:consumers:start someConsumer

To specify the number of messages which should be processed by consumer before its termination:

    bin/magento queue:consumers:start someConsumer --max-messages=50

To specify the number of messages per batch for the batch consumer:

    bin/magento queue:consumers:start someConsumer --batch-size=500

To specify the preferred area:

    bin/magento queue:consumers:start someConsumer --area-code='adminhtml'

To do not run multiple copies of one consumer simultaneously:

    bin/magento queue:consumers:start someConsumer --single-thread

To save PID enter path (This option is deprecated, use --single-thread instead):

    bin/magento queue:consumers:start someConsumer --pid-file-path='/var/someConsumer.pid'

To define the number of processes per consumer:

    bin/magento queue:consumers:start someConsumer --multi-process=4

Arguments

consumer

The name of the consumer to be started.

Options

For global options, see Global options.

--max-messages

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

--batch-size

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

--area-code

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

--single-thread

This option prevents running multiple copies of one consumer simultaneously.

--multi-process

The number of processes per consumer.

--pid-file-path

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

remote-storage:sync

bin/magento remote-storage:sync

Synchronize media files with remote storage.

Options

For global options, see Global options.

saas:resync

bin/magento saas:resync [--feed FEED] [--no-reindex] [--cleanup-feed] [--dry-run] [--thread-count THREAD-COUNT] [--batch-size BATCH-SIZE] [--continue-resync]

Re-syncs feed data to SaaS service.

Options

For global options, see Global options.

--feed

Feed name to fully re-sync to SaaS service. Available feeds: Payment Services Order Production, Payment Services Order Sandbox, Payment Services Order Status Production, Payment Services Order Status Sandbox, Payment Services Store Production, Payment Services Store Sandbox

--no-reindex

Run re-submission of feed data to SaaS service only. Does not re-index. (This option is not applicable to the products, productoverrides, prices feeds)

--cleanup-feed

Force to cleanup feed indexer table before sync.

--dry-run

Dry run. Data will not be exported. To save payload to log file var/log/saas-export.log run with env variable EXPORTER_EXTENDED_LOG=1.

--thread-count

Set synchronization thread count.

--batch-size

Set synchronization batch size

--continue-resync

Continue resync from the last stored position (This option is applicable to the products, productoverrides, prices feeds)

sampledata:deploy

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

Deploy sample data modules for composer-based Magento installations

Options

For global options, see Global options.

--no-update

Update composer.json without executing composer update

sampledata:remove

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

Remove all sample data packages from composer.json

Options

For global options, see Global options.

--no-update

Update composer.json without executing composer update

sampledata:reset

bin/magento sampledata:reset

Reset all sample data modules for re-installation

Options

For global options, see Global options.

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

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

Disable reCAPTCHA for admin user forgot password form

Options

For global options, see Global options.

security:recaptcha:disable-for-user-login

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

Disable reCAPTCHA for admin user login form

Options

For global options, see Global options.

security:tfa:google:set-secret

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

Set the secret used for Google OTP generation.

Arguments

user

Username

secret

Secret

Options

For global options, see Global options.

security:tfa:providers

bin/magento security:tfa:providers

List all available providers

Options

For global options, see Global options.

security:tfa:reset

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

Reset configuration for one user

Arguments

user

Username

provider

Provider code

Options

For global options, see Global options.

server:run

bin/magento server:run [-p|--port [PORT]] [-b|--background [BACKGROUND]] [-wn|--workerNum [WORKERNUM]] [-dm|--dispatchMode [DISPATCHMODE]] [-mr|--maxRequests [MAXREQUESTS]] [-a|--area [AREA]] [-mip|--magento-init-params [MAGENTO-INIT-PARAMS]] [-mwt|--maxWaitTime [MAXWAITTIME]] [--state-monitor]

Run application server

Options

For global options, see Global options.

--port, -p

port to serv on

--background, -b

background mode flag

--workerNum, -wn

number of worker processes to start

--dispatchMode, -dm

mode of dispatching connections to the worker processes

--maxRequests, -mr

max requests before worker process would be restarted

--area, -a

application server area

--magento-init-params, -mip

magento bootstrap init params

--maxWaitTime, -mwt

how long to wait for workers after reload (eg. config change) before killing them

--state-monitor

Enable state monitoring. Use this only for debugging state issues!

server:state-monitor:aggregate-output

bin/magento server:state-monitor:aggregate-output

Aggregate output from state monitor of ApplicationServer

Options

For global options, see Global options.

setup:backup

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

Takes backup of Magento Application code base, media and database

Options

For global options, see Global options.

--code

Take code and configuration files backup (excluding temporary files)

--media

Take media backup

--db

Take complete database backup

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

setup:config:set

bin/magento setup:config:set [--enable-debug-logging ENABLE-DEBUG-LOGGING] [--enable-syslog-logging ENABLE-SYSLOG-LOGGING] [--backend-frontname BACKEND-FRONTNAME] [--remote-storage-driver REMOTE-STORAGE-DRIVER] [--remote-storage-prefix REMOTE-STORAGE-PREFIX] [--remote-storage-endpoint REMOTE-STORAGE-ENDPOINT] [--remote-storage-bucket REMOTE-STORAGE-BUCKET] [--remote-storage-region REMOTE-STORAGE-REGION] [--remote-storage-key REMOTE-STORAGE-KEY] [--remote-storage-secret REMOTE-STORAGE-SECRET] [--remote-storage-path-style REMOTE-STORAGE-PATH-STYLE] [--id_salt ID_SALT] [--config-async CONFIG-ASYNC] [--checkout-async CHECKOUT-ASYNC] [--amqp-host AMQP-HOST] [--amqp-port AMQP-PORT] [--amqp-user AMQP-USER] [--amqp-password AMQP-PASSWORD] [--amqp-virtualhost AMQP-VIRTUALHOST] [--amqp-ssl AMQP-SSL] [--amqp-ssl-options AMQP-SSL-OPTIONS] [--consumers-wait-for-messages CONSUMERS-WAIT-FOR-MESSAGES] [--queue-default-connection QUEUE-DEFAULT-CONNECTION] [--deferred-total-calculating DEFERRED-TOTAL-CALCULATING] [--key KEY] [--db-host DB-HOST] [--db-name DB-NAME] [--db-user DB-USER] [--db-engine DB-ENGINE] [--db-password DB-PASSWORD] [--db-prefix DB-PREFIX] [--db-model DB-MODEL] [--db-init-statements DB-INIT-STATEMENTS] [-s|--skip-db-validation] [--http-cache-hosts HTTP-CACHE-HOSTS] [--db-ssl-key DB-SSL-KEY] [--db-ssl-cert DB-SSL-CERT] [--db-ssl-ca DB-SSL-CA] [--db-ssl-verify] [--session-save SESSION-SAVE] [--session-save-redis-host SESSION-SAVE-REDIS-HOST] [--session-save-redis-port SESSION-SAVE-REDIS-PORT] [--session-save-redis-password SESSION-SAVE-REDIS-PASSWORD] [--session-save-redis-timeout SESSION-SAVE-REDIS-TIMEOUT] [--session-save-redis-persistent-id SESSION-SAVE-REDIS-PERSISTENT-ID] [--session-save-redis-db SESSION-SAVE-REDIS-DB] [--session-save-redis-compression-threshold SESSION-SAVE-REDIS-COMPRESSION-THRESHOLD] [--session-save-redis-compression-lib SESSION-SAVE-REDIS-COMPRESSION-LIB] [--session-save-redis-log-level SESSION-SAVE-REDIS-LOG-LEVEL] [--session-save-redis-max-concurrency SESSION-SAVE-REDIS-MAX-CONCURRENCY] [--session-save-redis-break-after-frontend SESSION-SAVE-REDIS-BREAK-AFTER-FRONTEND] [--session-save-redis-break-after-adminhtml SESSION-SAVE-REDIS-BREAK-AFTER-ADMINHTML] [--session-save-redis-first-lifetime SESSION-SAVE-REDIS-FIRST-LIFETIME] [--session-save-redis-bot-first-lifetime SESSION-SAVE-REDIS-BOT-FIRST-LIFETIME] [--session-save-redis-bot-lifetime SESSION-SAVE-REDIS-BOT-LIFETIME] [--session-save-redis-disable-locking SESSION-SAVE-REDIS-DISABLE-LOCKING] [--session-save-redis-min-lifetime SESSION-SAVE-REDIS-MIN-LIFETIME] [--session-save-redis-max-lifetime SESSION-SAVE-REDIS-MAX-LIFETIME] [--session-save-redis-sentinel-master SESSION-SAVE-REDIS-SENTINEL-MASTER] [--session-save-redis-sentinel-servers SESSION-SAVE-REDIS-SENTINEL-SERVERS] [--session-save-redis-sentinel-verify-master SESSION-SAVE-REDIS-SENTINEL-VERIFY-MASTER] [--session-save-redis-sentinel-connect-retries SESSION-SAVE-REDIS-SENTINEL-CONNECT-RETRIES] [--cache-backend CACHE-BACKEND] [--cache-backend-redis-server CACHE-BACKEND-REDIS-SERVER] [--cache-backend-redis-db CACHE-BACKEND-REDIS-DB] [--cache-backend-redis-port CACHE-BACKEND-REDIS-PORT] [--cache-backend-redis-password CACHE-BACKEND-REDIS-PASSWORD] [--cache-backend-redis-compress-data CACHE-BACKEND-REDIS-COMPRESS-DATA] [--cache-backend-redis-compression-lib CACHE-BACKEND-REDIS-COMPRESSION-LIB] [--cache-backend-redis-use-lua CACHE-BACKEND-REDIS-USE-LUA] [--cache-id-prefix CACHE-ID-PREFIX] [--allow-parallel-generation] [--page-cache PAGE-CACHE] [--page-cache-redis-server PAGE-CACHE-REDIS-SERVER] [--page-cache-redis-db PAGE-CACHE-REDIS-DB] [--page-cache-redis-port PAGE-CACHE-REDIS-PORT] [--page-cache-redis-password PAGE-CACHE-REDIS-PASSWORD] [--page-cache-redis-compress-data PAGE-CACHE-REDIS-COMPRESS-DATA] [--page-cache-redis-compression-lib PAGE-CACHE-REDIS-COMPRESSION-LIB] [--page-cache-id-prefix PAGE-CACHE-ID-PREFIX] [--lock-provider LOCK-PROVIDER] [--lock-db-prefix LOCK-DB-PREFIX] [--lock-zookeeper-host LOCK-ZOOKEEPER-HOST] [--lock-zookeeper-path LOCK-ZOOKEEPER-PATH] [--lock-file-path LOCK-FILE-PATH] [--document-root-is-pub DOCUMENT-ROOT-IS-PUB] [--backpressure-logger BACKPRESSURE-LOGGER] [--backpressure-logger-redis-server BACKPRESSURE-LOGGER-REDIS-SERVER] [--backpressure-logger-redis-port BACKPRESSURE-LOGGER-REDIS-PORT] [--backpressure-logger-redis-timeout BACKPRESSURE-LOGGER-REDIS-TIMEOUT] [--backpressure-logger-redis-persistent BACKPRESSURE-LOGGER-REDIS-PERSISTENT] [--backpressure-logger-redis-db BACKPRESSURE-LOGGER-REDIS-DB] [--backpressure-logger-redis-password BACKPRESSURE-LOGGER-REDIS-PASSWORD] [--backpressure-logger-redis-user BACKPRESSURE-LOGGER-REDIS-USER] [--backpressure-logger-id-prefix BACKPRESSURE-LOGGER-ID-PREFIX] [--magento-init-params MAGENTO-INIT-PARAMS]

Creates or modifies the deployment configuration

Options

For global options, see Global options.

--enable-debug-logging

Enable debug logging

--enable-syslog-logging

Enable syslog logging

--backend-frontname

Backend frontname (will be autogenerated if missing)

--remote-storage-driver

Remote storage driver

--remote-storage-prefix

Remote storage prefix

--remote-storage-endpoint

Remote storage endpoint

--remote-storage-bucket

Remote storage bucket

--remote-storage-region

Remote storage region

--remote-storage-key

Remote storage access key

--remote-storage-secret

Remote storage secret key

--remote-storage-path-style

Remote storage path style

--id_salt

GraphQl Salt

--config-async

Enable async Admin Config Save? 1 - Yes, 0 - No

--checkout-async

Enable async order processing? 1 - Yes, 0 - No

--amqp-host

Amqp server host

--amqp-port

Amqp server port

--amqp-user

Amqp server username

--amqp-password

Amqp server password

--amqp-virtualhost

Amqp virtualhost

--amqp-ssl

Amqp SSL

--amqp-ssl-options

Amqp SSL Options (JSON)

--consumers-wait-for-messages

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

--queue-default-connection

Message queues default connection. Can be ‘db’, ‘amqp’ or a custom queue system.The queue system must be installed and configured, otherwise messages won’t be processed correctly.

--deferred-total-calculating

Enable deferred total calculating? 1 - Yes, 0 - No

--key

Encryption key

--db-host

Database server host

--db-name

Database name

--db-user

Database server username

--db-engine

Database server engine

--db-password

Database server password

--db-prefix

Database table prefix

--db-model

Database type

--db-init-statements

Database initial set of commands

--skip-db-validation, -s

If specified, then db connection validation will be skipped

--http-cache-hosts

http Cache hosts

--db-ssl-key

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

--db-ssl-cert

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

--db-ssl-ca

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

--db-ssl-verify

Verify server certification

--session-save

Session save handler

--session-save-redis-host

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

--session-save-redis-port

Redis server listen port

--session-save-redis-password

Redis server password

--session-save-redis-timeout

Connection timeout, in seconds

--session-save-redis-persistent-id

Unique string to enable persistent connections

--session-save-redis-db

Redis database number

--session-save-redis-compression-threshold

Redis compression threshold

--session-save-redis-compression-lib

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

--session-save-redis-log-level

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

--session-save-redis-max-concurrency

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

--session-save-redis-break-after-frontend

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

--session-save-redis-break-after-adminhtml

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

--session-save-redis-first-lifetime

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

--session-save-redis-bot-first-lifetime

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

--session-save-redis-bot-lifetime

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

--session-save-redis-disable-locking

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

--session-save-redis-min-lifetime

Redis min session lifetime, in seconds

--session-save-redis-max-lifetime

Redis max session lifetime, in seconds

--session-save-redis-sentinel-master

Redis Sentinel master

--session-save-redis-sentinel-servers

Redis Sentinel servers, comma separated

--session-save-redis-sentinel-verify-master

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

--session-save-redis-sentinel-connect-retries

Redis Sentinel connect retries.

--cache-backend

Default cache handler

--cache-backend-redis-server

Redis server

--cache-backend-redis-db

Database number for the cache

--cache-backend-redis-port

Redis server listen port

--cache-backend-redis-password

Redis server password

--cache-backend-redis-compress-data

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

--cache-backend-redis-compression-lib

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

--cache-backend-redis-use-lua

Set to 1 to enable lua (default is 0, disabled)

--cache-id-prefix

ID prefix for cache keys

--allow-parallel-generation

Allow generate cache in non-blocking way

--page-cache

Default cache handler

--page-cache-redis-server

Redis server

--page-cache-redis-db

Database number for the cache

--page-cache-redis-port

Redis server listen port

--page-cache-redis-password

Redis server password

--page-cache-redis-compress-data

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

--page-cache-redis-compression-lib

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

--page-cache-id-prefix

ID prefix for cache keys

--lock-provider

Lock provider name

--lock-db-prefix

Installation specific lock prefix to avoid lock conflicts

--lock-zookeeper-host

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

--lock-zookeeper-path

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

--lock-file-path

The path where file locks will be saved.

--document-root-is-pub

Flag to show is Pub is on root, can be true or false only

--backpressure-logger

Backpressure logger handler

--backpressure-logger-redis-server

Redis server

--backpressure-logger-redis-port

Redis server listen port

--backpressure-logger-redis-timeout

Redis server timeout

--backpressure-logger-redis-persistent

Redis persistent

--backpressure-logger-redis-db

Redis db number

--backpressure-logger-redis-password

Redis server password

--backpressure-logger-redis-user

Redis server user

--backpressure-logger-id-prefix

ID prefix for keys

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

setup:db-data:upgrade

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

Installs and upgrades data in the DB

Options

For global options, see Global options.

--magento-init-params

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

setup:db-declaration:generate-patch

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

Generate patch and put it in specific folder.

Arguments

module

Module name

patch

Patch name

Options

For global options, see Global options.

--revertable

Check whether patch is revertable or not.

--type

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

setup:db-declaration:generate-whitelist

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

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

Options

For global options, see Global options.

--module-name

Name of the module where whitelist will be generated

setup:db-schema:add-slave

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

Move checkout quote related tables to a separate DB server

Options

For global options, see Global options.

--host

Slave DB Server host

--dbname

Slave Database Name

--username

Slave DB user name

--password

Slave DB user password

--connection

Slave connection name

--resource

Slave Resource name

--maxAllowedLag

Max Allowed Lag Slave Connection (in seconds)

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

setup:db-schema:split-quote

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]

Move checkout quote related tables to a separate DB server. Deprecated since 2.4.2 and will be removed

Options

For global options, see Global options.

--host

Checkout DB Server host

--dbname

Checkout Database Name

--username

Checkout DB user name

--password

Checkout DB user password

--connection

Checkout connection name

--resource

Checkout resource name

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

setup:db-schema:split-sales

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]

Move sales related tables to a separate DB server. Deprecated since 2.4.2 and will be removed

Options

For global options, see Global options.

--host

Sales DB Server host

--dbname

Sales Database Name

--username

Sales DB user name

--password

Sales DB user passowrd

--connection

Sales connection name

--resource

Sales resource name

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

setup:db-schema:upgrade

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

Installs and upgrades the DB schema

Options

For global options, see Global options.

--convert-old-scripts

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

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

setup:db:status

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

Checks if DB schema or data requires upgrade

Options

For global options, see Global options.

--magento-init-params

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

setup:di:compile

bin/magento setup:di:compile

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

Options

For global options, see Global options.

setup:install

bin/magento setup:install [--enable-debug-logging ENABLE-DEBUG-LOGGING] [--enable-syslog-logging ENABLE-SYSLOG-LOGGING] [--backend-frontname BACKEND-FRONTNAME] [--remote-storage-driver REMOTE-STORAGE-DRIVER] [--remote-storage-prefix REMOTE-STORAGE-PREFIX] [--remote-storage-endpoint REMOTE-STORAGE-ENDPOINT] [--remote-storage-bucket REMOTE-STORAGE-BUCKET] [--remote-storage-region REMOTE-STORAGE-REGION] [--remote-storage-key REMOTE-STORAGE-KEY] [--remote-storage-secret REMOTE-STORAGE-SECRET] [--remote-storage-path-style REMOTE-STORAGE-PATH-STYLE] [--id_salt ID_SALT] [--config-async CONFIG-ASYNC] [--checkout-async CHECKOUT-ASYNC] [--amqp-host AMQP-HOST] [--amqp-port AMQP-PORT] [--amqp-user AMQP-USER] [--amqp-password AMQP-PASSWORD] [--amqp-virtualhost AMQP-VIRTUALHOST] [--amqp-ssl AMQP-SSL] [--amqp-ssl-options AMQP-SSL-OPTIONS] [--consumers-wait-for-messages CONSUMERS-WAIT-FOR-MESSAGES] [--queue-default-connection QUEUE-DEFAULT-CONNECTION] [--deferred-total-calculating DEFERRED-TOTAL-CALCULATING] [--key KEY] [--db-host DB-HOST] [--db-name DB-NAME] [--db-user DB-USER] [--db-engine DB-ENGINE] [--db-password DB-PASSWORD] [--db-prefix DB-PREFIX] [--db-model DB-MODEL] [--db-init-statements DB-INIT-STATEMENTS] [-s|--skip-db-validation] [--http-cache-hosts HTTP-CACHE-HOSTS] [--db-ssl-key DB-SSL-KEY] [--db-ssl-cert DB-SSL-CERT] [--db-ssl-ca DB-SSL-CA] [--db-ssl-verify] [--session-save SESSION-SAVE] [--session-save-redis-host SESSION-SAVE-REDIS-HOST] [--session-save-redis-port SESSION-SAVE-REDIS-PORT] [--session-save-redis-password SESSION-SAVE-REDIS-PASSWORD] [--session-save-redis-timeout SESSION-SAVE-REDIS-TIMEOUT] [--session-save-redis-persistent-id SESSION-SAVE-REDIS-PERSISTENT-ID] [--session-save-redis-db SESSION-SAVE-REDIS-DB] [--session-save-redis-compression-threshold SESSION-SAVE-REDIS-COMPRESSION-THRESHOLD] [--session-save-redis-compression-lib SESSION-SAVE-REDIS-COMPRESSION-LIB] [--session-save-redis-log-level SESSION-SAVE-REDIS-LOG-LEVEL] [--session-save-redis-max-concurrency SESSION-SAVE-REDIS-MAX-CONCURRENCY] [--session-save-redis-break-after-frontend SESSION-SAVE-REDIS-BREAK-AFTER-FRONTEND] [--session-save-redis-break-after-adminhtml SESSION-SAVE-REDIS-BREAK-AFTER-ADMINHTML] [--session-save-redis-first-lifetime SESSION-SAVE-REDIS-FIRST-LIFETIME] [--session-save-redis-bot-first-lifetime SESSION-SAVE-REDIS-BOT-FIRST-LIFETIME] [--session-save-redis-bot-lifetime SESSION-SAVE-REDIS-BOT-LIFETIME] [--session-save-redis-disable-locking SESSION-SAVE-REDIS-DISABLE-LOCKING] [--session-save-redis-min-lifetime SESSION-SAVE-REDIS-MIN-LIFETIME] [--session-save-redis-max-lifetime SESSION-SAVE-REDIS-MAX-LIFETIME] [--session-save-redis-sentinel-master SESSION-SAVE-REDIS-SENTINEL-MASTER] [--session-save-redis-sentinel-servers SESSION-SAVE-REDIS-SENTINEL-SERVERS] [--session-save-redis-sentinel-verify-master SESSION-SAVE-REDIS-SENTINEL-VERIFY-MASTER] [--session-save-redis-sentinel-connect-retries SESSION-SAVE-REDIS-SENTINEL-CONNECT-RETRIES] [--cache-backend CACHE-BACKEND] [--cache-backend-redis-server CACHE-BACKEND-REDIS-SERVER] [--cache-backend-redis-db CACHE-BACKEND-REDIS-DB] [--cache-backend-redis-port CACHE-BACKEND-REDIS-PORT] [--cache-backend-redis-password CACHE-BACKEND-REDIS-PASSWORD] [--cache-backend-redis-compress-data CACHE-BACKEND-REDIS-COMPRESS-DATA] [--cache-backend-redis-compression-lib CACHE-BACKEND-REDIS-COMPRESSION-LIB] [--cache-backend-redis-use-lua CACHE-BACKEND-REDIS-USE-LUA] [--cache-id-prefix CACHE-ID-PREFIX] [--allow-parallel-generation] [--page-cache PAGE-CACHE] [--page-cache-redis-server PAGE-CACHE-REDIS-SERVER] [--page-cache-redis-db PAGE-CACHE-REDIS-DB] [--page-cache-redis-port PAGE-CACHE-REDIS-PORT] [--page-cache-redis-password PAGE-CACHE-REDIS-PASSWORD] [--page-cache-redis-compress-data PAGE-CACHE-REDIS-COMPRESS-DATA] [--page-cache-redis-compression-lib PAGE-CACHE-REDIS-COMPRESSION-LIB] [--page-cache-id-prefix PAGE-CACHE-ID-PREFIX] [--lock-provider LOCK-PROVIDER] [--lock-db-prefix LOCK-DB-PREFIX] [--lock-zookeeper-host LOCK-ZOOKEEPER-HOST] [--lock-zookeeper-path LOCK-ZOOKEEPER-PATH] [--lock-file-path LOCK-FILE-PATH] [--document-root-is-pub DOCUMENT-ROOT-IS-PUB] [--backpressure-logger BACKPRESSURE-LOGGER] [--backpressure-logger-redis-server BACKPRESSURE-LOGGER-REDIS-SERVER] [--backpressure-logger-redis-port BACKPRESSURE-LOGGER-REDIS-PORT] [--backpressure-logger-redis-timeout BACKPRESSURE-LOGGER-REDIS-TIMEOUT] [--backpressure-logger-redis-persistent BACKPRESSURE-LOGGER-REDIS-PERSISTENT] [--backpressure-logger-redis-db BACKPRESSURE-LOGGER-REDIS-DB] [--backpressure-logger-redis-password BACKPRESSURE-LOGGER-REDIS-PASSWORD] [--backpressure-logger-redis-user BACKPRESSURE-LOGGER-REDIS-USER] [--backpressure-logger-id-prefix BACKPRESSURE-LOGGER-ID-PREFIX] [--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] [--opensearch-host OPENSEARCH-HOST] [--opensearch-port OPENSEARCH-PORT] [--opensearch-enable-auth OPENSEARCH-ENABLE-AUTH] [--opensearch-username OPENSEARCH-USERNAME] [--opensearch-password OPENSEARCH-PASSWORD] [--opensearch-index-prefix OPENSEARCH-INDEX-PREFIX] [--opensearch-timeout OPENSEARCH-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]

Installs the Magento application

Options

For global options, see Global options.

--enable-debug-logging

Enable debug logging

--enable-syslog-logging

Enable syslog logging

--backend-frontname

Backend frontname (will be autogenerated if missing)

--remote-storage-driver

Remote storage driver

--remote-storage-prefix

Remote storage prefix

--remote-storage-endpoint

Remote storage endpoint

--remote-storage-bucket

Remote storage bucket

--remote-storage-region

Remote storage region

--remote-storage-key

Remote storage access key

--remote-storage-secret

Remote storage secret key

--remote-storage-path-style

Remote storage path style

--id_salt

GraphQl Salt

--config-async

Enable async Admin Config Save? 1 - Yes, 0 - No

--checkout-async

Enable async order processing? 1 - Yes, 0 - No

--amqp-host

Amqp server host

--amqp-port

Amqp server port

--amqp-user

Amqp server username

--amqp-password

Amqp server password

--amqp-virtualhost

Amqp virtualhost

--amqp-ssl

Amqp SSL

--amqp-ssl-options

Amqp SSL Options (JSON)

--consumers-wait-for-messages

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

--queue-default-connection

Message queues default connection. Can be ‘db’, ‘amqp’ or a custom queue system.The queue system must be installed and configured, otherwise messages won’t be processed correctly.

--deferred-total-calculating

Enable deferred total calculating? 1 - Yes, 0 - No

--key

Encryption key

--db-host

Database server host

--db-name

Database name

--db-user

Database server username

--db-engine

Database server engine

--db-password

Database server password

--db-prefix

Database table prefix

--db-model

Database type

--db-init-statements

Database initial set of commands

--skip-db-validation, -s

If specified, then db connection validation will be skipped

--http-cache-hosts

http Cache hosts

--db-ssl-key

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

--db-ssl-cert

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

--db-ssl-ca

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

--db-ssl-verify

Verify server certification

--session-save

Session save handler

--session-save-redis-host

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

--session-save-redis-port

Redis server listen port

--session-save-redis-password

Redis server password

--session-save-redis-timeout

Connection timeout, in seconds

--session-save-redis-persistent-id

Unique string to enable persistent connections

--session-save-redis-db

Redis database number

--session-save-redis-compression-threshold

Redis compression threshold

--session-save-redis-compression-lib

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

--session-save-redis-log-level

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

--session-save-redis-max-concurrency

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

--session-save-redis-break-after-frontend

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

--session-save-redis-break-after-adminhtml

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

--session-save-redis-first-lifetime

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

--session-save-redis-bot-first-lifetime

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

--session-save-redis-bot-lifetime

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

--session-save-redis-disable-locking

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

--session-save-redis-min-lifetime

Redis min session lifetime, in seconds

--session-save-redis-max-lifetime

Redis max session lifetime, in seconds

--session-save-redis-sentinel-master

Redis Sentinel master

--session-save-redis-sentinel-servers

Redis Sentinel servers, comma separated

--session-save-redis-sentinel-verify-master

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

--session-save-redis-sentinel-connect-retries

Redis Sentinel connect retries.

--cache-backend

Default cache handler

--cache-backend-redis-server

Redis server

--cache-backend-redis-db

Database number for the cache

--cache-backend-redis-port

Redis server listen port

--cache-backend-redis-password

Redis server password

--cache-backend-redis-compress-data

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

--cache-backend-redis-compression-lib

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

--cache-backend-redis-use-lua

Set to 1 to enable lua (default is 0, disabled)

--cache-id-prefix

ID prefix for cache keys

--allow-parallel-generation

Allow generate cache in non-blocking way

--page-cache

Default cache handler

--page-cache-redis-server

Redis server

--page-cache-redis-db

Database number for the cache

--page-cache-redis-port

Redis server listen port

--page-cache-redis-password

Redis server password

--page-cache-redis-compress-data

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

--page-cache-redis-compression-lib

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

--page-cache-id-prefix

ID prefix for cache keys

--lock-provider

Lock provider name

--lock-db-prefix

Installation specific lock prefix to avoid lock conflicts

--lock-zookeeper-host

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

--lock-zookeeper-path

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

--lock-file-path

The path where file locks will be saved.

--document-root-is-pub

Flag to show is Pub is on root, can be true or false only

--backpressure-logger

Backpressure logger handler

--backpressure-logger-redis-server

Redis server

--backpressure-logger-redis-port

Redis server listen port

--backpressure-logger-redis-timeout

Redis server timeout

--backpressure-logger-redis-persistent

Redis persistent

--backpressure-logger-redis-db

Redis db number

--backpressure-logger-redis-password

Redis server password

--backpressure-logger-redis-user

Redis server user

--backpressure-logger-id-prefix

ID prefix for keys

--base-url

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

--language

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

--timezone

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

--currency

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

--use-rewrites

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

--use-secure

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

--base-url-secure

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

--use-secure-admin

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

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

--admin-user

Admin user

--admin-password

Admin password

--admin-email

Admin email

--admin-firstname

Admin first name

--admin-lastname

Admin last name

--search-engine

Search engine. Values: elasticsearch7, elasticsearch8, opensearch

--elasticsearch-host

Elasticsearch server host.

--elasticsearch-port

Elasticsearch server port.

--elasticsearch-enable-auth

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

--elasticsearch-username

Elasticsearch username. Only applicable if HTTP auth is enabled

--elasticsearch-password

Elasticsearch password. Only applicable if HTTP auth is enabled

--elasticsearch-index-prefix

Elasticsearch index prefix.

--elasticsearch-timeout

Elasticsearch server timeout.

--opensearch-host

OpenSearch server host.

--opensearch-port

OpenSearch server port.

--opensearch-enable-auth

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

--opensearch-username

OpenSearch username. Only applicable if HTTP auth is enabled

--opensearch-password

OpenSearch password. Only applicable if HTTP auth is enabled

--opensearch-index-prefix

OpenSearch index prefix.

--opensearch-timeout

OpenSearch server timeout.

--cleanup-database

Cleanup the database before installation

--sales-order-increment-prefix

Sales order number prefix

--use-sample-data

Use sample data

--enable-modules

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

--disable-modules

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

--convert-old-scripts

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

--interactive, -i

Interactive Magento installation

--safe-mode

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

--data-restore

Restore removed data from dumps

--dry-run

Magento Installation will be run in dry-run mode

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

setup:performance:generate-fixtures

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

Generates fixtures

Arguments

profile

Path to profile configuration file

Options

For global options, see Global options.

--skip-reindex, -s

Skip reindex

setup:rollback

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]

Rolls back Magento Application codebase, media and database

Options

For global options, see Global options.

--code-file, -c

Basename of the code backup file in var/backups

--media-file, -m

Basename of the media backup file in var/backups

--db-file, -d

Basename of the db backup file in var/backups

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

setup:static-content:deploy

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] [--no-parent] [--] [<languages>...]

Deploys static view files

Arguments

languages

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

Options

For global options, see Global options.

--force, -f

Deploy files in any mode.

--strategy, -s

Deploy files using specified strategy.

--area, -a

Generate files only for the specified areas.

--exclude-area

Do not generate files for the specified areas.

--theme, -t

Generate static view files for only the specified themes.

--exclude-theme

Do not generate files for the specified themes.

--language, -l

Generate files only for the specified languages.

--exclude-language

Do not generate files for the specified languages.

--jobs, -j

Enable parallel processing using the specified number of jobs.

--max-execution-time

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

--symlink-locale

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

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

--refresh-content-version-only

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

--no-javascript

Do not deploy JavaScript files.

--no-js-bundle

Do not deploy JavaScript bundle files.

--no-css

Do not deploy CSS files.

--no-less

Do not deploy LESS files.

--no-images

Do not deploy images.

--no-fonts

Do not deploy font files.

--no-html

Do not deploy HTML files.

--no-misc

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

--no-html-minify

Do not minify HTML files.

--no-parent

Do not compile parent themes. Supported only in quick and standard strategies.

setup:store-config:set

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]

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

Options

For global options, see Global options.

--base-url

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

--language

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

--timezone

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

--currency

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

--use-rewrites

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

--use-secure

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

--base-url-secure

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

--use-secure-admin

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

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

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

setup:uninstall

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

Uninstalls the Magento application

Options

For global options, see Global options.

--magento-init-params

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

setup:upgrade

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]

Upgrades the Magento application, DB data, and schema

Options

For global options, see Global 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.

--convert-old-scripts

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

--safe-mode

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

--data-restore

Restore removed data from dumps

--dry-run

Magento Installation will be run in dry-run mode

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

store:list

bin/magento store:list

Displays the list of stores

Options

For global options, see Global options.

store:website:list

bin/magento store:website:list

Displays the list of websites

Options

For global options, see Global options.

support:backup:code

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

Create Code backup

Options

For global options, see Global options.

--name

Dump name

--output, -o

Output path

--logs, -l

Include logs

support:backup:db

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

Create DB backup

Options

For global options, see Global options.

--name

Dump name

--output, -o

Output path

--logs, -l

Include logs

--ignore-sanitize, -i

Ignore sanitize

support:utility:check

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

Check required backup utilities

Options

For global options, see Global options.

--hide-paths

Only check required console utilities

support:utility:paths

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

Create utilities paths list

Options

For global options, see Global options.

--force, -f

Force

theme:uninstall

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

Uninstalls 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

Options

For global options, see Global options.

--backup-code

Take code backup (excluding temporary files)

--clear-static-content, -c

Clear generated static view files.

varnish:vcl:generate

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] [--input-file INPUT-FILE] [--output-file OUTPUT-FILE]

Generates Varnish VCL and echos it to the command line

Options

For global options, see Global options.

--access-list

IPs access list that can purge Varnish

--backend-host

Host of the web backend

--backend-port

Port of the web backend

--export-version

The version of Varnish file

--grace-period

Grace period in seconds

--input-file

Input file to generate vcl from

--output-file

Path to the file to write vcl

webhooks:dev:run

bin/magento webhooks:dev:run <name> <payload>

Runs a registered webhook for development purposes.

Arguments

name

Webhook name

payload

The webhook payload in JSON format

Options

For global options, see Global options.

webhooks:generate:module

bin/magento webhooks:generate:module

Generate plugins based on webhook registrations

Options

For global options, see Global options.

webhooks:info

bin/magento webhooks:info [--depth [DEPTH]] [--] <webhook-name> [<webhook-type>]

Returns the payload of the specified webhook.

Arguments

webhook-name

Webhook method name

webhook-type

Webhook type (before, after)

Options

For global options, see Global options.

--depth

The number of levels in the webhook payload to return

webhooks:list

bin/magento webhooks:list

Shows list of subscribed webhooks

Options

For global options, see Global options.

webhooks:list:all

bin/magento webhooks:list:all <module_name>

Returns a list of supported webhook method names for the specified module

Arguments

module_name

Module name

Options

For global options, see Global options.