[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 da nuvem

Versão: 1.46.1

Esta referência contém 119 comandos disponíveis através da ferramenta de linha de comando magento-cloud.
A lista inicial é gerada automaticamente usando o comando magento-cloud 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, você pode atualizar o código-fonte para a implementação de comando correspondente no repositório codebase e enviar suas alterações para revisão. Outra maneira é Fornecer comentários (localizar o link no canto superior direito). Para obter as diretrizes de contribuição, consulte Contribuições de código.

Opções globais

--help, -h

Exibir esta mensagem de ajuda

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

Aumentar a verbosidade das mensagens

--version, -V

Exibir esta versão do aplicativo

--yes, -y

Responda "sim" às perguntas de confirmação; aceite o valor padrão para outras perguntas; desative a interação

--no-interaction

Não faça perguntas interativas; aceite valores padrão. Equivalente ao uso da variável de ambiente: MAGENTO_CLOUD_CLI_NO_INTERACTION=1

clear-cache

magento-cloud magento-cloud cc

Limpe o cache da CLI

Opções

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

decode

magento-cloud magento-cloud decode [-P|--property PROPERTY] [--] <value>

Decodifique uma string codificada como MAGENTO_CLOUD_VARIABLES

Argumentos

value

O valor da variável a ser decodificado

Opções

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

--property, -P

A propriedade a ser exibida na variável

docs

magento-cloud magento-cloud docs [--browser BROWSER] [--pipe] [--] [<search>]...

Abrir a documentação online

Argumentos

search

Pesquisar termo(s)

Opções

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

--browser

O navegador a ser usado para abrir o URL. Defina 0 para nenhum.

--pipe

Transfira o URL para o stdout.

help

magento-cloud magento-cloud help [--format FORMAT] [--raw] [--] [<command_name>]

Exibe a ajuda para um comando

The help command displays help for a given command:

  magento-cloud help list

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

  magento-cloud help --format=json 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, json ou md)

--raw

Para gerar a ajuda do comando raw

list

magento-cloud magento-cloud list [--raw] [--format FORMAT] [--all] [--] [<namespace>]

Comandos de Listas

The list command lists all commands:

  magento-cloud list

You can also display the commands for a specific namespace:

  magento-cloud list project

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

  magento-cloud list --format=xml

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

  magento-cloud list --raw

Argumentos

command

O comando a ser executado

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)

--all

Mostrar todos os comandos, incluindo os ocultos

multi

magento-cloud magento-cloud multi [-p|--projects PROJECTS] [--continue] [--sort SORT] [--reverse] [--] <cmd> (<cmd>)...

Executar um comando em vários projetos

Argumentos

cmd

O comando a ser executado

Opções

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

--projects, -p

Uma lista de IDs de projeto, separadas por vírgulas e/ou espaço em branco

--continue

Continuar executando comandos mesmo se uma exceção for encontrada

--sort

Uma propriedade pela qual classificar a lista de opções do projeto

--reverse

Inverter a ordem das opções do projeto

web

magento-cloud magento-cloud web [--browser BROWSER] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]

Abrir o projeto na interface do usuário da Web

Opções

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

--browser

O navegador a ser usado para abrir o URL. Defina 0 para nenhum.

--pipe

Transfira o URL para o stdout.

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

activity:cancel

magento-cloud magento-cloud activity:cancel [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<id>]

Cancelar uma atividade

Argumentos

id

A ID da atividade. O padrão é a atividade cancelável mais recente.

Opções

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

--type, -t

Filtrar por tipo (ao selecionar uma atividade padrão). Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco. Os caracteres % ou * podem ser usados como curinga para o tipo, por exemplo, '%var%' para selecionar atividades relacionadas a variáveis.

--exclude-type, -x

Excluir por tipo (ao selecionar uma atividade padrão). Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco. Os caracteres % ou * podem ser usados como curinga para excluir tipos.

--all, -a

Verificar atividades recentes em todos os ambientes (ao selecionar uma atividade padrão)

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

activity:get

magento-cloud magento-cloud activity:get [-P|--property PROPERTY] [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--state STATE] [--result RESULT] [-i|--incomplete] [-a|--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [--] [<id>]

Exibir informações detalhadas sobre uma única atividade

Argumentos

id

A ID da atividade. O padrão é a atividade mais recente.

Opções

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

--property, -P

A propriedade a ser exibida

--type, -t

Filtrar por tipo (ao selecionar uma atividade padrão). Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco. Os caracteres % ou * podem ser usados como curinga para o tipo, por exemplo, '%var%' para selecionar atividades relacionadas a variáveis.

--exclude-type, -x

Excluir por tipo (ao selecionar uma atividade padrão). Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco. Os caracteres % ou * podem ser usados como curinga para excluir tipos.

--state

Filtrar por estado (ao selecionar uma atividade padrão): in_progress, pending, complete ou canceled. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--result

Filtrar por resultado (ao selecionar uma atividade padrão): sucesso ou falha

--incomplete, -i

Incluir somente atividades incompletas (ao selecionar uma atividade padrão). Esta é uma abreviação de — state=in_progress,pending

--all, -a

Verificar atividades recentes em todos os ambientes (ao selecionar uma atividade padrão)

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--date-fmt

O formato de data (como uma string de formato de data do PHP)

activity:list

magento-cloud magento-cloud activities [-t|--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--limit LIMIT] [--start START] [--state STATE] [--result RESULT] [-i|--incomplete] [-a|--all] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]

Obter uma lista de atividades para um ambiente ou projeto

Opções

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

--type, -t

Filtrar atividades por tipo Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco. A primeira parte do nome da atividade pode ser omitida. Por exemplo, "cron" pode selecionar atividades "environment.cron". Os caracteres % ou * podem ser usados como curinga, por exemplo, '%var%' para selecionar atividades relacionadas a variáveis.

--exclude-type, -x

Excluir atividades por tipo. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco. A primeira parte do nome da atividade pode ser omitida. Por exemplo, "cron" pode excluir atividades "environment.cron". Os caracteres % ou * podem ser usados como curinga para excluir tipos.

--limit

Limitar o número de resultados exibidos

--start

Somente atividades criadas antes desta data serão listadas

--state

Filtrar atividades por estado: in_progress, pending, complete ou canceled. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--result

Filtrar atividades por resultado: sucesso ou falha

--incomplete, -i

Listar apenas atividades incompletas

--all, -a

Listar atividades em todos os ambientes

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: id*, created*, description*, progress*, state*, result*, completed, ambientes, type (* = colunas padrão). O caractere "+" pode ser usado como um espaço reservado para as colunas padrão. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--date-fmt

O formato de data (como uma string de formato de data do PHP)

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

activity:log

magento-cloud magento-cloud activity:log [--refresh REFRESH] [-t|--timestamps] [--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--state STATE] [--result RESULT] [-i|--incomplete] [-a|--all] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<id>]

Exibir o log de uma atividade

Argumentos

id

A ID da atividade. O padrão é a atividade mais recente.

Opções

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

--refresh

Intervalo de atualização da atividade (segundos). Defina como 0 para desativar a atualização.

--timestamps, -t

Exibir um carimbo de data e hora ao lado de cada mensagem

--type

Filtrar por tipo (ao selecionar uma atividade padrão). Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco. Os caracteres % ou * podem ser usados como curinga para o tipo, por exemplo, '%var%' para selecionar atividades relacionadas a variáveis.

--exclude-type, -x

Excluir por tipo (ao selecionar uma atividade padrão). Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco. Os caracteres % ou * podem ser usados como curinga para excluir tipos.

--state

Filtrar por estado (ao selecionar uma atividade padrão): in_progress, pending, complete ou canceled. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--result

Filtrar por resultado (ao selecionar uma atividade padrão): sucesso ou falha

--incomplete, -i

Incluir somente atividades incompletas (ao selecionar uma atividade padrão). Esta é uma abreviação de — state=in_progress,pending

--all, -a

Verificar atividades recentes em todos os ambientes (ao selecionar uma atividade padrão)

--date-fmt

O formato de data (como uma string de formato de data do PHP)

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

app:config-get

magento-cloud magento-cloud app:config-get [-P|--property PROPERTY] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-i|--identity-file IDENTITY-FILE]

Exibir a configuração de um aplicativo

Opções

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

--property, -P

A propriedade de configuração a ser exibida

--refresh

Se o cache deve ser atualizado

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

--identity-file, -i

[Opção obsoleta, não é mais usada]

app:list

magento-cloud magento-cloud apps [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]

Listar aplicativos no projeto

Opções

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

--refresh

Se o cache deve ser atualizado

--pipe

Gerar uma lista somente de nomes de aplicativos

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: nome*, tipo*, disco, caminho, tamanho (* = colunas padrão). O caractere "+" pode ser usado como um espaço reservado para as colunas padrão. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

auth:api-token-login

magento-cloud magento-cloud auth:api-token-login

Fazer logon na Magento Cloud usando um token de API

Use this command to log in to your Magento Cloud account using an API token.

You can create an account at:
    https://business.adobe.com/products/magento/magento-commerce.html

If you have an account, but you do not already have an API token, you can create one here:
    https://accounts.magento.cloud/user/api-tokens

Alternatively, to log in to the CLI with a browser, run:
    magento-cloud auth:browser-login

Opções

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

auth:browser-login

magento-cloud magento-cloud login [-f|--force] [--browser BROWSER] [--pipe]

Fazer logon na Magento Cloud por meio de um navegador

Use this command to log in to the Magento Cloud CLI using a web browser.

It launches a temporary local website which redirects you to log in if
necessary, and then captures the resulting authorization code.

Your system's default browser will be used. You can override this using the
--browser option.

Alternatively, to log in using an API token (without a browser), run:
magento-cloud auth:api-token-login

To authenticate non-interactively, configure an API token using the
MAGENTO_CLOUD_CLI_TOKEN environment variable.

Opções

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

--force, -f

Fazer logon novamente, mesmo que já tenha feito logon

--browser

O navegador a ser usado para abrir o URL. Defina 0 para nenhum.

--pipe

Transfira o URL para o stdout.

auth:info

magento-cloud magento-cloud auth:info [--no-auto-login] [-P|--property PROPERTY] [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--] [<property>]

Exibir as informações da sua conta

Argumentos

property

A propriedade da conta a ser exibida

Opções

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

--no-auto-login

Ignora o logon automático. Nada será gerado se não estiver conectado e o código de saída será 0, assumindo que não há outros erros.

--property, -P

A propriedade da conta a ser exibida (sintaxe alternativa)

--refresh

Se o cache deve ser atualizado

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

auth:logout

magento-cloud magento-cloud logout [-a|--all] [--other]

Faça logout da Magento Cloud

Opções

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

--all, -a

Fazer logoff de todas as sessões locais

--other

Fazer logoff de outras sessões locais

blackfire:setup

magento-cloud magento-cloud blackfire:setup [--server_id SERVER_ID] [--server_token SERVER_TOKEN] [-p|--project PROJECT] [-W|--no-wait] [--wait]

Configurar a integração do Blackfire.io para o projeto

Opções

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

--server_id

A ID do servidor

--server_token

O token do servidor

--project, -p

A ID ou URL do projeto

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

certificate:add

magento-cloud magento-cloud certificate:add [--cert CERT] [--key KEY] [--chain CHAIN] [-p|--project PROJECT] [-W|--no-wait] [--wait]

Adicionar um certificado SSL ao projeto

Opções

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

--cert

O caminho para o arquivo de certificado

--key

O caminho para o arquivo de chave privada do certificado

--chain

O caminho para o arquivo da cadeia de certificados

--project, -p

A ID ou URL do projeto

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

certificate:delete

magento-cloud magento-cloud certificate:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] <id>

Excluir um certificado do projeto

Argumentos

id

A ID do certificado (ou o início dela)

Opções

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

--project, -p

A ID ou URL do projeto

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

certificate:get

magento-cloud magento-cloud certificate:get [-P|--property PROPERTY] [--date-fmt DATE-FMT] [-p|--project PROJECT] [--] <id>

Exibir um certificado

Argumentos

id

A ID do certificado (ou o início dela)

Opções

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

--property, -P

A propriedade do certificado a ser exibida

--date-fmt

O formato de data (como uma string de formato de data do PHP)

--project, -p

A ID ou URL do projeto

certificate:list

magento-cloud magento-cloud certificates [--domain DOMAIN] [--exclude-domain EXCLUDE-DOMAIN] [--issuer ISSUER] [--only-auto] [--no-auto] [--ignore-expiry] [--only-expired] [--no-expired] [--pipe-domains] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT]

Listar certificados de projeto

Opções

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

--domain

Filtrar por nome de domínio (pesquisa que não diferencia maiúsculas de minúsculas)

--exclude-domain

Excluir certificados, correspondendo pelo nome de domínio (pesquisa que não diferencia maiúsculas de minúsculas)

--issuer

Filtrar por emissor

--only-auto

Mostrar apenas certificados autoprovisionados

--no-auto

Mostrar apenas certificados adicionados manualmente

--ignore-expiry

Mostrar certificados expirados e não expirados

--only-expired

Mostrar apenas certificados expirados

--no-expired

Mostrar apenas certificados não expirados (padrão)

--pipe-domains

Retornar apenas uma lista de nomes de domínio cobertos pelos certificados

--date-fmt

O formato de data (como uma string de formato de data do PHP)

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: criado, domínios, expires, id, emissor. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--project, -p

A ID ou URL do projeto

commit:get

magento-cloud magento-cloud commit:get [-P|--property PROPERTY] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--date-fmt DATE-FMT] [--] [<commit>]

Mostrar detalhes da confirmação

Argumentos

commit

O SHA de confirmação. Isso também pode aceitar os sufixos "HEAD" e acento circunflexo (^) ou til (~) para confirmações principais.

Opções

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

--property, -P

A propriedade de confirmação a ser exibida.

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--date-fmt

O formato de data (como uma string de formato de data do PHP)

commit:list

magento-cloud magento-cloud commits [--limit LIMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [--] [<commit>]

Listar confirmações

Argumentos

commit

O SHA de Git commit inicial. Isso também pode aceitar os sufixos "HEAD" e acento circunflexo (^) ou til (~) para confirmações principais.

Opções

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

--limit

O número de confirmações a serem exibidas.

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: author, date, sha, summary. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--date-fmt

O formato de data (como uma string de formato de data do PHP)

db:dump

magento-cloud magento-cloud db:dump [--schema SCHEMA] [-f|--file FILE] [-d|--directory DIRECTORY] [-z|--gzip] [-t|--timestamp] [-o|--stdout] [--table TABLE] [--exclude-table EXCLUDE-TABLE] [--schema-only] [--charset CHARSET] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE]

Criar um dump local do banco de dados remoto

Opções

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

--schema

O esquema a ser descarregado. Omitir o uso do schema padrão (geralmente "principal").

--file, -f

Um nome de arquivo personalizado para o despejo

--directory, -d

Um diretório personalizado para o despejo

--gzip, -z

Compactar o despejo usando gzip

--timestamp, -t

Adicionar um carimbo de data e hora ao nome do arquivo de despejo

--stdout, -o

Saída para STDOUT em vez de um arquivo

--table

Tabela(s) a serem incluídas

--exclude-table

Tabela(s) a ser excluída(s)

--schema-only

Despejar apenas esquemas, sem dados

--charset

A codificação do conjunto de caracteres para o despejo

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

--relationship, -r

O relacionamento de serviço a ser usado

--identity-file, -i

Uma identidade SSH (chave privada) para usar

db:size

magento-cloud magento-cloud db:size [-B|--bytes] [-C|--cleanup] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-i|--identity-file IDENTITY-FILE]

Estimar o uso do disco de um banco de dados

This is an estimate of the database disk usage. The real size on disk is usually higher because of overhead.

To see more accurate disk usage, run: magento-cloud disk

Opções

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

--bytes, -B

Mostrar tamanhos em bytes.

--cleanup, -C

Verificar se as tabelas podem ser limpas e mostrar recomendações (somente InnoDb).

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

--relationship, -r

O relacionamento de serviço a ser usado

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: max, percent_used, used. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--identity-file, -i

Uma identidade SSH (chave privada) para usar

db:sql

magento-cloud magento-cloud sql [--raw] [--schema SCHEMA] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [--] [<query>]

Executar SQL no banco de dados remoto

Argumentos

query

Uma instrução SQL a ser executada

Opções

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

--raw

Produzir saída bruta, não tabular

--schema

O esquema a ser usado. Omitir o uso do schema padrão (geralmente "principal"). Transmita uma string vazia para não usar nenhum esquema.

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

--relationship, -r

O relacionamento de serviço a ser usado

--identity-file, -i

Uma identidade SSH (chave privada) para usar

domain:add

magento-cloud magento-cloud domain:add [--cert CERT] [--key KEY] [--chain CHAIN] [--attach ATTACH] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>

Adicionar um novo domínio ao projeto

Argumentos

name

O nome do domínio

Opções

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

--cert

O caminho para o arquivo de certificado deste domínio

--key

O caminho para o arquivo de chave privada do certificado fornecido.

--chain

O caminho para o(s) arquivo(s) da cadeia de certificados do certificado fornecido

--attach

O domínio de produção que este substitui nas rotas do ambiente. Necessário para domínios de ambiente de não produção.

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

domain:delete

magento-cloud magento-cloud domain:delete [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>

Excluir um domínio do projeto

Argumentos

name

O nome do domínio

Opções

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

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

domain:get

magento-cloud magento-cloud domain:get [-P|--property PROPERTY] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<name>]

Mostrar informações detalhadas de um domínio

Argumentos

name

O nome do domínio

Opções

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

--property, -P

A propriedade de domínio a ser exibida

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--date-fmt

O formato de data (como uma string de formato de data do PHP)

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

domain:list

magento-cloud magento-cloud domains [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]

Obter uma lista de todos os domínios

Opções

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

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: name*, ssl*, created_at*, registered_name, replacement_for, type, updated_at (* = colunas padrão). O caractere "+" pode ser usado como um espaço reservado para as colunas padrão. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

domain:update

magento-cloud magento-cloud domain:update [--cert CERT] [--key KEY] [--chain CHAIN] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <name>

Atualizar um domínio

Argumentos

name

O nome do domínio

Opções

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

--cert

O caminho para o arquivo de certificado deste domínio

--key

O caminho para o arquivo de chave privada do certificado fornecido.

--chain

O caminho para o(s) arquivo(s) da cadeia de certificados do certificado fornecido

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

environment:activate

magento-cloud magento-cloud environment:activate [--parent PARENT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]...

Ativar um ambiente

Argumentos

environment

Os ambientes a serem ativados

Opções

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

--parent

Definir um novo ambiente principal antes da ativação

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

environment:branch

magento-cloud magento-cloud branch [--title TITLE] [--type TYPE] [--no-clone-parent] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<id>] [<parent>]

Ramificar um ambiente

Argumentos

id

A ID (nome da ramificação) do novo ambiente

parent

O pai do novo ambiente

Opções

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

--title

O título do novo ambiente

--type

O tipo do novo ambiente

--no-clone-parent

Não clonar os dados do ambiente pai

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

environment:checkout

magento-cloud magento-cloud checkout [-i|--identity-file IDENTITY-FILE] [--] [<id>]

Confira um ambiente

Argumentos

id

A ID do ambiente a ser verificado. Por exemplo: "sprint2"

Opções

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

--identity-file, -i

Uma identidade SSH (chave privada) para usar

environment:delete

magento-cloud magento-cloud environment:delete [--delete-branch] [--no-delete-branch] [--type TYPE] [-t|--only-type ONLY-TYPE] [--exclude EXCLUDE] [--exclude-type EXCLUDE-TYPE] [--inactive] [--merged] [--allow-delete-parent] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]...

Excluir um ou mais ambientes

When a Magento Cloud environment is deleted, it will become "inactive": it will
exist only as a Git branch, containing code but no services, databases nor
files.

This command allows you to delete environments as well as their Git branches.

Argumentos

environment

Os ambientes a serem excluídos. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

Opções

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

--delete-branch

Excluir ramificações Git para ambientes inativos, sem confirmação

--no-delete-branch

Não excluir ramificações Git (ambientes inativos)

--type

Excluir todos os ambientes de um tipo (adicionando a qualquer outro selecionado) Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--only-type, -t

Somente os ambientes de exclusão de um tipo específico de Valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--exclude

Ambiente(s) a não excluir. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--exclude-type

Os tipos de ambiente dos quais não excluir valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--inactive

Excluir todos os ambientes inativos (adicionando a quaisquer outros selecionados)

--merged

Excluir todos os ambientes mesclados (adicionando a qualquer outro selecionado)

--allow-delete-parent

Permitir que ambientes com filhos sejam excluídos

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

environment:http-access

magento-cloud magento-cloud httpaccess [--access ACCESS] [--auth AUTH] [--enabled ENABLED] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]

Atualizar configurações de acesso HTTP para um ambiente

Opções

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

--access

Restrição de acesso no formato "permissão:endereço". Use 0 para limpar todos os endereços.

--auth

Credenciais de autenticação Básicas do HTTP no formato "nome de usuário:senha". Use 0 para limpar todas as credenciais.

--enabled

Se o controle de acesso deve ser ativado: 1 para ativar, 0 para desativar

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

environment:info

magento-cloud magento-cloud environment:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<property>] [<value>]

Ler ou definir propriedades de um ambiente

Argumentos

property

O nome da propriedade

value

Definir um novo valor para a propriedade

Opções

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

--refresh

Se o cache deve ser atualizado

--date-fmt

O formato de data (como uma string de formato de data do PHP)

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

environment:init

magento-cloud magento-cloud environment:init [--profile PROFILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] <url>

Inicializar um ambiente a partir de um repositório Git público

Argumentos

url

Um URL para um repositório Git

Opções

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

--profile

O nome do perfil

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

environment:list

magento-cloud magento-cloud environments [-I|--no-inactive] [--pipe] [--refresh REFRESH] [--sort SORT] [--reverse] [--type TYPE] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT]

Obter uma lista de ambientes

Opções

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

--no-inactive, -I

Não mostrar ambientes inativos

--pipe

Gerar uma lista simples de IDs de ambiente.

--refresh

Se a lista deve ser atualizada.

--sort

Uma propriedade para classificar por

--reverse

Classificar em ordem inversa (descendente)

--type

Filtrar a lista por tipos de ambiente. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: id*, title*, status*, type*, created, machine_name, updated (* = colunas padrão). O caractere "+" pode ser usado como um espaço reservado para as colunas padrão. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--project, -p

A ID ou URL do projeto

environment:logs

magento-cloud magento-cloud log [--lines LINES] [--tail] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [--] [<type>]

Ler logs de um ambiente

Argumentos

type

O tipo de log, por exemplo, "acesso" ou "erro"

Opções

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

--lines

O número de linhas a serem exibidas

--tail

Continuamente rastrear o log

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

--worker

Um nome de trabalhador

--instance, -I

Uma ID de instância

environment:merge

magento-cloud magento-cloud merge [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<environment>]

Mesclar um ambiente

This command will initiate a Git merge of the specified environment into its parent environment.

Argumentos

environment

O ambiente a ser mesclado

Opções

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

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

environment:pause

magento-cloud magento-cloud environment:pause [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]

Pausar um ambiente

Pausing an environment helps to reduce resource consumption and carbon emissions.

The environment will be unavailable until it is resumed. No data will be lost.

Opções

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

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

environment:push

magento-cloud magento-cloud push [--target TARGET] [-f|--force] [--force-with-lease] [-u|--set-upstream] [--activate] [--parent PARENT] [--type TYPE] [--no-clone-parent] [-W|--no-wait] [--wait] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-i|--identity-file IDENTITY-FILE] [--] [<source>]

Enviar código para um ambiente

Argumentos

source

A referência de origem: um nome de ramificação ou hash de confirmação

Opções

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

--target

O nome da ramificação de destino. O padrão é a ramificação atual.

--force, -f

Permitir atualizações não rápidas

--force-with-lease

Permitir atualizações não rápidas se a ramificação de rastreamento remoto estiver atualizada

--set-upstream, -u

Defina o ambiente de destino como upstream para a ramificação de origem. Isso também definirá o projeto de destino como remoto para o repositório local.

--activate

Ativar o ambiente antes de enviar

--parent

Definir o novo ambiente principal (usado somente com — ativate)

--type

Definir o tipo de ambiente (usado somente com —ativate )

--no-clone-parent

Não clonar os dados da ramificação pai (usados somente com — ativate)

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--identity-file, -i

Uma identidade SSH (chave privada) para usar

environment:redeploy

magento-cloud magento-cloud redeploy [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]

Reimplantação de um ambiente

Opções

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

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

environment:relationships

magento-cloud magento-cloud relationships [-P|--property PROPERTY] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-i|--identity-file IDENTITY-FILE] [--] [<environment>]

Mostrar relações de um ambiente

Argumentos

environment

O ambiente

Opções

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

--property, -P

A propriedade de relacionamento a ser exibida

--refresh

Se os relacionamentos devem ser atualizados

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

--identity-file, -i

Uma identidade SSH (chave privada) para usar

environment:resume

magento-cloud magento-cloud environment:resume [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]

Retomar um ambiente pausado

Opções

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

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

environment:scp

magento-cloud magento-cloud scp [-r|--recursive] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE] [--] [<files>]...

Copiar arquivos de e para um ambiente usando scp

Argumentos

files

Arquivos para copiar. Use o prefixo remote: para definir locais remotos.

Opções

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

--recursive, -r

Copiar recursivamente diretórios inteiros

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

--worker

Um nome de trabalhador

--instance, -I

Uma ID de instância

--identity-file, -i

Uma identidade SSH (chave privada) para usar

environment:ssh

magento-cloud magento-cloud ssh [--pipe] [--all] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE] [--] [<cmd>]...

SSH para o ambiente atual

Argumentos

cmd

Um comando a ser executado no ambiente.

Opções

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

--pipe

Saída somente do URL SSH.

--all

Saída de todos os URLs SSH (para cada aplicativo).

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

--worker

Um nome de trabalhador

--instance, -I

Uma ID de instância

--identity-file, -i

Uma identidade SSH (chave privada) para usar

environment:synchronize

magento-cloud magento-cloud sync [--rebase] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait] [--] [<synchronize>]...

Sincronizar o código e/ou os dados de um ambiente a partir de seu pai

This command synchronizes to a child environment from its parent environment.

Synchronizing "code" means there will be a Git merge from the parent to the
child. Synchronizing "data" means that all files in all services (including
static files, databases, logs, search indices, etc.) will be copied from the
parent to the child.

Argumentos

synchronize

O que sincronizar: "código", "dados" ou ambos

Opções

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

--rebase

Sincronizar código rebaseando em vez de mesclar

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

environment:url

magento-cloud magento-cloud url [-1|--primary] [--browser BROWSER] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT]

Obter os URLs públicos de um ambiente

Opções

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

--primary, -1

Retornar apenas o URL da rota principal

--browser

O navegador a ser usado para abrir o URL. Defina 0 para nenhum.

--pipe

Transfira o URL para o stdout.

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

environment:xdebug

magento-cloud magento-cloud xdebug [--port PORT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE]

Abrir um túnel para o Xdebug no ambiente

Opções

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

--port

A porta local

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

--worker

Um nome de trabalhador

--instance, -I

Uma ID de instância

--identity-file, -i

Uma identidade SSH (chave privada) para usar

integration:activity:get

magento-cloud magento-cloud integration:activity:get [-P|--property PROPERTY] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [--] [<integration>] [<activity>]

Exibir informações detalhadas sobre uma única atividade de integração

Argumentos

integration

Uma ID de integração. Deixe em branco para escolher em uma lista.

activity

A ID da atividade. O padrão é a atividade de integração mais recente.

Opções

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

--property, -P

A propriedade a ser exibida

--project, -p

A ID ou URL do projeto

--environment, -e

[Opção obsoleta, não usada]

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--date-fmt

O formato de data (como uma string de formato de data do PHP)

integration:activity:list

magento-cloud magento-cloud int:act [--type TYPE] [-x|--exclude-type EXCLUDE-TYPE] [--limit LIMIT] [--start START] [--state STATE] [--result RESULT] [-i|--incomplete] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<id>]

Obter uma lista de atividades para uma integração

Argumentos

id

Uma ID de integração. Deixe em branco para escolher em uma lista.

Opções

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

--type

Filtrar atividades por tipo. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--exclude-type, -x

Excluir atividades por tipo. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco. Os caracteres % ou * podem ser usados como curinga para excluir tipos.

--limit

Limitar o número de resultados exibidos

--start

Somente atividades criadas antes desta data serão listadas

--state

Filtrar atividades por estado. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--result

Filtrar atividades por resultado

--incomplete, -i

Listar apenas atividades incompletas

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: id*, created*, description*, type*, state*, result*, completed (* = colunas padrão). O caractere "+" pode ser usado como um espaço reservado para as colunas padrão. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--date-fmt

O formato de data (como uma string de formato de data do PHP)

--project, -p

A ID ou URL do projeto

--environment, -e

[Opção obsoleta, não usada]

integration:activity:log

magento-cloud magento-cloud integration:activity:log [-t|--timestamps] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<integration>] [<activity>]

Exibir o log de uma atividade de integração

Argumentos

integration

Uma ID de integração. Deixe em branco para escolher em uma lista.

activity

A ID da atividade. O padrão é a atividade de integração mais recente.

Opções

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

--timestamps, -t

Exibir um carimbo de data e hora ao lado de cada mensagem

--date-fmt

O formato de data (como uma string de formato de data do PHP)

--project, -p

A ID ou URL do projeto

--environment, -e

[Opção obsoleta, não usada]

integration:add

magento-cloud magento-cloud integration:add [--type TYPE] [--base-url BASE-URL] [--bitbucket-url BITBUCKET-URL] [--username USERNAME] [--token TOKEN] [--key KEY] [--secret SECRET] [--license-key LICENSE-KEY] [--server-project SERVER-PROJECT] [--repository REPOSITORY] [--build-merge-requests BUILD-MERGE-REQUESTS] [--build-pull-requests BUILD-PULL-REQUESTS] [--build-draft-pull-requests BUILD-DRAFT-PULL-REQUESTS] [--build-pull-requests-post-merge BUILD-PULL-REQUESTS-POST-MERGE] [--build-wip-merge-requests BUILD-WIP-MERGE-REQUESTS] [--merge-requests-clone-parent-data MERGE-REQUESTS-CLONE-PARENT-DATA] [--pull-requests-clone-parent-data PULL-REQUESTS-CLONE-PARENT-DATA] [--resync-pull-requests RESYNC-PULL-REQUESTS] [--fetch-branches FETCH-BRANCHES] [--prune-branches PRUNE-BRANCHES] [--resources-init RESOURCES-INIT] [--url URL] [--shared-key SHARED-KEY] [--file FILE] [--events EVENTS] [--states STATES] [--environments ENVIRONMENTS] [--excluded-environments EXCLUDED-ENVIRONMENTS] [--from-address FROM-ADDRESS] [--recipients RECIPIENTS] [--channel CHANNEL] [--routing-key ROUTING-KEY] [--category CATEGORY] [--index INDEX] [--sourcetype SOURCETYPE] [--protocol PROTOCOL] [--syslog-host SYSLOG-HOST] [--syslog-port SYSLOG-PORT] [--facility FACILITY] [--message-format MESSAGE-FORMAT] [--auth-mode AUTH-MODE] [--auth-token AUTH-TOKEN] [--verify-tls VERIFY-TLS] [--header HEADER] [-p|--project PROJECT] [-W|--no-wait] [--wait]

Adicionar uma integração ao projeto

Opções

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

--type

O tipo de integração ('bitbucket', 'bitbucket_server', 'github', 'gitlab', 'webhook', 'health.email', 'health.pagerDuty', 'health.slack', 'health.webhook', 'httplog', 'script', 'newrelic', 'splunk', 'sumologic', 'syslog')

--base-url

O URL de base da instalação do servidor

--bitbucket-url

O URL base da instalação do Servidor Bitbucket

--username

O nome de usuário do servidor Bitbucket

--token

Um token de autenticação ou acesso para a integração

--key

Uma chave de consumidor OAuth de Bitbucket

--secret

Um segredo do consumidor OAuth do Bitbucket

--license-key

A chave de licença dos logs do New Relic

--server-project

O projeto (por exemplo, "namespace/repo")

--repository

O repositório a ser rastreado (por exemplo, "proprietário/repositório")

--build-merge-requests

GitLab: criar solicitações de mesclagem como ambientes

--build-pull-requests

Criar cada solicitação de pull como um ambiente

--build-draft-pull-requests

Criar solicitações de pull de rascunho

--build-pull-requests-post-merge

Criar solicitações pull com base em seu estado pós-mesclagem

--build-wip-merge-requests

GitLab: criar solicitações de mesclagem WIP

--merge-requests-clone-parent-data

GitLab: clonar dados para solicitações de mesclagem

--pull-requests-clone-parent-data

Clonar os dados do ambiente pai para solicitações de pull

--resync-pull-requests

Sincronizar novamente os dados do ambiente de solicitação de pull em cada build

--fetch-branches

Buscar todas as ramificações remotas (como ambientes inativos)

--prune-branches

Excluir ramificações que não existem no local remoto

--resources-init

Os recursos a serem usados ao inicializar um novo serviço ('minimum', 'default', 'manual', 'parent')

--url

O endpoint do URL ou da API para a integração

--shared-key

Webhook: a chave secreta compartilhada JWS

--file

O nome de um arquivo local que contém o script a ser carregado

--events

Uma lista de eventos nos quais agir, por exemplo, environment.push

--states

Uma lista de estados nos quais agir; por exemplo, pendente, em_andamento, concluído

--environments

As IDs de ambiente a serem incluídas

--excluded-environments

As IDs de ambiente a serem excluídos

--from-address

[Opcional] Personalizar do endereço para emails de alerta

--recipients

Os endereços de email dos destinatários

--channel

O canal Slack

--routing-key

A chave de roteamento PagerDuty

--category

A categoria Lógica Sumo, usada para filtragem

--index

O índice do Splunk

--sourcetype

O tipo de origem do evento Splunk

--protocol

Protocolo de transporte do Syslog ('tcp', 'udp', 'tls')

--syslog-host

Host Syslog relay/collector

--syslog-port

Porta de relé/coletor do Syslog

--facility

Instalação do Syslog

--message-format

Formato de mensagem do Syslog ('rfc3164' ou 'rfc5424')

--auth-mode

Modo de autenticação ("prefix" ou "structured_data")

--auth-token

Token de autenticação

--verify-tls

Se a verificação do certificado HTTPS deve ser habilitada (recomendado)

--header

Cabeçalho(s) HTTP para usar em solicitações POST. Separe os nomes e os valores com dois pontos (:).

--project, -p

A ID ou URL do projeto

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

integration:delete

magento-cloud magento-cloud integration:delete [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<id>]

Excluir uma integração de um projeto

Argumentos

id

A ID de integração. Deixe em branco para escolher em uma lista.

Opções

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

--project, -p

A ID ou URL do projeto

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

integration:get

magento-cloud magento-cloud integration:get [-P|--property [PROPERTY]] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [--] [<id>]

Exibir detalhes de uma integração

Argumentos

id

Uma ID de integração. Deixe em branco para escolher em uma lista.

Opções

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

--property, -P

A propriedade de integração a ser exibida

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--project, -p

A ID ou URL do projeto

integration:list

magento-cloud magento-cloud integrations [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT]

Exibir uma lista de integrações de projeto

Opções

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

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: id, resumo, tipo. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--project, -p

A ID ou URL do projeto

integration:update

magento-cloud magento-cloud integration:update [--type TYPE] [--base-url BASE-URL] [--bitbucket-url BITBUCKET-URL] [--username USERNAME] [--token TOKEN] [--key KEY] [--secret SECRET] [--license-key LICENSE-KEY] [--server-project SERVER-PROJECT] [--repository REPOSITORY] [--build-merge-requests BUILD-MERGE-REQUESTS] [--build-pull-requests BUILD-PULL-REQUESTS] [--build-draft-pull-requests BUILD-DRAFT-PULL-REQUESTS] [--build-pull-requests-post-merge BUILD-PULL-REQUESTS-POST-MERGE] [--build-wip-merge-requests BUILD-WIP-MERGE-REQUESTS] [--merge-requests-clone-parent-data MERGE-REQUESTS-CLONE-PARENT-DATA] [--pull-requests-clone-parent-data PULL-REQUESTS-CLONE-PARENT-DATA] [--resync-pull-requests RESYNC-PULL-REQUESTS] [--fetch-branches FETCH-BRANCHES] [--prune-branches PRUNE-BRANCHES] [--resources-init RESOURCES-INIT] [--url URL] [--shared-key SHARED-KEY] [--file FILE] [--events EVENTS] [--states STATES] [--environments ENVIRONMENTS] [--excluded-environments EXCLUDED-ENVIRONMENTS] [--from-address FROM-ADDRESS] [--recipients RECIPIENTS] [--channel CHANNEL] [--routing-key ROUTING-KEY] [--category CATEGORY] [--index INDEX] [--sourcetype SOURCETYPE] [--protocol PROTOCOL] [--syslog-host SYSLOG-HOST] [--syslog-port SYSLOG-PORT] [--facility FACILITY] [--message-format MESSAGE-FORMAT] [--auth-mode AUTH-MODE] [--auth-token AUTH-TOKEN] [--verify-tls VERIFY-TLS] [--header HEADER] [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<id>]

Atualizar uma integração

Argumentos

id

A ID da integração a ser atualizada

Opções

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

--type

O tipo de integração ('bitbucket', 'bitbucket_server', 'github', 'gitlab', 'webhook', 'health.email', 'health.pagerDuty', 'health.slack', 'health.webhook', 'httplog', 'script', 'newrelic', 'splunk', 'sumologic', 'syslog')

--base-url

O URL de base da instalação do servidor

--bitbucket-url

O URL base da instalação do Servidor Bitbucket

--username

O nome de usuário do servidor Bitbucket

--token

Um token de autenticação ou acesso para a integração

--key

Uma chave de consumidor OAuth de Bitbucket

--secret

Um segredo do consumidor OAuth do Bitbucket

--license-key

A chave de licença dos logs do New Relic

--server-project

O projeto (por exemplo, "namespace/repo")

--repository

O repositório a ser rastreado (por exemplo, "proprietário/repositório")

--build-merge-requests

GitLab: criar solicitações de mesclagem como ambientes

--build-pull-requests

Criar cada solicitação de pull como um ambiente

--build-draft-pull-requests

Criar solicitações de pull de rascunho

--build-pull-requests-post-merge

Criar solicitações pull com base em seu estado pós-mesclagem

--build-wip-merge-requests

GitLab: criar solicitações de mesclagem WIP

--merge-requests-clone-parent-data

GitLab: clonar dados para solicitações de mesclagem

--pull-requests-clone-parent-data

Clonar os dados do ambiente pai para solicitações de pull

--resync-pull-requests

Sincronizar novamente os dados do ambiente de solicitação de pull em cada build

--fetch-branches

Buscar todas as ramificações remotas (como ambientes inativos)

--prune-branches

Excluir ramificações que não existem no local remoto

--resources-init

Os recursos a serem usados ao inicializar um novo serviço ('minimum', 'default', 'manual', 'parent')

--url

O endpoint do URL ou da API para a integração

--shared-key

Webhook: a chave secreta compartilhada JWS

--file

O nome de um arquivo local que contém o script a ser carregado

--events

Uma lista de eventos nos quais agir, por exemplo, environment.push

--states

Uma lista de estados nos quais agir; por exemplo, pendente, em_andamento, concluído

--environments

As IDs de ambiente a serem incluídas

--excluded-environments

As IDs de ambiente a serem excluídos

--from-address

[Opcional] Personalizar do endereço para emails de alerta

--recipients

Os endereços de email dos destinatários

--channel

O canal Slack

--routing-key

A chave de roteamento PagerDuty

--category

A categoria Lógica Sumo, usada para filtragem

--index

O índice do Splunk

--sourcetype

O tipo de origem do evento Splunk

--protocol

Protocolo de transporte do Syslog ('tcp', 'udp', 'tls')

--syslog-host

Host Syslog relay/collector

--syslog-port

Porta de relé/coletor do Syslog

--facility

Instalação do Syslog

--message-format

Formato de mensagem do Syslog ('rfc3164' ou 'rfc5424')

--auth-mode

Modo de autenticação ("prefix" ou "structured_data")

--auth-token

Token de autenticação

--verify-tls

Se a verificação do certificado HTTPS deve ser habilitada (recomendado)

--header

Cabeçalho(s) HTTP para usar em solicitações POST. Separe os nomes e os valores com dois pontos (:).

--project, -p

A ID ou URL do projeto

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

integration:validate

magento-cloud magento-cloud integration:validate [-p|--project PROJECT] [--] [<id>]

Validar uma integração existente

This command allows you to check whether an integration is valid.

An exit code of 0 means the integration is valid, while 4 means it is invalid.
Any other exit code indicates an unexpected error.

Integrations are validated automatically on creation and on update. However,
because they involve external resources, it is possible for a valid integration
to become invalid. For example, an access token may be revoked, or an external
repository may be deleted.

Argumentos

id

Uma ID de integração. Deixe em branco para escolher em uma lista.

Opções

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

--project, -p

A ID ou URL do projeto

local:build

magento-cloud magento-cloud build [-a|--abslinks] [-s|--source SOURCE] [-d|--destination DESTINATION] [-c|--copy] [--clone] [--run-deploy-hooks] [--no-clean] [--no-archive] [--no-backup] [--no-cache] [--no-build-hooks] [--no-deps] [--working-copy] [--concurrency CONCURRENCY] [--lock] [--] [<app>]...

Criar o projeto atual localmente

Argumentos

app

Especificar aplicativos a serem compilados

Opções

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

--abslinks, -a

Usar links absolutos

--source, -s

O diretório de origem. O padrão é a raiz do projeto atual.

--destination, -d

O destino, ao qual a raiz da Web de cada aplicativo será vinculada. Padrão: _www

--copy, -c

Copie para um diretório de build, em vez de criar symlinking a partir da origem

--clone

Usar o Git para clonar o HEAD atual no diretório de compilação

--run-deploy-hooks

Executar ganchos deploy e/ou post_deploy

--no-clean

Não remover compilações antigas

--no-archive

Não criar ou usar um arquivo morto de compilação

--no-backup

Não fazer backup da build anterior

--no-cache

Desativar armazenamento em cache

--no-build-hooks

Não executar ganchos pós-compilação

--no-deps

Não instalar as dependências de compilação localmente

--working-copy

Drush: use o Git para clonar um repositório de cada módulo Drupal em vez de simplesmente baixar uma versão

--concurrency

Drush: defina o número de projetos simultâneos que serão processados ao mesmo tempo

--lock

Drush: criar ou atualizar um arquivo de bloqueio (disponível somente com a versão 7+ do Drush)

local:dir

magento-cloud magento-cloud dir [<subdir>]

Encontrar a raiz do projeto local

Argumentos

subdir

O subdiretório a ser localizado ("local", "web" ou "compartilhado")

Opções

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

metrics:all

magento-cloud magento-cloud metrics [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

BETA Mostrar métricas de CPU, disco e memória para um ambiente

Opções

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

--bytes, -B

Mostrar tamanhos em bytes

--range, -r

O intervalo de tempo. As métricas serão carregadas por essa duração até a hora de término (—para). Você pode especificar unidades: horas (h), minutos (m) ou segundos (s). Mínimo de 5m, máximo de 8h ou mais (dependendo do projeto), padrão de 10m.

--interval, -i

O intervalo. O padrão é uma divisão do intervalo. Você pode especificar unidades: horas (h), minutos (m) ou segundos (s). Mínimo 1 m.

--to

A hora final. O padrão é agora.

--latest, -1

Mostrar apenas o último ponto de dados único

--service, -s

Filtrar por nome de serviço ou aplicativo Os caracteres % ou * podem ser usados como curinga.

--type

Filtrar por tipo de serviço (se — service não for fornecido). A versão não é necessária. Os caracteres % ou * podem ser usados como curinga.

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: timestamp*, serviço*, cpu_percent*, mem_percent*, disk_percent*, tmp_disk_percent*, cpu_limit, cpu_used, disk_limit, disk_used, inodes_limit, inodes_percent, inodes_used, mem_limit, mem_used, tmp_disk_limit, tmp_disk_used, tmp_inodes_limit, tmp_inodes_percent, tmp_inodes_used, type (* = colunas padrão). O caractere "+" pode ser usado como um espaço reservado para as colunas padrão. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--date-fmt

O formato de data (como uma string de formato de data do PHP)

metrics:cpu

magento-cloud magento-cloud cpu [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

BETA Mostrar o uso de um ambiente do CPU

Opções

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

--range, -r

O intervalo de tempo. As métricas serão carregadas por essa duração até a hora de término (—para). Você pode especificar unidades: horas (h), minutos (m) ou segundos (s). Mínimo de 5m, máximo de 8h ou mais (dependendo do projeto), padrão de 10m.

--interval, -i

O intervalo. O padrão é uma divisão do intervalo. Você pode especificar unidades: horas (h), minutos (m) ou segundos (s). Mínimo 1 m.

--to

A hora final. O padrão é agora.

--latest, -1

Mostrar apenas o último ponto de dados único

--service, -s

Filtrar por nome de serviço ou aplicativo Os caracteres % ou * podem ser usados como curinga.

--type

Filtrar por tipo de serviço (se — service não for fornecido). A versão não é necessária. Os caracteres % ou * podem ser usados como curinga.

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: carimbo de data e hora*, serviço*, usado*, limite*, porcentagem*, tipo (* = colunas padrão). O caractere "+" pode ser usado como um espaço reservado para as colunas padrão. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--date-fmt

O formato de data (como uma string de formato de data do PHP)

metrics:disk-usage

magento-cloud magento-cloud disk [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [--tmp] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

Mostrar o uso do disco de um ambiente

Opções

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

--bytes, -B

Mostrar tamanhos em bytes

--range, -r

O intervalo de tempo. As métricas serão carregadas por essa duração até a hora de término (—para). Você pode especificar unidades: horas (h), minutos (m) ou segundos (s). Mínimo de 5m, máximo de 8h ou mais (dependendo do projeto), padrão de 10m.

--interval, -i

O intervalo. O padrão é uma divisão do intervalo. Você pode especificar unidades: horas (h), minutos (m) ou segundos (s). Mínimo 1 m.

--to

A hora final. O padrão é agora.

--latest, -1

Mostrar apenas o último ponto de dados único

--service, -s

Filtrar por nome de serviço ou aplicativo Os caracteres % ou * podem ser usados como curinga.

--type

Filtrar por tipo de serviço (se — service não for fornecido). A versão não é necessária. Os caracteres % ou * podem ser usados como curinga.

--tmp

Relatar uso de disco temporário (mostra colunas: timestamp, serviço, tmp_used, tmp_limit, tmp_percent, tmp_ipercent)

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: timestamp*, service*, used*, limit*, percent*, ipercent*, tmp_percent*, ilimit, iused, tmp_ilimit, tmp_ipercent, tmp_iused, tmp_limit, tmp_used, type (* = colunas padrão). O caractere "+" pode ser usado como um espaço reservado para as colunas padrão. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--date-fmt

O formato de data (como uma string de formato de data do PHP)

metrics:memory

magento-cloud magento-cloud mem [-B|--bytes] [-r|--range RANGE] [-i|--interval INTERVAL] [--to TO] [-1|--latest] [-s|--service SERVICE] [--type TYPE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

BETA Mostra o uso de memória de um ambiente

Opções

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

--bytes, -B

Mostrar tamanhos em bytes

--range, -r

O intervalo de tempo. As métricas serão carregadas por essa duração até a hora de término (—para). Você pode especificar unidades: horas (h), minutos (m) ou segundos (s). Mínimo de 5m, máximo de 8h ou mais (dependendo do projeto), padrão de 10m.

--interval, -i

O intervalo. O padrão é uma divisão do intervalo. Você pode especificar unidades: horas (h), minutos (m) ou segundos (s). Mínimo 1 m.

--to

A hora final. O padrão é agora.

--latest, -1

Mostrar apenas o último ponto de dados único

--service, -s

Filtrar por nome de serviço ou aplicativo Os caracteres % ou * podem ser usados como curinga.

--type

Filtrar por tipo de serviço (se — service não for fornecido). A versão não é necessária. Os caracteres % ou * podem ser usados como curinga.

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: carimbo de data e hora*, serviço*, usado*, limite*, porcentagem*, tipo (* = colunas padrão). O caractere "+" pode ser usado como um espaço reservado para as colunas padrão. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--date-fmt

O formato de data (como uma string de formato de data do PHP)

mount:download

magento-cloud magento-cloud mount:download [-a|--all] [-m|--mount MOUNT] [--target TARGET] [--source-path] [--delete] [--exclude EXCLUDE] [--include INCLUDE] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE]

Baixar arquivos de uma montagem, usando o 'rsync'

Opções

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

--all, -a

Baixar de todas as montagens

--mount, -m

A montagem (como um caminho relativo ao aplicativo)

--target

O diretório no qual os arquivos serão baixados. Se — all for usado, o caminho de montagem será anexado

--source-path

Use o caminho de origem da montagem (em vez do caminho de montagem) como um subdiretório do destino, quando — all for usado

--delete

Se os arquivos irrelevantes devem ser excluídos no diretório de destino

--exclude

Arquivos a serem excluídos do download (padrão)

--include

Arquivo(s) não a excluir (padrão)

--refresh

Se o cache deve ser atualizado

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

--worker

Um nome de trabalhador

--instance, -I

Uma ID de instância

--identity-file, -i

Uma identidade SSH (chave privada) para usar

mount:list

magento-cloud magento-cloud mounts [--paths] [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE]

Obter uma lista de montagens

Opções

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

--paths

Saída somente dos caminhos de montagem (um por linha)

--refresh

Se o cache deve ser atualizado

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: definição, caminho. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

--worker

Um nome de trabalhador

--instance, -I

Uma ID de instância

mount:size

magento-cloud magento-cloud mount:size [-B|--bytes] [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE]

Verificar o uso de montagens no disco

Use this command to check the disk size and usage for an application's mounts.

Mounts are directories mounted into the application from a persistent, writable
filesystem. They are configured in the mounts key in the application configuration.

The filesystem's total size is determined by the disk key in the same file.

Opções

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

--bytes, -B

Mostrar tamanhos em bytes

--refresh

Atualizar o cache

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: disponível, máx, montagens, percent_used, tamanhos, usados. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--identity-file, -i

Uma identidade SSH (chave privada) para usar

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

--worker

Um nome de trabalhador

--instance, -I

Uma ID de instância

mount:upload

magento-cloud magento-cloud mount:upload [--source SOURCE] [-m|--mount MOUNT] [--delete] [--exclude EXCLUDE] [--include INCLUDE] [--refresh] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-I|--instance INSTANCE] [-i|--identity-file IDENTITY-FILE]

Carregar arquivos para uma montagem, usando o 'rsync'

Opções

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

--source

Um diretório contendo arquivos para fazer upload

--mount, -m

A montagem (como um caminho relativo ao aplicativo)

--delete

Se os arquivos irrelevantes devem ser excluídos na montagem

--exclude

Arquivos a serem excluídos do upload (padrão)

--include

Arquivo(s) não a excluir (padrão)

--refresh

Se o cache deve ser atualizado

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

--worker

Um nome de trabalhador

--instance, -I

Uma ID de instância

--identity-file, -i

Uma identidade SSH (chave privada) para usar

operation:list

magento-cloud magento-cloud ops [--full] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]

Operações de tempo de execução de lista do Beta em um ambiente

Opções

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

--full

Não limite o comprimento do comando a ser exibido. O limite padrão é de 24 linhas.

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

--worker

Um nome de trabalhador

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: service*, name*, start*, role, stop (* = colunas padrão). O caractere "+" pode ser usado como um espaço reservado para as colunas padrão. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

operation:run

magento-cloud magento-cloud operation:run [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--worker WORKER] [-W|--no-wait] [--wait] [--] [<operation>]

BETA Execute uma operação no ambiente

Argumentos

operation

O nome da operação

Opções

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

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

--worker

Um nome de trabalhador

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

project:clear-build-cache

magento-cloud magento-cloud project:clear-build-cache [-p|--project PROJECT]

Limpar o cache de criação de um projeto

Opções

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

--project, -p

A ID ou URL do projeto

project:get

magento-cloud magento-cloud get [-e|--environment ENVIRONMENT] [--depth DEPTH] [--build] [-p|--project PROJECT] [-i|--identity-file IDENTITY-FILE] [--] [<project>] [<directory>]

Clonar um projeto localmente

Argumentos

project

A ID do projeto

directory

O diretório para o qual clonar. O padrão é o título do projeto

Opções

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

--environment, -e

A ID de ambiente a ser clonada. O padrão é o padrão do projeto ou o primeiro ambiente disponível

--depth

Criar um clone superficial: limite o número de confirmações no histórico

--build

Criar o projeto após a clonagem

--project, -p

A ID ou URL do projeto

--identity-file, -i

Uma identidade SSH (chave privada) para usar

project:info

magento-cloud magento-cloud project:info [--refresh] [--date-fmt DATE-FMT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-W|--no-wait] [--wait] [--] [<property>] [<value>]

Ler ou definir propriedades de um projeto

Argumentos

property

O nome da propriedade

value

Definir um novo valor para a propriedade

Opções

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

--refresh

Se o cache deve ser atualizado

--date-fmt

O formato de data (como uma string de formato de data do PHP)

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--project, -p

A ID ou URL do projeto

--no-wait, -W

Não aguarde a conclusão da operação

--wait

Aguardar a conclusão da operação (padrão)

project:list

magento-cloud magento-cloud projects [--pipe] [--region REGION] [--title TITLE] [--my] [--refresh REFRESH] [--sort SORT] [--reverse] [--page PAGE] [-c|--count COUNT] [--format FORMAT] [--columns COLUMNS] [--no-header] [--date-fmt DATE-FMT]

Obter uma lista de todos os projetos ativos

Opções

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

--pipe

Gerar uma lista simples de IDs de projeto. Desativa a paginação.

--region

Filtrar por região (correspondência exata)

--title

Filtrar por título (pesquisa que não diferencia maiúsculas de minúsculas)

--my

Exibir somente seus projetos

--refresh

Atualizar ou não a lista

--sort

Uma propriedade para classificar por

--reverse

Classificar em ordem inversa (descendente)

--page

Número da página. Isto ativa a paginação, apesar da configuração ou — count. Ignorado se o — pipe for indicado.

--count, -c

O número de projetos a serem exibidos por página. Use 0 para desativar a paginação. Ignorado se o — page for especificado.

--format

O formato de saída: table, csv, tsv ou plain

--columns

Colunas a serem exibidas. Colunas disponíveis: id*, título*, região*, created_at, organization_id, organization_label, organization_name, status (* = colunas padrão). O caractere "+" pode ser usado como um espaço reservado para as colunas padrão. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--date-fmt

O formato de data (como uma string de formato de data do PHP)

project:set-remote

magento-cloud magento-cloud set-remote [<project>]

Definir o projeto remoto para o repositório Git atual

Argumentos

project

A ID do projeto

Opções

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

repo:cat

magento-cloud magento-cloud repo:cat [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] <path>

Ler um arquivo no repositório do projeto

Argumentos

path

O caminho para o arquivo

Opções

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

--commit, -c

O SHA de confirmação. Isso também pode aceitar os sufixos "HEAD" e acento circunflexo (^) ou til (~) para confirmações principais.

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

repo:ls

magento-cloud magento-cloud repo:ls [-d|--directories] [-f|--files] [--git-style] [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<path>]

Listar arquivos no repositório do projeto

Argumentos

path

O caminho para um subdiretório

Opções

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

--directories, -d

Mostrar somente diretórios

--files, -f

Mostrar somente arquivos

--git-style

Saída de estilo semelhante a "git ls-tree"

--commit, -c

O SHA de confirmação. Isso também pode aceitar os sufixos "HEAD" e acento circunflexo (^) ou til (~) para confirmações principais.

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

repo:read

magento-cloud magento-cloud read [-c|--commit COMMIT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<path>]

Ler um diretório ou arquivo no repositório do projeto

Argumentos

path

O caminho para o diretório ou arquivo

Opções

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

--commit, -c

O SHA de confirmação. Isso também pode aceitar os sufixos "HEAD" e acento circunflexo (^) ou til (~) para confirmações principais.

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

route:get

magento-cloud magento-cloud route:get [--id ID] [-1|--primary] [-P|--property PROPERTY] [--refresh] [--date-fmt DATE-FMT] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [-i|--identity-file IDENTITY-FILE] [--] [<route>]

Exibir informações detalhadas sobre um roteiro

Argumentos

route

O URL original da rota

Opções

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

--id

Uma ID de rota para selecionar

--primary, -1

Selecionar a rota principal

--property, -P

A propriedade a ser exibida

--refresh

Ignorar o cache de rotas

--date-fmt

O formato de data (como uma string de formato de data do PHP)

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

[Opção obsoleta, não é mais usada]

--identity-file, -i

[Opção obsoleta, não é mais usada]

route:list

magento-cloud magento-cloud routes [--refresh] [--format FORMAT] [-c|--columns COLUMNS] [--no-header] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--] [<environment>]

Listar todas as rotas de um ambiente

Argumentos

environment

A ID do ambiente

Opções

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

--refresh

Ignorar o cache de rotas

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: route*, type*, to*, url (* = default columns). O caractere "+" pode ser usado como um espaço reservado para as colunas padrão. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

self:install

magento-cloud magento-cloud self:install [--shell-type SHELL-TYPE]

Instalar ou atualizar arquivos de configuração da CLI

This command automatically installs shell configuration for the Magento Cloud CLI,
adding autocompletion support and handy aliases. Bash and ZSH are supported.

Opções

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

--shell-type

O tipo de shell para preenchimento automático (bash ou zsh)

self:update

magento-cloud magento-cloud update [--no-major] [--unstable] [--manifest MANIFEST] [--current-version CURRENT-VERSION] [--timeout TIMEOUT]

Atualize a CLI para a versão mais recente

Opções

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

--no-major

Atualizar somente entre versões secundárias ou de patch

--unstable

Atualização para uma nova versão instável, se disponível

--manifest

Substituir o local do arquivo de manifesto

--current-version

Substituir a versão atual

--timeout

Um tempo limite para a verificação da versão

service:list

magento-cloud magento-cloud services [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [--format FORMAT] [-c|--columns COLUMNS] [--no-header]

Listar serviços no projeto

Opções

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

--refresh

Se o cache deve ser atualizado

--pipe

Gerar uma lista apenas de nomes de serviço

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--format

O formato de saída: table, csv, tsv ou plain

--columns, -c

Colunas a serem exibidas. Colunas disponíveis: disco, nome, tamanho, tipo. Os caracteres % ou * podem ser usados como curinga. Os valores podem ser divididos por vírgulas (por exemplo, "a,b,c") e/ou espaços em branco.

--no-header

Não gerar saída do cabeçalho da tabela

service:mongo:dump

magento-cloud magento-cloud mongodump [-c|--collection COLLECTION] [-z|--gzip] [-o|--stdout] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]

Criar um despejo de arquivo binário de dados do MongoDB

Opções

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

--collection, -c

A coleção para despejo

--gzip, -z

Compactar o despejo usando gzip

--stdout, -o

Saída para STDOUT em vez de um arquivo

--relationship, -r

O relacionamento de serviço a ser usado

--identity-file, -i

Uma identidade SSH (chave privada) para usar

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

service:mongo:export

magento-cloud magento-cloud mongoexport [-c|--collection COLLECTION] [--jsonArray] [--type TYPE] [-f|--fields FIELDS] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]

Exportar dados do MongoDB

Opções

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

--collection, -c

A coleção a ser exportada

--jsonArray

Exportar dados como uma única matriz JSON

--type

O tipo de exportação, por exemplo, "csv"

--fields, -f

Os campos a serem exportados

--relationship, -r

O relacionamento de serviço a ser usado

--identity-file, -i

Uma identidade SSH (chave privada) para usar

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

service:mongo:restore

magento-cloud magento-cloud mongorestore [-c|--collection COLLECTION] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]

Restaurar um despejo de arquivo binário de dados no MongoDB

Opções

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

--collection, -c

A coleção a restaurar

--relationship, -r

O relacionamento de serviço a ser usado

--identity-file, -i

Uma identidade SSH (chave privada) para usar

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

service:mongo:shell

magento-cloud magento-cloud mongo [--eval EVAL] [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP]

Usar o shell MongoDB

Opções

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

--eval

Passar um fragmento do JavaScript para o shell

--relationship, -r

O relacionamento de serviço a ser usado

--identity-file, -i

Uma identidade SSH (chave privada) para usar

--project, -p

A ID ou URL do projeto

--environment, -e

A ID do ambiente. Use "." para selecionar o ambiente padrão do projeto.

--app, -A

O nome do aplicativo remoto

service:redis-cli

magento-cloud magento-cloud redis [-r|--relationship RELATIONSHIP] [-i|--identity-file IDENTITY-FILE] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-A|--app APP] [--] [<args>]

Acesse a CLI Redis

Argumentos

args

Argumentos a serem adicionados ao comando Redis

Opções

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

--relationship, -r

O relacionamento de serviço a ser usado