_complete
ece-tools _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”)
- Requires a value
--input
, -i
An array of input tokens (e.g. COMP_WORDS or argv)
- Default:
[]
- Requires a value
--current
, -c
The index of the “input” array that the cursor is in (e.g. COMP_CWORD)
- Requires a value
--api-version
, -a
The API version of the completion script
- Requires a value
--symfony
, -S
deprecated
- Requires a value
build
ece-tools build
ece-tools 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/ece-tools completion | sudo tee /etc/bash_completion.d/ece-tools
Or dump the script to a local file and source it:
bin/ece-tools 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/jenkins/workspace/gendocs-ece-tools-cli/bin/ece-tools 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
- Default:
false
- Does not accept a value
db-dump
ece-tools db-dump [-d|--remove-definers] [-a|--dump-directory DUMP-DIRECTORY] [--] [<databases>...]
Creates database backups.
Arguments
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.
- Default:
[]
- Array
Options
For global options, see Global options.
--remove-definers
, -d
Remove definers from the database dump
- Default:
false
- Does not accept a value
--dump-directory
, -a
Use alternative directory for saving dump
- Requires a value
deploy
ece-tools deploy
ece-tools help [--format FORMAT] [--raw] [--] [<command_name>]
Display help for a command
The help command displays help for a given command:
bin/ece-tools help list
You can also output the help in other formats by using the --format option:
bin/ece-tools help --format=xml list
To display the list of available commands, please use the list command.
Arguments
command_name
The command name
- Default:
help
- Default:
txt
- Requires a value
--raw
To output raw command help
- Default:
false
- Does not accept a value
list
ece-tools list [--raw] [--format FORMAT] [--short] [--] [<namespace>]
List commands
The list command lists all commands:
bin/ece-tools list
You can also display the commands for a specific namespace:
bin/ece-tools list test
You can also output the information in other formats by using the --format option:
bin/ece-tools list --format=xml
It's also possible to get raw list of commands (useful for embedding command runner):
bin/ece-tools list --raw
Arguments
namespace
The namespace name
Options
For global options, see Global options.
--raw
To output raw command list
- Default:
false
- Does not accept a value
--format
The output format (txt, xml, json, or md)
- Default:
txt
- Requires a value
--short
To skip describing commands’ arguments
- Default:
false
- Does not accept a value
patch
ece-tools patch
ece-tools post-deploy
ece-tools run <scenario>...
Execute scenario(s).
Arguments
scenario
Scenario(s)
-
Default:
[]
-
Required
-
Array
ece-tools backup:list
ece-tools backup:restore [-f|--force] [--file [FILE]]
Restore important configuration files. Run backup:list to show the list of backup files.
Options
For global options, see Global options.
--force
, -f
Overwrite existing files during restoring a backup
- Default:
false
- Does not accept a value
--file
A specific file recovery path
- Accepts a value
build:generate
ece-tools build:generate
Generates all necessary files for build stage.
Options
For global options, see Global options.
build:transfer
ece-tools build:transfer
Transfers generated files into init directory.
Options
For global options, see Global options.
cloud:config:create
ece-tools cloud:config:create <configuration>
Creates a .magento.env.yaml
file with the specified build, deploy, and post-deploy variable configuration. Overwrites any existing .magento,.env.yaml
file.
Arguments
configuration
Configuration in JSON format
- Required
ece-tools cloud:config:update <configuration>
Updates the existing .magento.env.yaml
file with the specified configuration. Creates .magento.env.yaml
file if it does not exist.
Arguments
configuration
Configuration in JSON format
- Required
ece-tools cloud:config:validate
Validates .magento.env.yaml
configuration file
Options
For global options, see Global options.
config:dump
ece-tools config:dumpdump
Dump configuration for static content deployment.
Options
For global options, see Global options.
cron:disable
ece-tools cron:disable
Disable all Magento cron processes and terminates all running processes.
Options
For global options, see Global options.
cron:enable
ece-tools cron:enable
ece-tools cron:kill
ece-tools cron:unlock [--job-code [JOB-CODE]]
Unlock cron jobs that stuck in “running” state.
Options
For global options, see Global options.
--job-code
Cron job code to unlock.
- Default:
[]
- Accepts multiple values
dev:generate:schema-error
ece-tools dev:generate:schema-error
Generates the dist/error-codes.md file from the schema.error.yaml file.
Options
For global options, see Global options.
dev:git:update-composer
ece-tools dev:git:update-composer
Updates composer for deployment from git.
Options
For global options, see Global options.
env:config:show
ece-tools env:config:show [<variable>...]
Display encoded cloud configuration environment variables.
Arguments
variable
Environment variables to display, possible options: services,routes,variables
- Default:
[]
- Array
ece-tools error:show [-j|--json] [--] [<error-code>]
Displays info about error by error id or info about all errors from the last deployment.
Arguments
error-code
Error code, if not passed command display info about all errors from the last deployment
Options
For global options, see Global options.
--json
, -j
Used for getting result in JSON format
- Default:
false
- Does not accept a value
module:refresh
ece-tools module:refresh
Refreshes the configuration to enable newly added modules.
Options
For global options, see Global options.
schema:generate
ece-tools schema:generate
ece-tools wizard:ideal-state
Verifies ideal state of configuration.
Options
For global options, see Global options.
wizard:master-slave
ece-tools wizard:master-slave
Verifies master-slave configuration.
Options
For global options, see Global options.
wizard:scd-on-build
ece-tools wizard:scd-on-build
Verifies SCD on build configuration.
Options
For global options, see Global options.
wizard:scd-on-demand
ece-tools wizard:scd-on-demand
Verifies SCD on demand configuration.
Options
For global options, see Global options.
wizard:scd-on-deploy
ece-tools wizard:scd-on-deploy
Verifies SCD on deploy configuration.
ece-tools wizard:split-db-state
Verifies ability to split DB and whether DB was already split or not.
Options
For global options, see Global options.