[Solo PaaS]{class="badge informative" title="Se aplica solo a proyectos de Adobe Commerce en la nube (infraestructura PaaS administrada por Adobe) y a proyectos locales."}

Referencia CLI de ECE-Tools

Versión: 2002.2.8

Esta referencia contiene 34 comandos disponibles mediante la herramienta de línea de comandos ece-tools.
La lista inicial se genera automáticamente mediante el comando ece-tools list en Adobe Commerce en la infraestructura en la nube.

General

Esta referencia se genera a partir del código base de la aplicación. Para cambiar el contenido, envíenos su opinión (busque el vínculo en la esquina superior derecha). Para ver las directrices de contribución, consulte Contribuciones de código.

Opciones globales

--help, -h

Muestra la ayuda del comando especificado. Cuando no se proporciona ningún comando, se muestra la ayuda para el comando de lista

--silent

No generar ningún mensaje

--quiet, -q

Solo se muestran los errores. El resto de la salida se suprime

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

Aumente el nivel de detalle de los mensajes: 1 para un resultado normal, 2 para un resultado más detallado y 3 para una depuración

--version, -V

Mostrar esta versión de la aplicación

--ansi

Forzar (o deshabilitar —sin ansi) la salida ANSI

--no-ansi

Anule la opción "—ansi"

--no-interaction, -n

No haga ninguna pregunta interactiva

_complete

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

Comando interno para proporcionar sugerencias de finalización de shell

Opciones

Para ver las opciones globales, consulte Opciones globales.

--shell, -s

El tipo de contenedor ("bash", "fish", "zsh")

--input, -i

Una matriz de tokens de entrada (por ejemplo, COMP_WORDS o argv)

--current, -c

Índice de la matriz de "entrada" en la que se encuentra el cursor (p. ej. COMP_CWORD)

--api-version, -a

Versión de API del script de finalización

--symfony, -S

obsoleto

build

ece-tools build

Crea una aplicación.

Opciones

Para ver las opciones globales, consulte Opciones globales.

completion

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

Volcar el script de finalización de shell

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

Argumentos

shell

El tipo de shell (p. ej. "bash"), el valor de la variable env "$SHELL" se usará si no se proporciona

Opciones

Para ver las opciones globales, consulte Opciones globales.

--debug

Seguimiento del registro de depuración de finalización

db-dump

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

Crea copias de seguridad de base de datos.

Argumentos

databases

Bases de datos para backup. Valores disponibles: [ventas de presupuesto principal]. Si no se especifica el valor del argumento, se crearán copias de seguridad de la base de datos con las credenciales almacenadas en la variable de entorno MAGENTO_CLOUD_RELATIONSHIP o con la propiedad stage.deploy.DATABASE_CONFIGURATION del archivo de configuración .magento.env.yaml.

Opciones

Para ver las opciones globales, consulte Opciones globales.

--remove-definers, -d

Quitar definidores del volcado de la base de datos

--dump-directory, -a

Usar directorio alternativo para guardar el volcado

deploy

ece-tools deploy

Implementa la aplicación.

Opciones

Para ver las opciones globales, consulte Opciones globales.

help

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

Mostrar la ayuda de un comando

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.

Argumentos

command_name

El nombre del comando

Opciones

Para ver las opciones globales, consulte Opciones globales.

--format

El formato de salida (txt, xml, json o md)

--raw

Para generar la ayuda del comando raw

list

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

Comandos de lista

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

Argumentos

namespace

El nombre del área de nombres

Opciones

Para ver las opciones globales, consulte Opciones globales.

--raw

Para generar la lista de comandos raw

--format

El formato de salida (txt, xml, json o md)

--short

Para omitir la descripción de argumentos de comandos

patch

ece-tools patch

Aplica parches personalizados.

Opciones

Para ver las opciones globales, consulte Opciones globales.

post-deploy

ece-tools post-deploy

Realiza operaciones después de la implementación.

Opciones

Para ver las opciones globales, consulte Opciones globales.

run

ece-tools run <scenario>...

Ejecución de escenarios.

Argumentos

scenario

Escenario(s)

Opciones

Para ver las opciones globales, consulte Opciones globales.

backup:list

ece-tools backup:list

Muestra la lista de archivos de copia de seguridad.

Opciones

Para ver las opciones globales, consulte Opciones globales.

backup:restore

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

Restaure los archivos de configuración importantes. Ejecute backup:list para mostrar la lista de archivos de copia de seguridad.

Opciones

Para ver las opciones globales, consulte Opciones globales.

--force, -f

Sobrescribir archivos existentes al restaurar una copia de seguridad

--file

Una ruta de recuperación de archivos específica

build:generate

ece-tools build:generate

Genera todos los archivos necesarios para la fase de compilación.

Opciones

Para ver las opciones globales, consulte Opciones globales.

build:transfer

ece-tools build:transfer

Transfiere los archivos generados al directorio init.

Opciones

Para ver las opciones globales, consulte Opciones globales.

cloud:config:create

ece-tools cloud:config:create <configuration>

Crea un archivo de .magento.env.yaml con la configuración de variables especificada de compilación, implementación y posterior a la implementación. Sobrescribe cualquier archivo .magento.env.yaml existente.

Argumentos

configuration

Configuración en formato JSON

Opciones

Para ver las opciones globales, consulte Opciones globales.

cloud:config:update

ece-tools cloud:config:update <configuration>

Actualiza el archivo .magento.env.yaml existente con la configuración especificada. Crea .magento.env.yaml archivo si no existe.

Argumentos

configuration

Configuración en formato JSON

Opciones

Para ver las opciones globales, consulte Opciones globales.

cloud:config:validate

ece-tools cloud:config:validate

Valida el archivo de configuración .magento.env.yaml

Opciones

Para ver las opciones globales, consulte Opciones globales.

config:dump

ece-tools config:dumpdump

Configuración de volcado para la implementación de contenido estático.

Opciones

Para ver las opciones globales, consulte Opciones globales.

cron:disable

ece-tools cron:disable

Deshabilite todos los procesos cron de Magento y finalice todos los procesos en ejecución.

Opciones

Para ver las opciones globales, consulte Opciones globales.

cron:enable

ece-tools cron:enable

Habilita los procesos cron de Magento.

Opciones

Para ver las opciones globales, consulte Opciones globales.

cron:kill

ece-tools cron:kill

Termina todos los procesos cron de Magento.

Opciones

Para ver las opciones globales, consulte Opciones globales.

cron:unlock

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

Desbloquee los trabajos cron que se quedaron en estado "en ejecución".

Opciones

Para ver las opciones globales, consulte Opciones globales.

--job-code

Código de trabajo Cron para desbloquear.

dev:generate:schema-error

ece-tools dev:generate:schema-error

Genera el archivo dist/error-codes.md a partir del archivo schema.error.yaml.

Opciones

Para ver las opciones globales, consulte Opciones globales.

dev:git:update-composer

ece-tools dev:git:update-composer

Actualiza el Compositor para la implementación desde Git.

Opciones

Para ver las opciones globales, consulte Opciones globales.

env:config:show

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

Muestre variables de entorno de configuración de nube codificadas.

Argumentos

variable

Variables de entorno para mostrar, posibles opciones: servicios, rutas, variables

Opciones

Para ver las opciones globales, consulte Opciones globales.

error:show

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

Muestra información sobre errores por ID de error o sobre todos los errores de la última implementación.

Argumentos

error-code

Código de error, si no se ha pasado el comando, se muestra información sobre todos los errores de la última implementación

Opciones

Para ver las opciones globales, consulte Opciones globales.

--json, -j

Se utiliza para obtener los resultados en formato JSON

module:refresh

ece-tools module:refresh

Actualiza la configuración para habilitar los módulos recién añadidos.

Opciones

Para ver las opciones globales, consulte Opciones globales.

schema:generate

ece-tools schema:generate

Genera el archivo de esquema *.dist.

Opciones

Para ver las opciones globales, consulte Opciones globales.

wizard:ideal-state

ece-tools wizard:ideal-state

Comprueba el estado ideal de configuración.

Opciones

Para ver las opciones globales, consulte Opciones globales.

wizard:master-slave

ece-tools wizard:master-slave

Comprueba la configuración maestro-esclavo.

Opciones

Para ver las opciones globales, consulte Opciones globales.

wizard:scd-on-build

ece-tools wizard:scd-on-build

Comprueba el SCD en la configuración de compilación.

Opciones

Para ver las opciones globales, consulte Opciones globales.

wizard:scd-on-demand

ece-tools wizard:scd-on-demand

Comprueba la configuración de SCD bajo demanda.

Opciones

Para ver las opciones globales, consulte Opciones globales.

wizard:scd-on-deploy

ece-tools wizard:scd-on-deploy

Comprueba el SCD en la configuración de implementación.

Opciones

Para ver las opciones globales, consulte Opciones globales.

wizard:split-db-state

ece-tools wizard:split-db-state

Comprueba la capacidad de dividir la base de datos y si ya se ha dividido o no.

Opciones

Para ver las opciones globales, consulte Opciones globales.