Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.
Menu Docs
Página inicial do Docs
/ /
Conecte
Página inicial do Docs
/
Ferramentas
/
Atlas CLI
/
Conecte
Página inicial do Docs
/
Ferramentas
/
Atlas CLI
/
Conecte

Salve as Configurações de Conexão

You can save your frequently-used connection settings as profiles. Profiles store the project IDs, organization IDs, and, optionally, API keys to use in future Atlas CLI sessions. To save time, you can specify a profile instead of using the --projectId and --orgId flags with each command. The Atlas CLI stores your profiles in a configuration file called config.toml.

Observação

Todas as configurações armazenadas em variáveis de ambiente têm precedência sobre as configurações armazenadas nos 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

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:

Opção
Método de autenticação
Caso de uso

UserAccount

Credenciais de login do Atlas e um token de autenticação

Ideal para uso sem necessidade de programação

ServiceAccount

Conta de serviço

Ideal para uso programático com uma Conta de Serviço

APIKeys

Chaves de API

Ideal para uso programático com uma chave de API

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

Concluir os pré-requisitos

  • Instale o Atlas CLI.

  • Add your host's IP address to the IP access list.

  • 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 atrás de um firewall e você quiser usar uma URL de 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.

Uso não programático

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.

1
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.

2
Inicie a sessão no Atlas.

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

3
Insira o código de autorização.

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

4
Retorne à Atlas CLI.

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

Successfully logged in as {Your Email Address}.

5
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.

6
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)
7
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.

8
Specify the path to the MongoDB Shell, mongosh, on your system.

The Atlas CLI uses the specified mongosh path so that you can access your deployments. The default value is /usr/local/bin/mongosh. Press Enter to accept the default or specify the path to mongosh on your system and press Enter.

? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)
9
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"

Uso programático

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.

1
Execute o comando de autenticação.

Execute o comando atlas config init no seu terminal.

atlas config init
2
Insira suas chaves API.

Insira suas chaves pública e privada quando solicitado.

3
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)
4
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)
5
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.

6
Specify the path to the MongoDB Shell, mongosh, on your system.

The Atlas CLI uses the specified mongosh path so that you can access your deployments. The default value is /usr/local/bin/mongosh. Press Enter to accept the default or specify the path to mongosh on your system and press Enter.

? Default MongoDB Shell Path: [? for help] (/usr/local/bin/mongosh)
7
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
Próximo
Migrar para a CLI do Atlas
Avalie esta página

Nesta página