Skip to main content

Configurar a CLI

Objetivo​

Defina valores padrão para a CLI, como o formato de saída e a região, para não precisar informá-los a cada comando. Neste guia, você vai aprender a consultar, alterar e remover as configurações do workspace ativo.

Pré-requisitos​

Como fazer​

Definir o formato de saída padrão​

Defina o formato em que os comandos exibem os resultados. No exemplo abaixo, o padrão passa a ser JSON:

mgc config set \
    --key="defaultOutput" \
    --value="json"

Os formatos disponíveis são json, yaml e table.

Para usar outro formato em um único comando, sem alterar o padrão, adicione a flag -o seguida do formato ao final do comando, por exemplo -o table.

mgc virtual-machine instances list -o table

Definir a região padrão​

Defina a região em que os comandos serão executados. No exemplo abaixo, o padrão passa a ser br-ne1:

mgc config set \
    --key="region" \
    --value="br-ne1"

Para consultar as regiões disponíveis, execute:

mgc config get-schema --key="region" -o jsonpath=$.enum

Para usar outra região em um único comando, sem alterar o padrão, adicione a flag --region ao final do comando.

Listar as configurações disponíveis​

Liste todas as configurações que podem ser definidas na CLI, com o tipo e a descrição de cada uma:

mgc config list

Consultar os valores aceitos por uma configuração​

Veja o tipo, a descrição e os valores aceitos por uma configuração informando o nome dela:

mgc config get-schema --key="defaultOutput"

Consultar uma configuração​

Consulte o valor atual de uma configuração informando o nome dela:

mgc config get --key="region"

Remover uma configuração​

Remova uma configuração para que a CLI volte a usar o valor padrão. Por exemplo, ao remover a região, ela volta a ser br-se1:

mgc config delete --key="region"
info

As configurações valem apenas para o workspace ativo. Elas ficam salvas no arquivo cli.yaml, dentro da pasta do workspace, no diretório de configuração do seu sistema operacional:

  • Linux: ~/.config/mgc/<nome-do-workspace>/ (ou $XDG_CONFIG_HOME/mgc/<nome-do-workspace>/, se a variável estiver definida)
  • macOS: ~/Library/Application Support/mgc/<nome-do-workspace>/
  • Windows: %AppData%\mgc\<nome-do-workspace>\

Veja mais em Administrar workspaces.

Perguntas frequentes​

Como removo as cores e animações da saída para usar a CLI em scripts?
Adicione a flag --raw ao final do comando. Ela remove os destaques visuais, como cores e indicadores de carregamento, deixando a saída mais fácil de processar.

A configuração vale para todos os workspaces?
Não. Cada workspace tem as próprias configurações. Se você trocar de workspace, a CLI passa a usar as configurações definidas nele.

Por que o comando não usa a configuração que defini?
Flags informadas no próprio comando e variáveis de ambiente, como MGC_REGION, têm prioridade sobre as configurações do workspace. Veja como resolver em Comandos ignoram a configuração do workspace.

Próximos passos​