- This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of the Atlas CLI.
Atlas CLI 1.40.0
Released 27 Feb 2025
Adds a warning when unused fields are provided when using the
--fileflag.Improves the
--fileflag description to inform users that unsupported fields in JSON files are ignored.Fixes a bug where plugins might override command aliases.
Atlas CLI 1.39.0
Released 18 Feb 2025
Fixes a bug with atlas backups restores start that prevented downloading restores for advanced clusters.
Fixes a bug with atlas backups restores watch that prevented downloading restores for dedicated clusters.
Adds the
--watchflag to multiple auto-generated commands.Releases the Atlas CLI Kubernetes plugin. Any Kubernetes commands now use the automatically installed plugin.
Atlas CLI 1.38.0
Released 07 February 2025
Improves documentation about Flex Clusters for atlas clusters create and atlas clusters update.
Adds an experimental feature: atlas api. This experimental feature streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI.
Atlas CLI 1.37.0
Released 30 January 2025
Local development now supports providing a custom image to use.
Fixes a bug where local development took to long to start.
Atlas CLI 1.36.0
Released 23 January 2025
Fixes a bug when restoring backups for clusters.
Improves help text clarity when deleting a search node.
Fixes
--helptexts to contain short and long descriptions. Previously, only a long description was shown.Atlas CLI plugins now also support installing pre-release versions of plugins, for example,
my-repo/myplugin@v1.0.0-prerelease.
Atlas CLI 1.35.0
Released 09 January 2025
Supports Flex Clusters in the following commands:
Adds atlas backups snapshots download command to download Flex Cluster snapshots.
Deprecates the following:
atlas-serverlesscommandsM1andM5tiers
Tip
Redirect stderr in your scripts to redirect command warnings and deprecation messages to a file.
Fixes the following:
Issue that caused atlas privateEndpoints aws interfaces describe command to return
400.Issue that caused atlas setup command to fail if
--mdbVersionflag was missingIssue that caused the
--watchflag to return token expired error for long running operation.
Atlas CLI 1.34.0
Released 18 December 2024
Adds the
--desc flagto the commands atlas dbusers create and atlas dbusers update.Fixes a bug where
atlas deployments connectwould fail in Windows when connecting using MongoDB Compass.Atlas CLI plugins now support
.zipand.gzipas archive types (before it was only.gzip).Fixes a bug where the
--mongoDbVersionwould be ignored for theatlas deployments setupcommand with the type:atlas.Supports building the AtlasCustomRole and AtlasPrivateEndpoint CRDs with the atlas kubernetes config apply and atlas kubernetes config generate commands.
Atlas CLI 1.33.0
Released 4 December 2024
Adds the
--mdbVersionand--connectWithflags in the atlas setup command.Deprecates the
--skipMongoshflag in the atlas setup command.Updates the atlas deployments setup interactive mode to use the same questions and default values used by the atlas setup command for the
default(deploy with default settings),custom(deploy with custom settings), orcancel(cancel setup) options.
Atlas CLI 1.32.0
Released 22 November 2024
Adds support for SUSE 15.
Accepts new format of Atlas Search index definition on commands.
Fixes a bug that caused the atlas deployments search indexes create command
--watchoption to watch the wrong index.
Atlas CLI 1.31.0
Released 07 November 2024
Disables the local dev telemetry when you disable the Atlas CLI telemetry.
Adds the local dev image UUID data to telemetry.
Fixes a bug where Atlas deployments didn't show up in some atlas deployments commands.
Updates the progress message for the atlas deployments setup command.
Improves the UX for the atlas deployments logs command.
Removes the
--watchTimeoutflag from the atlas deployments search indexes create command.Prompts to start a paused or stopped deployment for the atlas deployments connect command.
Updates the atlas deployments setup command output to quote the connection string.
Atlas CLI 1.30.0
Released 17 October 2024
Fixes a discrepancy in atlas deployments search indexes list and atlas clusters search indexes list where the deployment command returns an error if the cluster is in the
UPDATINGstate.Refreshes the bearer token when cluster watch is taking a long time.
Fixes an exception when you run atlas dataFederation logs.
Atlas CLI 1.29.0
Released 26 September 2024
Fixes an issue that prevented the use of some global flags in plugin commands, including
--debug.Updates the atlas deployments commands:
Show only the containers that you can start when you run atlas deployments start.
Show only the containers that you can stop when you run atlas deployments pause.
Show only the containers that you can connect when you run atlas deployments search indexes commands.
Atlas CLI 1.28.0
Released 19 September 2024
Adds the
--fileflag to the atlas organizations invitations invite and atlas organizations invitations update commands.Adds support for MongoDB 8.0 for local deployments when you run atlas deployments setup.
Deprecates the
atlas-projects-invitationscommands. Use the atlas organizations invitations commands for invitations.
Atlas CLI 1.27.1
Released 13 September 2024
Updates the atlas deployments commands:
atlas deployments no longer displays an unnecessary warning when you specify
--type atlasor you don't specify--type.atlas deployments shows a warning if you use an unsupported version of Docker or Podman.
atlas deployments setup links to the docs from the description.
atlas deployments setup now shows
autoassigninstead of0when you don't select a port during local deployment.
Atlas CLI 1.27.0
Released 29 August 2024
Updates the atlas kubernetes config generate command to include the
spec.deploymentSpec.mongoDBMajorVersionfield in the generatedAtlasDeploymentcustom resource definition.Adds a warning when running the atlas deployments start or atlas deployments setup commands on a machine that doesn't meet the minimum system requirements.
Improves how the atlas deployments setup command assigns random ports.
Suppresses Atlas CLI error messages about refreshing access tokens when working with local deployments.
Fixes incorrect help options for the atlas deployments connect command.
Atlas CLI 1.26.0
Released 25 July 2024
Fixes a local deployment error message when you don't have Docker installed on MacOS and Windows.
Fixes an issue when connecting to a local deployment using
mongoshand Compass on Windows.Updates the atlas deployments setup command to always use the latest image when creating a new local deployment.
Drops support for MongoDB 6.0 for local deployments.
Drops support for local deployments created with earlier versions of the Atlas CLI.
Fixes a bug in the atlas deployments setup command where the Atlas CLI deletes an existing local deployment when you run this command twice for the same deployment.
Atlas CLI 1.25.0
Released 11 July 2024
Adds support for local deployments only using Docker.
Fixes a bug where the atlas backups schedule update command didn't accept frequency type of
yearlyfor the--policyflag.Deprecates support for Debian 10, RHEL 7.0 and Amazon2.
Deprecates support for Podman.
Atlas CLI 1.24.0
Released 20 June 2024
Adds the
federationSettingsIDflag to the atlas organizations create command.Fixes a bug that caused a different experience between the
atlas whoamiandatlas auth whoamicommands.Adds support for the atlas auditing update command.
Atlas CLI 1.23.0
Released 23 May 2024
Adds support for Amazon Linux 2023. To learn more, see Install or Update the Atlas CLI.
Updates atlas deployments list to list Atlas clusters in case of local failures.
Adds support for
srvShardOptimizedConnectionStringto the atlas clusters connectionStrings describe command.Stops publishing new versions on the
server-4.4 Linux yum/aptrepositories.
Atlas CLI 1.22.0
Released 3 May 2024
Fixes a bug in the atlas dbusers create command when creating an OIDC user.
Adds the following commands to configure connected organizations for federated authentication:
atlas federatedAuthentication federationSettings connectedOrgConfigs list
atlas federatedAuthentication federationSettings connectedOrgConfigs update
atlas federatedAuthentication federationSettings connectedOrgConfigs delete
atlas federatedAuthentication federationSettings connectedOrgConfigs describe
Atlas CLI 1.21.0
Released 26 April 2024
Adds commands that support OIDC federated authentication, including:
Adds the
oidcTypeflag for the atlas dbusers create command.Adds the
--tierflag for the atlas streams instances create command.
Atlas CLI 1.20.0
Released 11 April 2024
Adds the atlas projects update command.
Fixes an issue with the atlas kubernetes config generate command.
Atlas CLI 1.19.0
Released 3 April 2024
Adds support for Podman 5.0.0 for local deployments.
Fixes an issue with the
--watchflag for the atlas deployments search indexes create command.
Atlas CLI 1.18.0
Released 27 March 2024
Fixes a bug in the atlas events projects list, atlas projects list and atlas events organizations list commands where an invalid
minDateandmaxDatesilently failed and didn't apply to the command.Fixes an issue where the Atlas CLI didn't sign Windows binaries.
Fixes an issue where the Atlas CLI didn't apply the correct default MongoDB version for cluster creation.
Fixes a bug where the atlas customDbRoles create command fails if you provide more than one privilege with the same action.
Fixes an issue where exporting a cluster from Atlas to Atlas Kubernetes Operator YAML didn't exclude read only fields for shared tenant deployments.
Atlas CLI 1.17.0
Released 14 March 2024
Fixes an issue where atlas customDbRoles commands didn't handle collection names with dots (
.) properly.Adds the
--omitCountflag to all the list commands that support pagination.Adds the
--fileflag to the atlas clusters indexes create command.
Atlas CLI 1.16.0
Released 07 March 2024
Adds the
--omitCountflag to the atlas events projects list and atlas events organizations list commands.Improves the Microsoft Windows binary build process.
Atlas CLI 1.15.1
Released 29 February 2024
Fixes an issue where the atlas auth login command fails to prompt for the default organization.
Atlas CLI 1.15.0
Released 22 February 2024
Adds support for Atlas Search nodes management, including the following commands:
Adds the
--tagflag to the atlas projects create command.Fixes a bug that prevented you from using the
--fileflag with the atlas clusters update command.
Atlas CLI 1.14.3
Released 8 February 2024
Adds support for Atlas Vector Search for Local Deployments.
Adds support to rename teams.
Signs the Linux binaries with PGP.
Signs the Windows binaries with garasign.
Signs the Docker image with Cosign.
Atlas CLI 1.14.2
Released 30 January 2024
Improves the validation of invalid profile names.
Atlas CLI 1.14.1
Released 18 January 2024
Fixes an issue that prevented upgrading from a lower to a higher shared tier.
Fixes the template for
privateEndpointcommands.
Atlas CLI 1.14.0
Released 6 December 2023
Adds atlas backups compliancePolicy commands so that you can set up and manage a cloud backup compliance policy for your project. To learn more, see Configure a Backup Compliance Policy.
Drops support for Atlas Kubernetes Operator 1.x.
Atlas CLI 1.13.0
Released 17 November 2023
Adds the atlas alerts settings describe command, which describes alert configurations.
Adds support for Debian 12, Debian 10 ARM, and Debian 11 ARM.
Adds the
--decompressoption to decompress logs when you run the atlas logs download command.Adds the
typecolumn to the output for the following commands:Adds the
--expireAfterDaysoption for the atlas clusters onlineArchives create and atlas clusters onlineArchives update commands.Improves the error message for the atlas deployments list command if you aren't authenticated.
Fixes a bug that prevented organization fetching, which prevented some users from logging in.
Fixes a bug where atlas logs download didn't respect the
--startand--endflags.Fixes a local deployment bug when you create an index from a file.
Fixes a bug in the atlas config init command where the output property didn't save properly.
Atlas CLI 1.12.2
Released 20 October 2023
Adds an unsupported distro warning if you try to run local deployment commands on an unsupported operating system.
Adds Podman as a recommended dependency for the
debandrpmmeta packages.Adds listing of atlas and local atlas deployments to the deployment interactive flow.
Adds a spinner for the atlas deployments start and atlas deployments pause commands.
Adds more context to error messages for local deployments.
Adds the atlas deployments logs command, which returns logs for your local and cloud deployments.
Fixes a bug that occurred when you provided only the private API key or only the public API key.
Fixes a bug in the atlas clusters onlineArchives create command where validation prevented you from using three fields in your partition.
Fixes an issue where the atlas performanceAdvisor suggestedIndexes list command didn't accept the
--namespacesoption.
Atlas CLI 1.12.1
Released 26 September 2023
Updates the Atlas Search Docker image for local deployments.
Atlas CLI 1.12.0
Released 22 September 2023
Adds atlas deployments commands so that you can work with Atlas, including using Atlas Search and Atlas Vector Search, throughout the entire software development lifecycle from your local environment to the cloud. To learn more, see Manage Local and Cloud Deployments from the Atlas CLI.
Adds atlas streams commands to manage Atlas Stream Processing workspaces and connection registries.
Drops support for Ubuntu 18.04.
Atlas CLI 1.11.0
Released 14 September 2023
Fixes an issue that occurred when you created x509 certs for database users. The command didn't output the certificate. If you depend on the previously incorrect output, this update is a breaking change.
atlas alerts settings create and update commands perform validation that helps you formulate all required arguments for each alert type.
Fixes a bug where the atlas projects list command ignored the
--orgIdflag.Fixes an issue that occurred while running cloud provider access commands.
Supports configuring alerts with a file. To learn more, see .
Atlas CLI 1.10.0
Released 26 July 2023
Fixes issue with the atlas performanceAdvisor suggestedIndexes list command that caused a JSON unmarshal error.
Amends the description for the
--apiKeyoption for the atlas organizations apiKeys accessLists create command to make it clearer that the option uses the API key ID, not the public API key.
Atlas CLI 1.9.2
Released 20 July 2023
Fixes issue with the printed table format for the atlas networking containers list command.
Removes support for MongoDB 4.2.
Configures
atlas quickstartcommand as an alias for the atlas setup command.Fixes the atlas backups restores watch command output format.
Fixes the atlas backups restores watch command to work correctly.
Atlas CLI 1.9.1
Released 5 July 2023
Important
This is the last Atlas CLI release to be available on the MongoDB server 4.2 Linux repositories for Debian, Ubuntu and RHEL.
Adds the ability to set up Microsoft Teams alert notifications with the atlas alerts settings create command.
Fixes the following issues:
An error when trying to create project API keys.
Users were unable to remove cluster tags.
Atlas CLI 1.9.0
Released 29 June 2023
Adds the ability to autocomplete the process name in the performance advisor with the atlas performanceAdvisor command.
Adds the following new commands to manage data federation:
Adds the
--tagflag to the atlas setup andatlas quickstartcommands.Updates a namespace to be optional for performance advisor operations.
Fixes the atlas clusters update and
atlas-serverless-updatecommands ignoring the--tagflag.Deprecates
atlas datalakeandatlas privateEndpointscommands in favor ofatlas datafederation.
Atlas CLI 1.8.0
Released 18 June 2023
Adds the
LagTimeandReadyForCutOverfields to the atlas liveMigrations create. and atlas liveMigrations describe command output.Adds the
--tagflag to theatlas-serverless-createandatlas-serverless-updatecommands.Adds the
--watchflag to the atlas clusters create and atlas clusters delete commands.
Atlas CLI 1.7.4
Released 15 June 2023
Adds the
--compactflag to compact the output of specificlistcommands. This ensures backwards compatibility with Atlas CLI releases prior to 1.7.0.Use this flag with the
--output jsonor--output json-formatflags to return an array that contains list items as output for the following commands:Introduces custom handling for valid ISO-8601 timestamps.
Atlas CLI 1.7.3
Released 9 June 2023
Fixes an issue that caused the atlas clusters search indexes list command to incorrectly handle
oneOfschema matching for analyzers.
Atlas CLI 1.7.2
Released 7 June 2023
Introduces a breaking change to the atlas alerts settings list command that modifies its
--output jsonresponse structure.Use the nested
.resultsobject to access the previous response structure. Use the followingjqtemplate to migrate affected scripts:jq '.' ...`` => ``jq '.results' ... Fixes an issue that caused the atlas clusters search indexes create command to incorrectly handle a multikey index.
Fixes an issue with the atlas performanceAdvisor slowQueryLogs command where the output didn't display correctly in tabular form.
Adds the
--tagflag to the commands atlas clusters create, atlas clusters update, and atlas clusters upgrade. The--tagflag lets you create and use tags to categorize your clusters.
Atlas CLI 1.7.1
Released 31 May 2023
Updates help text for
updatecommands that include arrays to clarify that certain flags replace data instead of append data.Fixes a bug in the atlas metrics processes command that caused an error when using the
--typefilter.
Atlas CLI 1.7.0
Released 25 May 2023
Introduces a breaking change to the following commands that modifies their
--output jsonresponse structures:Use the nested
.resultsobject to access the previous response structure. Use the followingjqtemplate to migrate affected scripts:jq '.' ...`` => ``jq '.results' ... Adds the atlas kubernetes operator install command to install the Atlas Kubernetes Operator.
Adds the following new commands to manage Atlas Data Lake pipelines:
atlas dataLakePipelines createatlas dataLakePipelines datasets deleteatlas dataLakePipelines deleteatlas dataLakePipelines describeatlas dataLakePipelines listatlas dataLakePipelines pauseatlas dataLakePipelines runs describeatlas dataLakePipelines runs listatlas dataLakePipelines runs watchatlas dataLakePipelines startatlas dataLakePipelines triggeratlas dataLakePipelines updateatlas dataLakePipelines watch
Adds the following new commands to load and manage sample data:
atlas clusters sampleData load, which replaces
atlas clusters loadSampleData
Fixes a bug where running atlas dbusers update indicated success prematurely, which made it possible for the command to show success when the API call later failed.
Improves the error message for commands that are unavailable for
M0clusters.
Atlas CLI 1.6.0
Released 30 March 2023
Adds the following new commands:
atlas-serverless-backups-snapshots-watchatlas-serverless-backups-snapshots-listatlas-serverless-backups-restores-watchatlas-serverless-backups-restores-createatlas-serverless-backups-restores-describeatlas-serverless-backups-restores-listatlas-serverless-update
Adds the following to commands:
fileoption for atlas backups schedule update command.srvShardOptimizedConnectionStringfield toprivateEndpointsin atlas clusters connectionStrings describe command output.Option to auto-detect the requester's current IP for the atlas organizations apiKeys accessLists create command.
Adds the ability to create organizations.
Automatically completes the following:
Available regions or tiers during cluster creation or update.
Available profiles.
Improves the following:
Autocomplete for output options.
Release process for Chocolatey.
Fixes the following issues:
Couldn't properly set days for weekly backup when updating a backup schedule.
JSON path would not render as a valid JSON.
Atlas CLI 1.5.1
Released 16 February 2023
Fixes a bug in the atlas kubernetes config generate command that could produce
AtlasDatabaseUserresources with the same resource name for different users.Improves help text and documentation for multiple commands.
Atlas CLI 1.5.0
Released 9 February 2023
Updates the atlas config describe command to no longer redact public API keys.
Updates the default output format for the atlas customDbRoles list command to include inherited roles.
Deprecates the
atlas-integrations-create-NEW_RELICcommand.Adds support for cluster termination protection.
To enable cluster termination protection, run atlas clusters create or atlas clusters update with the
--enableTerminationProtectionoption.To disable cluster termination protection, run atlas clusters update with the
--disableTerminationProtectionoption.
Improves help text and documentation for multiple commands.
Atlas CLI 1.4.0
Released 5 December 2022
Fixes the atlas liveMigrations cutover command to pass the
projectIdinstead of theorgId.Adds options to the atlas kubernetes config generate command for the following:
Exporting Atlas teams.
Exporting private endpoints for serverless instances.
Exporting resources from Atlas and converting them to the AtlasOperator resources.
Atlas CLI 1.3.0
Released 17 November 2022
Adds new
atlas clusterscommands:atlas clusters advancedSettings update updates advanced settings for your cluster.
atlas clusters availableRegions list lists all available regions where you can create clusters.
Enhances telemetry by detecting whether your operating system is Debian, RPM, MSI, or Chocolatey.
Atlas CLI 1.2.1
Released 14 October 2022
Fixes internal release tooling.
Makes ARM binaries available for installation with
apt,yumanddnf.Adds support for Debian 11.
Atlas CLI v1.2.0
Released 14 October 2022
Fixes a bug with the atlas customDbRoles list command that prevented printing the command's results.
Fixes an issue with the atlas privateEndpoints azure interfaces describe command where the output didn't display correctly.
Adds the atlas processes describe command, which returns the details for MongoDB process you specify.
Drops support for Debian 9.
Fixes a bug where inviting users issued an error.
Improves help text for the atlas backups snapshots create command.
Fixes a bug where login information wasn't stored at early exit while asking about project ID and org ID.
Adds the atlas config edit command to open the config file in your preferred editor.
Adds a atlas backups restores watch command, which watches for a restore job to complete.
Adds the atlas alerts settings enable and atlas alerts settings disable commands, which enable or disable the alert configuration you specify.
Atlas CLI 1.1.7
Released 18 August 2022
Adds support for the following platforms:
RHEL 9
Ubuntu 22.04
yumandaptusing MongoDB version 6.0
To learn more, see Install or Update the Atlas CLI.
Atlas CLI 1.1.6
Released 18 August 2022
Adds digital signatures for
.exebinaries for Windows.Adds digital signatures for
.msipackages.
Atlas CLI 1.1.5
Released 2 August 2022
Fixes a bug where telemetry tracking events were not propagated when a default profile was not set.
Fixes a bug where it was not possible to filter organizations or projects by name during onboarding.
Fixes a bug where some options were not validated on command atlas backups restores job start.
Improves documentation and adds examples to atlas privateEndpoints aws describe.
Improves onboarding for users with more than 500 organizations.
Improves the message when an operation completes in a free cluster. The message now directs users to an upgrade command.
Updates the help message for roles in the atlas dbusers create command.
Adds "Upgrade One Shared Tier Cluster" endpoint to Atlas Go Client.
Adds new
atlas projectscommands:atlas projects settings update updates settings of a given project.
atlas projects settings describe lists project settings.
Adds new
atlas clusterscommands:atlas clusters advancedSettings describe gets advanced settings for a cluster.
atlas clusters upgrade upgrades a shared cluster to a dedicated one.
Adds new
atlas backupscommands:atlas backups exports buckets list lists available backup export buckets.
atlas backups exports buckets describe displays information about a backup export bucket.
atlas backups exports buckets create creates an export destination for Atlas backups using an existing bucket.
atlas backups exports buckets delete deletes a given backup export bucket.
atlas backups exports jobs list lists all export jobs for a project and cluster.
atlas backups exports jobs describe displays information about a given export job.
atlas backups exports jobs create creates a new export job in a given bucket.
atlas backups restores describe displays information about a given backup restore job.
atlas backups schedule describe displays the backup schedule of a cluster.
atlas backups schedule update updates the backup schedule of a cluster.
atlas backups schedule delete deletes all backup schedules for a cluster.
Atlas CLI 1.1.4
Released 16 June 2022
Sets the telemetry settings for
mongoshwhen you change telemetry for the Atlas CLI.Introduces the ability to install mongosh together with the Atlas CLI using a new meta-package for Linux package managers (
aptandyum).Automatically detects
mongoshwhen you use theatlas quickstartcommand.
Atlas CLI 1.1.3
Released 13 June 2022
Improves the
atlas quickstartcommand:Prompts you to log in if you aren't already logged in.
Clarifies an error message when no regions are found for a given cloud provider.
Improves telemetry:
Tracks when you interrupt a running Atlas CLI command by using
CTRL+C.Tracks some previously untracked errors.
Enhances interactive input tracking.
Atlas CLI 1.1.2
Released 06 June 2022
Fixes login and setup display issues for Microsoft Windows users.