Salve as Configurações de Conexão

Nesta página

Localize o arquivo de configuração

Crie um perfil
Atualizar um perfil
Executar um comando com um perfil

Você pode salvar as configurações de conexão usadas com frequência como perfis. Os perfis armazenam os IDs do projeto, os IDs da organização e, opcionalmente, as chaves deAPI do para utilizar em futuras sessões do Atlas CLI. Para economizar tempo, você pode especificar um perfil em vez de usar os sinalizadores --projectId e --orgId com cada comando. O Atlas CLI armazena seus perfis em umarquivo de configuração do denominado config.toml.

Observação

Quaisquer configurações armazenadas emvariáveis de ambiente do têm precedência sobre as configurações armazenadas em perfis. Qualquer projeto ou organização especificado com os sinalizadores --projectId e --orgId tem precedência sobre o perfil e as variáveis de ambiente.

Localize o arquivo de configuração

O Atlas CLI salva o arquivo de configuração no seguinte local dependendo do seu sistema operacional:

%AppData/atlascli

/Users/{username}/Library/Application Support/atlascli

$XDG_CONFIG_HOME/atlascli

Por padrão, o Atlas CLI salva o arquivo de configuração no caminho definido na variável de ambiente do $XDG_CONFIG_HOME . Você pode modificar o caminho definido na variável $XDG_CONFIG_HOME para seu local preferido. Para saber mais sobre como modificar a $XDG_CONFIG_HOME variável , consulte Especificação do diretório base do XDG.

Se o $XDG_CONFIG_HOME não estiver configurado, o Atlas CLI utilizará:

$HOME/.config/atlascli

A Atlas CLI concede ao usuário que executou o comando acesso de leitura e gravação ao arquivo.

Crie um perfil

Na primeira vez que você executa o comando atlas auth login ou atlas config init , o Atlas CLI cria automaticamente o arquivo config.toml e um perfil padrão. Se você executar um comando sem especificar um perfil, variáveis de ambiente ou sinalizadores --projectId e --orgId , o Atlas CLI utilizará o perfil padrão para o comando.

Selecione seu caso de uso

Selecione um método de conexão com base no seu caso de uso:

Comando	Método de autenticação	Caso de uso
`atlas auth login`	Credenciais de login do Atlas e um token de autenticação	Ideal para uso sem necessidade de programação
`atlas config init`	Chaves de API	Ideal para uso programático

Para saber mais, consulte Selecionar um método de conexão.

Concluir os pré-requisitos

Instale o Atlas CLI.
Adicione o endereço IP do seu host à lista de acesso IP.
Se você selecionar atlas config init como seu método de conexão, deverá Configurar chaves de API.
Se a instalação do Atlas CLI estiver protegida por um firewall e você quiser usar uma URL proxy, configure a variável de ambiente HTTP_PROXY ou HTTPS_PROXY .
Importante
O Atlas CLI suporta esquemas http, https e socks5 . Você deve especificar cloud.mongodb.com/ como a URL de destino principal na lista de acesso do serviço de proxy. Você também deve especificar o nome de usuário e senha se a configuração de proxy permitir a autenticação.
Para saber mais,consulte Servidor proxy.

Siga estas etapas

Selecione um caso de uso e siga o procedimento para criar um perfil.

Selecione o perfil padrão ou um perfil nomeado.

Crie um perfil padrão para:

Execute um comando sem especificar um perfil, variáveis de ambiente ou sinalizadores --projectId e --orgId .
Use o sinalizador --profile default .

Crie um perfil nomeado para usar o sinalizador --profile <profileName> .

Siga estas etapas para criar o perfil padrão. Se o perfil padrão já existir, esses comandos atualizam os valores do perfil padrão.

Execute o comando de autenticação.

Execute o comando atlas auth login no seu terminal.

atlas auth login

O comando abre uma janela do navegador e retorna um código de ativação único. Este código expira após 10 minutos.

Inicie a sessão no Atlas.

Se você ainda não estiver registrado, entre na sua conta do Atlas no navegador.

Insira o código de autorização.

Cole seu código de ativação no navegador e clique em Confirm Authorization.

Retorne à Atlas CLI.

Retorne ao terminal. Se você se conectar com sucesso, verá uma mensagem:

Successfully logged in as {Your Email Address}.

Selecione sua organização padrão.

Pressione as teclas Down Arrow e Up Arrow para realçar a organização desejada e pressione Enter.

? Choose a default organization:  [Use arrows to move, type to filter]
> Org1 (5e39bf1212121e685774c81c)

Observação

Se você tiver acesso a mais de 500 organizações, deverá digitar o ID da organização ou o nome da organização para filtrar os resultados antes de usar as setas para selecionar uma organização.

Selecione seu projeto padrão.

Pressione as teclas Down Arrow e Up Arrow para realçar o projeto desejado e pressione Enter.

? Choose a default project:  [Use arrows to move, type to filter]
  Project1 (5e5ebffd0c04a97009061234)
  Project2 (5cfacee6014b761b07f15678)
> Project3 (5e39bf4979358e6857741212)
  Project4 (5c815cc7014b768fb67e3434)

Selecione seu formato de saída padrão.

Pressione as teclas Down Arrow e Up Arrow para realçar o formato de saída desejado e pressione Enter.

? Default Output Format:  [Use arrows to move, type to filter]
> plaintext
  json

Opção	Descrição
`plaintext`	Saída legível por humanos que inclui todos os campos que o Atlas CLI retorna.
`json`	Saída JSON que inclui todos os campos que o MongoDB CLI retorna.

Especifique o caminho para o shell do MongoDB shell,, em seu`mongosh` sistema.

O Atlas CLI utiliza o caminho mongosh especificado para que você possa acessar seus sistemas. O valor padrão é /usr/local/bin/mongosh. Pressione Enter para aceitar o padrão ou especifique o caminho para mongosh em seu sistema e pressione Enter.

? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)

Verifique as configurações do seu perfil.

Visualize o arquivo de configuração ou execute o comando atlas config describe para verificar seu perfil. Para o perfil padrão, o <profileName> é default.

atlas config describe <profileName>

O comando retorna as seguintes configurações. O Atlas CLI edita o token de acesso e atualiza os valores do token por segurança.

SETTING           VALUE
"access_token":   "redacted",
"mongosh_path":   "/usr/local/bin/mongosh",
"org_id":         "60c9877baf349d6fc4fd9744",
"output":         "json",
"project_id":     "60c94857241ae99848af45ad",
"refresh_token":  "redacted",
"service":        "cloud"

Siga estas etapas para criar um perfil com um nome personalizado.

Execute o comando de autenticação.

Execute o comando atlas auth login no seu terminal com a bandeira profile <profileName> . <profileName> deve ser o nome desejado para seu novo perfil.

atlas auth login --profile myProfile

O comando abre uma janela do navegador e retorna um código de ativação único. Este código expira após 10 minutos.

Inicie a sessão no Atlas.

Se você ainda não estiver registrado, entre na sua conta do Atlas no navegador.

Insira o código de autorização.

Cole seu código de ativação no navegador e clique em Confirm Authorization.

Retorne à Atlas CLI.

Retorne ao terminal. Se você se conectar com sucesso, verá uma mensagem:

Successfully logged in as {Your Email Address}.

Selecione sua organização padrão.

Pressione as teclas Down Arrow e Up Arrow para realçar a organização desejada e pressione Enter.

? Choose a default organization:  [Use arrows to move, type to filter]
> Org1 (5e39bf1212121e685774c81c)

Observação

Selecione seu projeto padrão.

Pressione as teclas Down Arrow e Up Arrow para realçar o projeto desejado e pressione Enter.

? Choose a default project:  [Use arrows to move, type to filter]
  Project1 (5e5ebffd0c04a97009061234)
  Project2 (5cfacee6014b761b07f15678)
> Project3 (5e39bf4979358e6857741212)
  Project4 (5c815cc7014b768fb67e3434)

Selecione seu formato de saída padrão.

Pressione as teclas Down Arrow e Up Arrow para realçar o formato de saída desejado e pressione Enter.

? Default Output Format:  [Use arrows to move, type to filter]
> plaintext
  json

Opção	Descrição
`plaintext`	Saída legível por humanos que inclui todos os campos que o Atlas CLI retorna.
`json`	Saída JSON que inclui todos os campos que o MongoDB CLI retorna.

Especifique o caminho para o shell do MongoDB shell,, em seu`mongosh` sistema.

? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)

Verifique as configurações do seu perfil.

Visualize o arquivo de configuração ou execute o comando atlas config describe para verificar seu perfil. Para o perfil padrão, o <profileName> é default.

atlas config describe <profileName>

O comando retorna as seguintes configurações. O Atlas CLI edita o token de acesso e atualiza os valores do token por segurança.

SETTING           VALUE
"access_token":   "redacted",
"mongosh_path":   "/usr/local/bin/mongosh",
"org_id":         "60c9877baf349d6fc4fd9744",
"output":         "json",
"project_id":     "60c94857241ae99848af45ad",
"refresh_token":  "redacted",
"service":        "cloud"

Selecione o perfil padrão ou um perfil nomeado.

Crie um perfil padrão para:

Execute um comando sem especificar um perfil, variáveis de ambiente ou sinalizadores --projectId e --orgId .
Use o sinalizador --profile default .

Crie um perfil nomeado para usar o sinalizador --profile <profileName> .

Siga estas etapas para criar o perfil padrão. Se o perfil padrão já existir, esses comandos atualizam os valores do perfil padrão.

Execute o comando de autenticação.

Execute o comando atlas config init no seu terminal.

atlas config init

Insira suas chaves API.

Insira suas chaves pública e privada quando solicitado.

Selecione sua organização padrão.

Pressione as teclas Down Arrow e Up Arrow para realçar a organização desejada e pressione Enter.

? Choose a default organization:  [Use arrows to move, type to filter]
> Org1 (5e39bf1212121e685774c81c)

Selecione seu projeto padrão.

Pressione as teclas Down Arrow e Up Arrow para realçar o projeto desejado e pressione Enter.

? Choose a default project:  [Use arrows to move, type to filter]
  Project1 (5e5ebffd0c04a97009061234)
  Project2 (5cfacee6014b761b07f15678)
> Project3 (5e39bf4979358e6857741212)
  Project4 (5c815cc7014b768fb67e3434)

Selecione seu formato de saída padrão.

Pressione as teclas Down Arrow e Up Arrow para realçar o formato de saída desejado e pressione Enter.

? Default Output Format:  [Use arrows to move, type to filter]
> plaintext
  json

Opção	Descrição
`plaintext`	Saída legível por humanos que inclui todos os campos que o Atlas CLI retorna.
`json`	Saída JSON que inclui todos os campos que o MongoDB CLI retorna.

Especifique o caminho para o shell do MongoDB shell,, em seu`mongosh` sistema.

? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)

Verifique as configurações do seu perfil.

Visualize o arquivo de configuração ou execute o comando atlas config describe para verificar seu perfil. Para o perfil padrão, o <profileName> é default.

atlas config describe <profileName>

O comando retorna as seguintes configurações. O Atlas CLI edita os valores da chave API por segurança.

SETTING            VALUE
"mongosh_path":    "/usr/local/bin/mongosh",
"org_id":          "60c9877baf349d6fc4fd9744",
"output":          "json",
"private_api_key": "redacted",
"project_id":      "60c94857241ae99848af45ad",
"public_api_key":  "redacted",
"service":         "cloud"

Siga estas etapas para criar um perfil com um nome personalizado.

Execute o comando de autenticação.

Execute o comando atlas config init no seu terminal com a bandeira profile <profileName> . <profileName> deve ser o nome desejado para seu novo perfil.

atlas config init --profile myProfile

Insira suas chaves API.

Insira suas chaves pública e privada quando solicitado.

Selecione sua organização padrão.

Pressione as teclas Down Arrow e Up Arrow para realçar a organização desejada e pressione Enter.

? Choose a default organization:  [Use arrows to move, type to filter]
> Org1 (5e39bf1212121e685774c81c)

Selecione seu projeto padrão.

Pressione as teclas Down Arrow e Up Arrow para realçar o projeto desejado e pressione Enter.

? Choose a default project:  [Use arrows to move, type to filter]
  Project1 (5e5ebffd0c04a97009061234)
  Project2 (5cfacee6014b761b07f15678)
> Project3 (5e39bf4979358e6857741212)
  Project4 (5c815cc7014b768fb67e3434)

Selecione seu formato de saída padrão.

Pressione as teclas Down Arrow e Up Arrow para realçar o formato de saída desejado e pressione Enter.

? Default Output Format:  [Use arrows to move, type to filter]
> plaintext
  json

Opção	Descrição
`plaintext`	Saída legível por humanos que inclui todos os campos que o Atlas CLI retorna.
`json`	Saída JSON que inclui todos os campos que o MongoDB CLI retorna.

Especifique o caminho para o shell do MongoDB shell,, em seu`mongosh` sistema.

? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)

Verifique as configurações do seu perfil.

Visualize o arquivo de configuração ou execute o comando atlas config describe para verificar seu perfil. Para o perfil padrão, o <profileName> é default.

atlas config describe <profileName>

O comando retorna as seguintes configurações. O Atlas CLI edita os valores da chave API por segurança.

SETTING            VALUE
"mongosh_path":    "/usr/local/bin/mongosh",
"org_id":          "60c9877baf349d6fc4fd9744",
"output":          "json",
"private_api_key": "redacted",
"project_id":      "60c94857241ae99848af45ad",
"public_api_key":  "redacted",
"service":         "cloud"

Atualizar um perfil

Você pode atualizar as configurações armazenadas em seu arquivo de configuração das seguintes maneiras:

Edite o arquivo config.toml com um editor de texto.
Execute o comando atlas config set para uma configuração. Isso edita um valor individual no arquivo config.toml .

Executar um comando com um perfil

Para executar um comando Atlas CLI usando um perfil:

Crie um Perfil.
Anexe o sinalizador --profile <profileName> a um comando ou omita o sinalizador --profile <profileName> para usar o perfil padrão.

Exemplo

Este comando usa um perfil chamado myProfile:

atlas <command> --profile myProfile

Este comando usa o perfil padrão:

atlas <command>

Voltar

Conecte

Migrar para a CLI do Atlas

Observação

Localize o arquivo de configuração

Crie um perfil

Selecione seu caso de uso

Concluir os pré-requisitos

Importante

Siga estas etapas

Execute o comando de autenticação.

Inicie a sessão no Atlas.

Insira o código de autorização.

Retorne à Atlas CLI.

Selecione sua organização padrão.

Observação

Selecione seu projeto padrão.

Selecione seu formato de saída padrão.

Especifique o caminho para o shell do MongoDB shell,, em seumongosh sistema.

Verifique as configurações do seu perfil.

Execute o comando de autenticação.

Inicie a sessão no Atlas.

Insira o código de autorização.

Retorne à Atlas CLI.

Selecione sua organização padrão.

Observação

Selecione seu projeto padrão.

Selecione seu formato de saída padrão.

Especifique o caminho para o shell do MongoDB shell,, em seumongosh sistema.

Verifique as configurações do seu perfil.

Execute o comando de autenticação.

Insira suas chaves API.

Selecione sua organização padrão.

Selecione seu projeto padrão.

Selecione seu formato de saída padrão.

Especifique o caminho para o shell do MongoDB shell,, em seumongosh sistema.

Verifique as configurações do seu perfil.

Execute o comando de autenticação.

Insira suas chaves API.

Selecione sua organização padrão.

Selecione seu projeto padrão.

Selecione seu formato de saída padrão.

Especifique o caminho para o shell do MongoDB shell,, em seumongosh sistema.

Verifique as configurações do seu perfil.

Atualizar um perfil

Executar um comando com um perfil

Exemplo

Especifique o caminho para o shell do MongoDB shell,, em seu`mongosh` sistema.

Especifique o caminho para o shell do MongoDB shell,, em seu`mongosh` sistema.

Especifique o caminho para o shell do MongoDB shell,, em seu`mongosh` sistema.

Especifique o caminho para o shell do MongoDB shell,, em seu`mongosh` sistema.