/ /

Guardar la configuración de conexión

Puedes guardar tu configuración de conexión más utilizada como perfiles. Los perfiles almacenan los IDs del grupo, los Identificadores de la Organización y, opcionalmente, API claves para utilizar en futuras sesiones de Atlas CLI. Para ahorrar tiempo, se puede especificar un perfil en lugar de usar el --projectId y --orgId banderas con cada comando. Atlas CLI almacena tus perfiles en un archivo de configuración llamado config.toml.

Nota

Todos los ajustes almacenados en Las variables de entorno tienen prioridad sobre los ajustes almacenados en los perfiles. Cualquier proyecto u organización especificado con los flags --projectId y --orgId tiene prioridad sobre tanto el perfil como las variables de entorno.

Localizar el archivo de configuración

El CLI de Atlas guarda el archivo de configuración en la siguiente ubicación, según el sistema operativo:

%AppData/atlascli

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

$XDG_CONFIG_HOME/atlascli

Por defecto, Atlas CLI guarda el archivo de configuración en la ruta definida en la variable de entorno $XDG_CONFIG_HOME. Puedes modificar la ruta definida en la variable $XDG_CONFIG_HOME a la ubicación que prefieras. Para obtener más información sobre cómo modificar la variable $XDG_CONFIG_HOME, consulta Especificación de directorio base de XDG.

Si $XDG_CONFIG_HOME no está configurado, Atlas CLI utiliza:

$HOME/.config/atlascli

La CLI de Atlas otorga al usuario que ejecutó el comando acceso de lectura y guardado al archivo.

Cree un perfil

La primera vez que se ejecuta el comando atlas auth login o atlas config init, la CLI de Atlas crea automáticamente el archivo config.toml y un perfil por defecto. Si ejecutas un comando sin especificar un perfil, variables de entorno o las banderas --projectId y --orgId, la Atlas CLI utiliza el perfil por defecto para el comando.

Selecciona tu caso de uso

Selecciona un método de conexión según tu caso de uso:

Opción	Método de autenticación	Caso de uso
`UserAccount`	Credenciales de inicio de sesión de Atlas y un token de autenticación	Mejor para uso no programático
`ServiceAccount`	Cuenta de servicio	Mejor para uso programático con una Cuenta de Servicio
`APIKeys`	Claves API	Ideal para el uso programático con una clave API

Para obtener más información, consulte Seleccionar un método de conexión.

Completar los requisitos previos

Instale el Atlas CLI.
Añadir la dirección IP del host a la lista de acceso IP.
Si selecciona atlas config init como su método de conexión, debe Configurar claves API.
Si tu instalación de Atlas CLI se encuentra detrás de un firewall y deseas utilizar una URL de proxy, configura las variables de entorno HTTP_PROXY o HTTPS_PROXY.
Importante
Atlas CLI es compatible con los esquemas http, https y socks5. Debe especificar cloud.mongodb.com/ como la URL principal de destino en la lista de acceso del servicio de proxy. También debe especificar el nombre de usuario y la contraseña si su configuración de proxy habilita la autenticación.
Para aprender más, consulta Servidor proxy.

Siga estos pasos

Seleccione un caso de uso y siga el procedimiento para crear un perfil.

Selecciona el perfil por defecto o un perfil con nombre.

Crea un perfil por defecto para:

Ejecutes un comando sin especificar un perfil, variables de entorno ni los indicadores --projectId y --orgId.
Utiliza la marca --profile default.

Crear un perfil con nombre para usar el flag --profile <profileName>.

Sigue estos pasos para crear el perfil por defecto. Si ya existe el perfil por defecto, estos comandos actualizan los valores del perfil por defecto.

Ejecutar el comando de autenticación.

Ejecutar el comando atlas auth login en la terminal.

atlas auth login

El comando abre una ventana del navegador y devuelve un código de activación de un solo uso. Este código expira después de 10 minutos.

Inicie sesión en Atlas.

Si aún no ha iniciado sesión, inicie sesión en su cuenta de Atlas en el navegador.

Introduzca el código de autorización.

Pega tu código de activación en el navegador y haz clic Confirm Authorization.

Vuelva a la Atlas CLI.

Regresar a la terminal. Si se conecta correctamente, verá un mensaje:

Successfully logged in as {Your Email Address}.

Selecciona tu organización por defecto.

Pulsa el Down Arrow y Up Arrow teclas para resaltar la organización deseada y presionar Enter.

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

Nota

Si tienes acceso a más de 500 organizaciones, debes escribir el Identificador de la Organización o el nombre de la organización para filtrar los resultados antes de usar las flechas para seleccionar una organización.

Selecciona tu Proyecto por defecto.

Presiona las teclas Down Arrow y Up Arrow para resaltar el proyecto deseado y presiona Enter.

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

Selecciona tu formato de salida por defecto.

Presione las teclas Down Arrow y Up Arrow para resaltar el formato de salida deseado y luego presione Enter.

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

Opción	Descripción
`plaintext`	Salida legible por humanos que incluye todos los campos que la Atlas CLI devuelve.
`json`	Salida JSON que incluye todos los campos que devuelve la CLI de MongoDB.

Especifica la ruta al MongoDB Shell, `mongosh`, en tu sistema.

La Atlas CLI utiliza la ruta especificada mongosh para que puedas acceder a tus implementaciones. El valor por defecto es /usr/local/bin/mongosh. Presiona Enter para aceptar la configuración por defecto o especifica la ruta al mongosh en tu sistema y presiona Enter.

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

Verifica la configuración de tu perfil.

Consulta el archivo de configuración o ejecuta el comando atlas config describe para verificar tu perfil. Para el perfil por defecto, el <profileName> es default.

atlas config describe <profileName>

El comando devuelve la configuración siguiente. La CLI de Atlas oculta los valores del token de acceso y del token de actualización por razones de seguridad.

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

Sigue estos pasos para crear un perfil con un nombre personalizado.

Ejecutar el comando de autenticación.

Ejecuta el comando atlas auth login en tu terminal con el flag profile <profileName>. <profileName> debe ser el nombre que deseas para tu nuevo perfil.

atlas auth login --profile myProfile

El comando abre una ventana del navegador y devuelve un código de activación de un solo uso. Este código expira después de 10 minutos.

Inicie sesión en Atlas.

Si aún no ha iniciado sesión, inicie sesión en su cuenta de Atlas en el navegador.

Introduzca el código de autorización.

Pegue su código de activación en el navegador y haga clic en Confirm Authorization.

Vuelva a la Atlas CLI.

Regresar a la terminal. Si se conecta correctamente, verá un mensaje:

Successfully logged in as {Your Email Address}.

Selecciona tu organización por defecto.

Presione las teclas Down Arrow y Up Arrow para resaltar la organización deseada y presione Enter.

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

Nota

Selecciona tu Proyecto por defecto.

Presiona las teclas Down Arrow y Up Arrow para resaltar el proyecto deseado y presiona Enter.

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

Selecciona tu formato de salida por defecto.

Presione las teclas Down Arrow y Up Arrow para resaltar el formato de salida deseado y luego presione Enter.

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

Opción	Descripción
`plaintext`	Salida legible por humanos que incluye todos los campos que la Atlas CLI devuelve.
`json`	Salida JSON que incluye todos los campos que devuelve la CLI de MongoDB.

Especifica la ruta al MongoDB Shell, `mongosh`, en tu sistema.

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

Verifica la configuración de tu perfil.

Consulta el archivo de configuración o ejecuta el comando atlas config describe para verificar tu perfil. Para el perfil por defecto, el <profileName> es default.

atlas config describe <profileName>

El comando devuelve la configuración siguiente. La CLI de Atlas oculta los valores del token de acceso y del token de actualización por razones de seguridad.

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

Selecciona el perfil por defecto o un perfil con nombre.

Crea un perfil por defecto para:

Ejecutes un comando sin especificar un perfil, variables de entorno ni los indicadores --projectId y --orgId.
Utiliza la marca --profile default.

Crear un perfil con nombre para usar el flag --profile <profileName>.

Sigue estos pasos para crear el perfil por defecto. Si ya existe el perfil por defecto, estos comandos actualizan los valores del perfil por defecto.

Ejecutar el comando de autenticación.

Ejecutar el comando atlas auth login en la terminal.

atlas auth login

Introduzca sus claves API.

Introducir las llaves privadas y públicas cuando se soliciten.

Selecciona tu organización por defecto.

Presione las teclas Down Arrow y Up Arrow para resaltar la organización deseada y presione Enter.

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

Selecciona tu Proyecto por defecto.

Presiona las teclas Down Arrow y Up Arrow para resaltar el proyecto deseado y presiona Enter.

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

Selecciona tu formato de salida por defecto.

Presione las teclas Down Arrow y Up Arrow para resaltar el formato de salida deseado y luego presione Enter.

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

Opción	Descripción
`plaintext`	Salida legible para el usuario que incluye todos los campos que retorna Atlas CLI.
`json`	Salida JSON que incluye todos los campos que devuelve la CLI de MongoDB.

Especifica la ruta al MongoDB Shell, `mongosh`, en tu sistema.

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

Verifica la configuración de tu perfil.

Consulta el archivo de configuración o ejecuta el comando atlas config describe para verificar tu perfil. Para el perfil por defecto, el <profileName> es default.

atlas config describe <profileName>

El comando devuelve la siguiente configuración. La Atlas CLI redacta los valores de clave de API por motivos de seguridad.

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"

Sigue estos pasos para crear un perfil con un nombre personalizado.

Ejecutar el comando de autenticación.

Ejecuta el comando atlas config init en tu terminal con el flag profile <profileName>. <profileName> debe ser el nombre que deseas para tu nuevo perfil.

atlas config init --profile myProfile

Introduzca sus claves API.

Introducir las llaves privadas y públicas cuando se soliciten.

Selecciona tu organización por defecto.

Presione las teclas Down Arrow y Up Arrow para resaltar la organización deseada y presione Enter.

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

Selecciona tu Proyecto por defecto.

Presiona las teclas Down Arrow y Up Arrow para resaltar el proyecto deseado y presiona Enter.

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

Selecciona tu formato de salida por defecto.

Presione las teclas Down Arrow y Up Arrow para resaltar el formato de salida deseado y luego presione Enter.

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

Opción	Descripción
`plaintext`	Salida legible para el usuario que incluye todos los campos que retorna Atlas CLI.
`json`	Salida JSON que incluye todos los campos que devuelve la CLI de MongoDB.

Especifica la ruta al MongoDB Shell, `mongosh`, en tu sistema.

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

Verifica la configuración de tu perfil.

Consulta el archivo de configuración o ejecuta el comando atlas config describe para verificar tu perfil. Para el perfil por defecto, el <profileName> es default.

atlas config describe <profileName>

El comando devuelve la siguiente configuración. La Atlas CLI redacta los valores de clave de API por motivos de seguridad.

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"

Actualizar un perfil

Puede actualizar la configuración almacenada en el archivo de configuración de la siguiente manera:

Edita el archivo config.toml con un editor de texto.
Ejecuta el comando atlas config set para una configuración. Esto edita un valor individual en el archivo config.toml.

Ejecutar un comando con un perfil

Para ejecutar un comando de Atlas CLI utilizando un perfil:

Crea un perfil.
Agrega el --profile <profileName> modificador a un comando u omite el --profile <profileName> modificador para utilizar el perfil por defecto.

Ejemplo

Este comando utiliza un perfil llamado myProfile:

atlas <command> --profile myProfile

Este comando utiliza el perfil por defecto:

atlas <command>

Volver

Conectar

Migrar a la Atlas CLI

Nota

Localizar el archivo de configuración

Cree un perfil

Selecciona tu caso de uso

Completar los requisitos previos

Importante

Siga estos pasos

Ejecutar el comando de autenticación.

Inicie sesión en Atlas.

Introduzca el código de autorización.

Vuelva a la Atlas CLI.

Selecciona tu organización por defecto.

Nota

Selecciona tu Proyecto por defecto.

Selecciona tu formato de salida por defecto.

Especifica la ruta al MongoDB Shell, mongosh, en tu sistema.

Verifica la configuración de tu perfil.

Ejecutar el comando de autenticación.

Inicie sesión en Atlas.

Introduzca el código de autorización.

Vuelva a la Atlas CLI.

Selecciona tu organización por defecto.

Nota

Selecciona tu Proyecto por defecto.

Selecciona tu formato de salida por defecto.

Especifica la ruta al MongoDB Shell, mongosh, en tu sistema.

Verifica la configuración de tu perfil.

Ejecutar el comando de autenticación.

Introduzca sus claves API.

Selecciona tu organización por defecto.

Selecciona tu Proyecto por defecto.

Selecciona tu formato de salida por defecto.

Especifica la ruta al MongoDB Shell, mongosh, en tu sistema.

Verifica la configuración de tu perfil.

Ejecutar el comando de autenticación.

Introduzca sus claves API.

Selecciona tu organización por defecto.

Selecciona tu Proyecto por defecto.

Selecciona tu formato de salida por defecto.

Especifica la ruta al MongoDB Shell, mongosh, en tu sistema.

Verifica la configuración de tu perfil.

Actualizar un perfil

Ejecutar un comando con un perfil

Ejemplo

Especifica la ruta al MongoDB Shell, `mongosh`, en tu sistema.

Especifica la ruta al MongoDB Shell, `mongosh`, en tu sistema.

Especifica la ruta al MongoDB Shell, `mongosh`, en tu sistema.

Especifica la ruta al MongoDB Shell, `mongosh`, en tu sistema.