[Somente PaaS]{class="badge informative" title="Aplica-se somente a projetos do Adobe Commerce na nuvem (infraestrutura do PaaS gerenciada pela Adobe) e a projetos locais."}

Referência da CLI de ECE-Tools

Versão: 2002.2.7

Esta referência contém 34 comandos disponíveis através da ferramenta de linha de comando ece-tools.
A lista inicial é gerada automaticamente usando o comando ece-tools list no Adobe Commerce na infraestrutura em nuvem.

Geral

Essa referência é gerada a partir da base de código do aplicativo. Para alterar o conteúdo, Dê-nos seu feedback (localize o link no canto superior direito). Para obter as diretrizes de contribuição, consulte Contribuições de código.

Opções globais

--help, -h

Exibe a ajuda para o comando fornecido. Quando nenhum comando é fornecido, exibir ajuda para o comando de lista

--silent

Não enviar nenhuma mensagem

--quiet, -q

Somente erros são exibidos. Todas as outras saídas são suprimidas

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

Aumentar a verbosidade das mensagens: 1 para saída normal, 2 para saída mais detalhada e 3 para depuração

--version, -V

Exibir esta versão do aplicativo

--ansi

Forçar (ou desativar — no- ansi) a saída ANSI

--no-ansi

Negar a opção "—ansi"

--no-interaction, -n

Não faça nenhuma pergunta interativa

_complete

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

Comando interno para fornecer sugestões de conclusão de shell

Opções

Para opções globais, consulte Opções globais.

--shell, -s

O tipo de concha ("bash", "fish", "zsh")

--input, -i

Uma matriz de tokens de entrada (por exemplo, COMP_WORDS ou argv)

--current, -c

O índice da matriz "input" na qual o cursor está (por exemplo, COMP_CWORD)

--api-version, -a

A versão da API do script de conclusão

--symfony, -S

obsoleto

build

ece-tools build

Compila o aplicativo.

Opções

Para opções globais, consulte Opções globais.

completion

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

Despejar o script de conclusão do 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

O tipo de shell (por exemplo, "bash"), o valor do var env "$SHELL" será usado se isso não for fornecido

Opções

Para opções globais, consulte Opções globais.

--debug

Analisar o log de depuração da conclusão

db-dump

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

Cria backups do banco de dados.

Argumentos

databases

Bancos de dados para backup. Valores Disponíveis: [vendas da cotação principal]. Se o valor do argumento não for especificado, os backups do banco de dados serão criados usando as credenciais armazenadas na variável de ambiente MAGENTO_CLOUD_RELATIONSHIP ou/e a propriedade stage.deploy.DATABASE_CONFIGURATION do arquivo de configuração .magento.env.yaml.

Opções

Para opções globais, consulte Opções globais.

--remove-definers, -d

Remover definidores do dump do banco de dados

--dump-directory, -a

Usar diretório alternativo para salvar o despejo

deploy

ece-tools deploy

Implanta o aplicativo.

Opções

Para opções globais, consulte Opções globais.

help

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

Exibir a ajuda de um 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

O nome do comando

Opções

Para opções globais, consulte Opções globais.

--format

O formato de saída (txt, xml, json ou md)

--raw

Para gerar a ajuda do comando raw

list

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

Listar comandos

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

O nome do namespace

Opções

Para opções globais, consulte Opções globais.

--raw

Para gerar a lista de comandos raw

--format

O formato de saída (txt, xml, json ou md)

--short

Para ignorar a descrição dos argumentos dos comandos

patch

ece-tools patch

Aplica patches personalizados.

Opções

Para opções globais, consulte Opções globais.

post-deploy

ece-tools post-deploy

Executa operações após a implantação.

Opções

Para opções globais, consulte Opções globais.

run

ece-tools run <scenario>...

Executar cenário(s).

Argumentos

scenario

Cenário(s)

Opções

Para opções globais, consulte Opções globais.

backup:list

ece-tools backup:list

Mostra a lista de arquivos de backup.

Opções

Para opções globais, consulte Opções globais.

backup:restore

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

Restaure arquivos de configuração importantes. Execute o backup :list para mostrar a lista de arquivos de backup.

Opções

Para opções globais, consulte Opções globais.

--force, -f

Substituir arquivos existentes durante a restauração de um backup

--file

Um caminho de recuperação de arquivo específico

build:generate

ece-tools build:generate

Gera todos os arquivos necessários para o estágio de criação.

Opções

Para opções globais, consulte Opções globais.

build:transfer

ece-tools build:transfer

Transfere os arquivos gerados para o diretório init.

Opções

Para opções globais, consulte Opções globais.

cloud:config:create

ece-tools cloud:config:create <configuration>

Cria um arquivo .magento.env.yaml com a configuração de variável de compilação, implantação e pós-implantação especificada. Substitui qualquer arquivo .magento.env.yaml existente.

Argumentos

configuration

Configuração no formato JSON

Opções

Para opções globais, consulte Opções globais.

cloud:config:update

ece-tools cloud:config:update <configuration>

Atualiza o arquivo .magento.env.yaml existente com a configuração especificada. Cria o arquivo .magento.env.yaml se ele não existir.

Argumentos

configuration

Configuração no formato JSON

Opções

Para opções globais, consulte Opções globais.

cloud:config:validate

ece-tools cloud:config:validate

Valida o arquivo de configuração .magento.env.yaml

Opções

Para opções globais, consulte Opções globais.

config:dump

ece-tools config:dumpdump

Configuração de despejo para implantação de conteúdo estático.

Opções

Para opções globais, consulte Opções globais.

cron:disable

ece-tools cron:disable

Desative todos os processos cron do Magento e encerre todos os processos em execução.

Opções

Para opções globais, consulte Opções globais.

cron:enable

ece-tools cron:enable

Habilita os processos cron do Magento.

Opções

Para opções globais, consulte Opções globais.

cron:kill

ece-tools cron:kill

Encerra todos os processos cron do Magento.

Opções

Para opções globais, consulte Opções globais.

cron:unlock

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

Desbloqueie trabalhos cron que ficaram no estado "em execução".

Opções

Para opções globais, consulte Opções globais.

--job-code

Código do trabalho do Cron a ser desbloqueado.

dev:generate:schema-error

ece-tools dev:generate:schema-error

Gera o arquivo dist/error-codes.md do arquivo schema.error.yaml.

Opções

Para opções globais, consulte Opções globais.

dev:git:update-composer

ece-tools dev:git:update-composer

Atualiza o compositor para implantação do Git.

Opções

Para opções globais, consulte Opções globais.

env:config:show

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

Exibir variáveis de ambiente de configuração de nuvem codificadas.

Argumentos

variable

Variáveis de ambiente a serem exibidas, opções possíveis: serviços, rotas, variáveis

Opções

Para opções globais, consulte Opções globais.

error:show

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

Exibe informações sobre o erro por id de erro ou informações sobre todos os erros da última implantação.

Argumentos

error-code

Código de erro, se não for passado o comando exibir informações sobre todos os erros da última implantação

Opções

Para opções globais, consulte Opções globais.

--json, -j

Usado para obter resultado no formato JSON

module:refresh

ece-tools module:refresh

Atualiza a configuração para ativar módulos recém-adicionados.

Opções

Para opções globais, consulte Opções globais.

schema:generate

ece-tools schema:generate

Gera o arquivo *.dist do esquema.

Opções

Para opções globais, consulte Opções globais.

wizard:ideal-state

ece-tools wizard:ideal-state

Verifica o estado ideal de configuração.

Opções

Para opções globais, consulte Opções globais.

wizard:master-slave

ece-tools wizard:master-slave

Verifica a configuração do master-slave.

Opções

Para opções globais, consulte Opções globais.

wizard:scd-on-build

ece-tools wizard:scd-on-build

Verifica o SCD na configuração da build.

Opções

Para opções globais, consulte Opções globais.

wizard:scd-on-demand

ece-tools wizard:scd-on-demand

Verifica a configuração de SCD por demanda.

Opções

Para opções globais, consulte Opções globais.

wizard:scd-on-deploy

ece-tools wizard:scd-on-deploy

Verifica o SCD na configuração de implantação.

Opções

Para opções globais, consulte Opções globais.

wizard:split-db-state

ece-tools wizard:split-db-state

Verifica a capacidade de dividir o banco de dados e se o banco de dados já foi dividido ou não.

Opções

Para opções globais, consulte Opções globais.