Skip to main content

Configurando a CLI

É possível definir configurações padrão a serem utilizadas em todos os comandos, entregando uma experiênciua mais fluida no uso da CLI. Vamos ver algumas das opções.

Definir padrão de formato de saída​

O comando abaixo executa a alteração permanente do tipo de saída da CLI para JSON, ou seja, todos os comandos executados após este terão suas saídas nesse formato se não houver um outro formato especificado na linha do comando.

mgc config set --key defaultOutput --value json

Outros valores possíveis para essa configuração seriam: jsonpath-file, table, table-file, template, template-file, yaml, json, jsonpath.

Para mais detalhes de como utilizar cada um dos formatos, execute o comando de ajuda abaixo.

mgc --cli.output help

Neste guia vamos utilizar como padrão a saída do tipo json.

Se você desejar alterar o formato de saída para um comando específico, basta adicionar a flag -o seguida do formato desejado. Abaixo segue um exemplo:

mgc virtual-machines instances list -o table

Definir região​

Ao definir uma região padrão para a CLI todos os comandos executados farão referência a ela, salvo se outra região for informada na linha de comando. Para definir a região padrão como sendo br-ne1 execute o comando abaixo.

mgc config set --key region --value br-ne1

Há outros valores possíveis para essa variável de configuração, como por exemplo br-se1 . Consulte a lista de regiões disponíveis rodando o comando abaixo.

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

Remover highlights para scripts​

Caso esteja utilizando a CLI em scripts, é comum querer remover os highlights (cores, loading...) das operações, para isso, baste utilizar a flag --raw ao final dos comandos, exemplo:

mgc vm instances list --raw

Outras configurações​

Existem outras opções de configuração disponíveis:

  • Chunk Size: tamanho do chunk em requisições multipart de Object Storage.
  • Workers: número de processos paralelos em operações do Object Storage.

Você pode listar todas as configurações disponíveis com o comando abaixo.

mgc config list

E se desejar alterar qualquer uma delas, basta executar o comando config set com o nome da configuração (key) e do valor (value) a ser aplicado.

mgc config set --key nome_da_config --value valor_a_aplicar

Arquivo local de configurações​

As configurações alteradas pela CLI serão armazenadas em um arquivo local dentro da sua pasta de usuário: $HOME/.config/mgc/<PERFIL>/cli.yaml

No Windows essa pasta se localiza em: $env:APPDATA\mgc\<PERFIL>\

Onde <PERFIL> é o nome do perfil que você deseja configurar.