Atlas CLI Changelog

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 --decompress option to decompress logs when you run the atlas logs download command.

• Adds the type column to the output for the following commands:

  • atlas clusters search indexes list

  • atlas clusters search indexes describe

  • atlas deployments search indexes list

  • atlas deployments search indexes describe

• Adds the --expireAfterDays option 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 --start and --end flags.

• 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 deb and rpm meta 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 --namespaces option.

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 instances 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 --orgId flag.

• 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 --apiKey option 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 quickstart command 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

• 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:

  • atlas dataFederation

  • atlas dataFederation privateEndpoints

  • atlas dataFederation queryLimits

• Adds the --tag flag to the atlas setup and atlas quickstart commands.

• Updates a namespace to be optional for performance advisor operations.

• Fixes the atlas clusters update and atlas serverless update commands ignoring the --tag flag.

• Deprecates atlas datalake and atlas privateEndpoints commands in favor of atlas datafederation.

Atlas CLI 1.8.0

Released 18 June 2023

• Adds the LagTime and ReadyForCutOver fields to the atlas liveMigrations create. and atlas liveMigrations describe command output.

• Adds the --tag flag to the atlas serverless create and atlas serverless update commands.

• Adds the --watch flag to the atlas clusters create and atlas clusters delete commands.

Atlas CLI 1.7.4

Released 15 June 2023

• Adds the --compact flag to compact the output of specific list commands. This ensures backwards compatibility with Atlas CLI releases prior to 1.7.0.

  Use this flag with the --output json or --output json-format flags to return an array that contains list items as output for the following commands:

  • atlas teams list

  • atlas dbusers certs list

  • atlas dbusers list

  • atlas projects apiKeys list

  • atlas organizations apiKeys list

  • atlas projects users list

  • atlas processes list

  • atlas alerts settings list

• 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 oneOf schema 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 json response structure.

  Use the nested .results object to access the previous response structure. Use the following jq template 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 --tag flag to the commands atlas clusters create, atlas clusters update, and atlas clusters upgrade. The --tag flag lets you create and use tags to categorize your clusters.

Atlas CLI 1.7.1

Released 31 May 2023

• Updates help text for update commands 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 --type filter.

Atlas CLI 1.7.0

Released 25 May 2023

• Introduces a breaking change to the following commands that modifies their --output json response structures:

  • atlas teams list

  • atlas dbusers certs list

  • atlas dbusers list

  • atlas projects apiKeys list

  • atlas organizations apiKeys list

  • atlas projects users list

  • atlas processes list

  Use the nested .results object to access the previous response structure. Use the following jq template 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 create

  • atlas dataLakePipelines datasets delete

  • atlas dataLakePipelines delete

  • atlas dataLakePipelines describe

  • atlas dataLakePipelines list

  • atlas dataLakePipelines pause

  • atlas dataLakePipelines runs describe

  • atlas dataLakePipelines runs list

  • atlas dataLakePipelines runs watch

  • atlas dataLakePipelines start

  • atlas dataLakePipelines trigger

  • atlas dataLakePipelines update

  • atlas dataLakePipelines watch

• Adds the following new commands to load and manage sample data:

  • atlas clusters sampleData load, which replaces atlas clusters loadSampleData

  • atlas clusters sampleData describe

  • atlas clusters sampleData watch

• 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 M0 clusters.

Atlas CLI 1.6.0

Released 30 March 2023

• Adds the following new commands:

  • atlas serverless backups snapshots watch

  • atlas serverless backups snapshots list

  • atlas serverless backups restores watch

  • atlas serverless backups restores create

  • atlas serverless backups restores describe

  • atlas serverless backups restores list

  • atlas serverless update

  • atlas backups exports jobs watch

  • atlas organizations create

• Adds the following to commands:

  • file option for atlas backups schedule update command.

  • srvShardOptimizedConnectionString field to privateEndpoints in 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 AtlasDatabaseUser resources 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_RELIC command.

• Adds support for cluster termination protection.

  • To enable cluster termination protection, run atlas clusters create or atlas clusters update with the --enableTerminationProtection option.

  • To disable cluster termination protection, run atlas clusters update with the --disableTerminationProtection option.

• 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 projectId instead of the orgId.

• 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 clusters commands:

  • 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, yum and dnf.

• 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

  • yum and apt using 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 .exe binaries for Windows.

• Adds digital signatures for .msi packages.

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 projects commands:

  • atlas projects settings update updates settings of a given project.

  • atlas projects settings describe lists project settings.

• Adds new atlas clusters commands:

  • atlas clusters advancedSettings describe gets advanced settings for a cluster.

  • atlas clusters upgrade upgrades a shared cluster to a dedicated one.

• Adds new atlas backups commands:

  • 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 mongosh when 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 (apt and yum).

• Automatically detects mongosh when you use the atlas quickstart command.

Atlas CLI 1.1.3

Released 13 June 2022

• Improves the atlas quickstart command:

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

Atlas CLI 1.1.1

Released 02 June 2022

Atlas CLI 1.1.0

Released 20 May 2022

Atlas CLI 1.0.3

Released 28 April 2022

Atlas CLI 1.0.2

Released 31 March 2022

Atlas CLI 1.0.1

Released 16 March 2022

Atlas CLI 1.0.0

Released 15 March 2022

This is the Generally Available (GA) release of MongoDB Atlas CLI.