ECE-Tools CLI reference

Version: 2002.1.18

This reference contains 34 commands available through the ece-tools command-line tool.
The initial list is auto generated using the ece-tools list command at Adobe Commerce on cloud infrastructure.

_complete

Internal command to provide shell completion suggestions

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

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

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

build

Builds application.

ece-tools build

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

completion

Dump the shell completion script

ece-tools completion [--debug] [--] [<shell>]

shell

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

--debug

Tail the completion debug log

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

db-dump

Creates database backups.

ece-tools db-dump [-d|--remove-definers] [-a|--dump-directory DUMP-DIRECTORY] [--] [<databases>...]

databases

Databases for backup. Available Values: [ main quote sales ]. If the argument value is not specified, database backups will be created using the credentials stored in the MAGENTO_CLOUD_RELATIONSHIP environment variable or/and the stage.deploy.DATABASE_CONFIGURATION property of the .magento.env.yaml configuration file.

--remove-definers, -d

Remove definers from the database dump

--dump-directory, -a

Use alternative directory for saving dump

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

deploy

Deploys the application.

ece-tools deploy

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

help

Display help for a command

ece-tools help [--format FORMAT] [--raw] [--] [<command_name>]

command_name

The command name

--format

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

--raw

To output raw command help

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

list

List commands

ece-tools list [--raw] [--format FORMAT] [--short] [--] [<namespace>]

namespace

The namespace name

--raw

To output raw command list

--format

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

--short

To skip describing commands’ arguments

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

patch

Applies custom patches.

ece-tools patch

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

post-deploy

Performs after deploy operations.

ece-tools post-deploy

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

run

Execute scenario(s).

ece-tools run <scenario>...

scenario

Scenario(s)

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

backup:list

Shows the list of backup files.

ece-tools backup:list

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

backup:restore

Restore important configuration files. Run backup:list to show the list of backup files.

ece-tools backup:restore [-f|--force] [--file [FILE]]

--force, -f

Overwrite existing files during restoring a backup

--file

A specific file recovery path

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

build:generate

Generates all necessary files for build stage.

ece-tools build:generate

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

build:transfer

Transfers generated files into init directory.

ece-tools build:transfer

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

cloud:config:create

Creates a .magento.env.yaml file with the specified build, deploy, and post-deploy variable configuration. Overwrites any existing .magento,.env.yaml file.

ece-tools cloud:config:create <configuration>

configuration

Configuration in JSON format

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

cloud:config:update

Updates the existing .magento.env.yaml file with the specified configuration. Creates .magento.env.yaml file if it does not exist.

ece-tools cloud:config:update <configuration>

configuration

Configuration in JSON format

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

cloud:config:validate

Validates .magento.env.yaml configuration file

ece-tools cloud:config:validate

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

config:dump

Dump configuration for static content deployment.

ece-tools config:dump

ece-tools dump

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

cron:disable

Disable all Magento cron processes and terminates all running processes.

ece-tools cron:disable

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

cron:enable

Enables Magento cron processes.

ece-tools cron:enable

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

cron:kill

Terminates all Magento cron processes.

ece-tools cron:kill

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

cron:unlock

Unlock cron jobs that stuck in “running” state.

ece-tools cron:unlock [--job-code [JOB-CODE]]

--job-code

Cron job code to unlock.

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

dev:generate:schema-error

Generates the dist/error-codes.md file from the schema.error.yaml file.

ece-tools dev:generate:schema-error

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

dev:git:update-composer

Updates composer for deployment from git.

ece-tools dev:git:update-composer

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

env:config:show

Display encoded cloud configuration environment variables.

ece-tools env:config:show [<variable>...]

variable

Environment variables to display, possible options: services,routes,variables

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

error:show

Displays info about error by error id or info about all errors from the last deployment.

ece-tools error:show [-j|--json] [--] [<error-code>]

error-code

Error code, if not passed command display info about all errors from the last deployment

--json, -j

Used for getting result in JSON format

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

module:refresh

Refreshes the configuration to enable newly added modules.

ece-tools module:refresh

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

schema:generate

Generates the schema *.dist file.

ece-tools schema:generate

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

wizard:ideal-state

Verifies ideal state of configuration.

ece-tools wizard:ideal-state

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

wizard:master-slave

Verifies master-slave configuration.

ece-tools wizard:master-slave

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

wizard:scd-on-build

Verifies SCD on build configuration.

ece-tools wizard:scd-on-build

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

wizard:scd-on-demand

Verifies SCD on demand configuration.

ece-tools wizard:scd-on-demand

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

wizard:scd-on-deploy

Verifies SCD on deploy configuration.

ece-tools wizard:scd-on-deploy

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

wizard:split-db-state

Verifies ability to split DB and whether DB was already split or not.

ece-tools wizard:split-db-state

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