Atlas CLI Operational Runbook

Parent: Atlas CLI · Published reference · snapshot 2026-10-15

Depth-first rabbithole dossier for Atlas CLI Operational Runbook; source-anchored research pack.

These notes link each claim to its source. Some citations identify archived research reports that are no longer hosted on this site. A published reference means the content is available; it does not certify independent review or accuracy.Read the editorial policy and follow the sources before relying on a claim.

How it works

[low] When installing the Atlas CLI with Apt, a successful import of the MongoDB public GPG key returns an `OK`. Sources: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli.md [source]
[low] The Atlas CLI package conflicts with `atlas` and `nim` packages because both install the `atlas` executable. Sources: https://formulae.brew.sh/formula/mongodb-atlas-cli [source]

Problems, failure modes and limitations

[low] You can install both the Atlas CLI and `mongosh` using the `brew install mongodb-atlas` command, but you cannot install the Atlas CLI alone on Homebrew. Sources: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli.md [source]
[low] Redirect standard error output to a file using the pattern `myScript.sh 2> error.txt`. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-automate.md [source]
[low] You should regularly update scripts to discontinue use of deprecated commands because they will be removed in future releases. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-automate.md [source]
[low] The Atlas CLI prints error messages and command deprecation warnings in the command output. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-automate.md [source]
[low] An example deprecation message states that the `describe` command is deprecated and to use `atlas privateEndpoints aws interfaces describe <atlasPrivateEndpointId>` instead. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-automate.md [source]
[low] If you receive a `CANNOT_CLOSE_GROUP_ACTIVE_ATLAS_CLUSTERS` error, wait five minutes and then run the `atlas projects delete` command again. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-temporary-cluster.md [source]

Facts and statements

[medium] The Atlas CLI login command opens a browser window and returns a one-time activation code that expires after 10 minutes. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-save-connection-settings.md, https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli.md [source]
[low] The default value for the MongoDB shell binary is `/usr/local/bin/mongosh`. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-save-connection-settings.md [source]
[low] The `atlas config describe` command redacts access token, refresh token, and API key values in the settings it returns. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-save-connection-settings.md [source]
[low] The Atlas CLI saves its configuration file to a location that depends on the operating system. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-save-connection-settings.md [source]
[low] The first time you run `atlas auth login` or `atlas config init`, the Atlas CLI automatically creates the `config.toml` file and a default profile. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-save-connection-settings.md [source]
[low] Settings stored in environment variables take precedence over settings stored in profiles. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-save-connection-settings.md [source]
[low] Projects or organizations specified with the `--projectId` and `--orgId` flags take precedence over both profile settings and environment variables. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-save-connection-settings.md [source]
[low] The Atlas CLI supports `http`, `https`, and `socks5` proxy schemes. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-save-connection-settings.md [source]
[low] You must specify `cloud.mongodb.com/` as the main target URL in the proxy service's access list. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-save-connection-settings.md [source]
[low] The Atlas CLI stores user profiles in a configuration file named `config.toml`. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-save-connection-settings.md [source]
[low] The Atlas CLI grants the user who ran the command read and write access to the configuration file. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-save-connection-settings.md [source]
[low] If you run a command without specifying a profile, environment variables, or `--projectId` and `--orgId` flags, the Atlas CLI uses the default profile. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-save-connection-settings.md [source]
[low] Atlas CLI login sessions last for twelve hours, after which you must login again to access Atlas. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-automate.md [source]
[low] If you run `docker pull mongodb/atlas` without specifying a version tag, Docker automatically pulls the latest version of the Docker image (`mongodb/atlas:latest`). Sources: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli.md [source]
[low] To install the Atlas CLI using Apt, you must install `gnupg` and `curl`. Sources: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli.md [source]
[low] The Atlas CLI response includes available commands and options. Sources: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli.md [source]
[low] The Atlas CLI response returns the current Atlas CLI version. Sources: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli.md [source]
[low] You can configure Atlas CLI authentication for automation by setting the `MONGODB_ATLAS_CLIENT_ID` and `MONGODB_ATLAS_CLIENT_SECRET` environment variables, running `atlas auth login` in the testing environment, or adding the credentials to a named profile and appending `--profile <profileName>` to each command. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-temporary-cluster.md [source]
[low] The command to create an `M10` cluster in the AWS `US_EAST_1` region with the temporary user `myTempUser` incurs hourly charges until the cluster is deleted. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-temporary-cluster.md [source]
[low] Run the `atlas setup` command to create an Atlas cluster and database user in a new project. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-temporary-cluster.md [source]
[low] Run the `atlas projects create` command to create a new project named `myTempProject` in your Atlas organization. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-temporary-cluster.md [source]
[low] Run the `atlas clusters delete` command to delete a temporary cluster and its database users. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-temporary-cluster.md [source]
[low] Run the `atlas projects delete` command to delete a temporary project. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-temporary-cluster.md [source]
[low] Run the `atlas users describe` command to return your Atlas user ID. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-temporary-cluster.md [source]
[low] You can retrieve the organization ID using the `atlas organizations list` Atlas CLI command. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-temporary-cluster.md [source]
[low] You can run the `atlas projects list` command to confirm the successful deletion of a temporary project and cluster. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-temporary-cluster.md [source]
[low] The current stable version of the Atlas CLI is 1.59.2. (verified as of 2026-10-15) Sources: https://formulae.brew.sh/formula/mongodb-atlas-cli [source]
[low] The Atlas CLI includes `mongosh` version 2.13.0 for connecting, configuring, querying, and working with MongoDB databases. (verified as of 2026-10-15) Sources: https://formulae.brew.sh/formula/mongodb-atlas-cli [source]
[low] The Atlas CLI is built with Go version 1.27.2. (verified as of 2026-10-15) Sources: https://formulae.brew.sh/formula/mongodb-atlas-cli [source]
[low] Homebrew analytics for the Atlas CLI formula show 1,412 installs in the last 30 days, 4,613 in the last 90 days, and 46,250 in the last 365 days. (verified as of 2026-10-15) Sources: https://formulae.brew.sh/formula/mongodb-atlas-cli [source]
[low] The Atlas CLI has 0 build errors. (verified as of 2026-10-15) Sources: https://formulae.brew.sh/formula/mongodb-atlas-cli [source]
[low] Before developing Atlas CLI plugins, ensure you have Go 1.21 or later installed. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-extend-plugins.md [source]
[low] The default plugin directory for Atlas CLI depends on your operating system. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-extend-plugins.md [source]
[low] On macOS, the default plugin directory is `~/Library/Application\ Support/atlascli/plugins/atlas-cli-plugin-example`. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-extend-plugins.md [source]
[low] Install an Atlas CLI plugin using the command `atlas plugin install <github-owner>/<repository-name>`. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-extend-plugins.md [source]
[low] If you have access to more than 500 organizations, you must type the organization ID or name to filter results before using arrow keys to select an organization. Sources: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-save-connection-settings.md [source]
[low] Replace or remove any existing MongoDB CLI binaries to prevent conflicts between versions. Sources: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli.md [source]
[low] Remove any existing Atlas CLI binaries to prevent version conflicts. Sources: https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli.md [source]
[low] To diagnose a deployment, run `atlas deployments diagnostics <deploymentName> --output json > out.json`. Sources: https://www.mongodb.com/docs/atlas/cli/current/troubleshooting.md [source]
[low] To stop all Docker containers and prune the system, run `docker stop $(docker ps -a -q) && docker system prune -a`. Sources: https://www.mongodb.com/docs/atlas/cli/current/troubleshooting.md [source]
[low] To remove a Podman container and its volumes, run `podman container rm -f -v <name or ID>`. Sources: https://www.mongodb.com/docs/atlas/cli/current/troubleshooting.md [source]
[low] To uninstall Podman via Homebrew, run `brew uninstall podman`. Sources: https://www.mongodb.com/docs/atlas/cli/current/troubleshooting.md [source]
[low] An example troubleshooting environment includes Atlas CLI version 1.56.0, Go version go1.26.4, and MacOS 15.7.4. (verified as of 2026-10-15) Sources: https://github.com/mongodb/mongodb-atlas-cli/issues/4623 [source]
The stable Atlas CLI version is reported as 1.59.2 in one source and 1.56.0 in a troubleshooting example. Sources: https://formulae.brew.sh/formula/mongodb-atlas-cli, https://github.com/mongodb/mongodb-atlas-cli/issues/4623 [source]

Related concepts

Atlas — is a part of Atlas CLI Operational Runbook
CLI — is a part of Atlas CLI Operational Runbook

Children

No children recorded.

← the whole tree · 3D view· how to read this page