Atlas CLI
The MongoDB Atlas Command Line Interface, or Atlas CLI (mongodb-atlas-cli), allows you to create, manage, and automate operations related to your MongoDB Atlas deployment. This includes tasks like provisioning clusters, creating and deleting users, and controlling network access. You can also access related products like Atlas Search. With the Atlas CLI, you can quickly interact with MongoDB services from the command line for easier testing and scripting.
To report bugs, please use our mongodbcli github issues.
25 results found
-
Change timeZone for Atlas project via CLI or API
It would be great if there will be the possibility to change timezone for a project via cli or API.
e.g.
curl --user "<PUBLIC_API_KEY>:<PRIVATE_API_KEY>" \
--digest \
--request PATCH "https://cloud.mongodb.com/api/atlas/v1.0/groups/<GROUP_ID>" \
--header "Content-Type: application/json" \
--data '{
"timezone": "Europe/Berlin"
}'Thank you
KR
Norbert6 votes -
Update Search Index by Name
It's hard to find a document that clearly states a model to use when creating/updating a Search Index (after digging a little more I found an API documentation that helped me a little but I still had to rely on trial and error).
Update and removal operations should be possible using only the name of the Search Index. This makes it difficult to implement a CI/CD pipeline with Atlas CLI.
1 vote -
Ability to upgrade MongoDB version for local Atlas deployment
Add the ability for the Atlas CLI to upgrade the version of MongoDB running in a local Atlas deployment without having to do a manual migration (or creating a new container).
1 vote -
Include MongoDB Shell (mongosh) and MongoDB Tools (mongoimport, mongoexport, mongodump, mongorestore) in Atlas Local Docker Image
Please add the mongo shell and database tools to the Atlas Local docker image (mongodb/mongodb-atlas-local).
When working with MongoDB and docker, it is a frequent requirement to perform routine maintenance on the database, add seed data, initialise indexes and other tasks.
Today the Atlas Local docker image (mongodb/mongodb-atlas-local) does not include the following useful utility processes:
- MongoDB Shell (mongosh)
MongoDB Tools
- mongoimport
- mongoexport
- mongodump
- mongorestoreWith the result that it is not possible (without using another container or installing local client tools / libraries) to perform such activities as:
- intialise the database with indexes…2 votes -
Add SQL Schema Management to Atlas CLI for Data Federation
Currently, the MongoDB Atlas CLI does not offer commands for managing SQL schemas directly. While the
atlas dataFederationcommand set includes subcommands for managing Data Federation instances, there is no direct support for SQL schema management.It would be highly beneficial if the Atlas CLI included commands for SQL schema management, allowing users to manage their schemas directly through the command line. This would enhance productivity and streamline workflows, particularly for developers who prefer using the CLI for database management.
1 vote -
Ability to set maxClauseCount for cli image
We have a query that needs to filter by a long list of ids.
I get the error: “Query contains too many nested clauses; maxClauseCount is set to 1024”
This error does not happen in M10+ cluster because the lucene maxClauseCount seems to be higher there.
It would be great to be able to set the maxClauseCount of lucene with an env var so we can test this.
3 votes -
Display List of Suggested Indexes to Drop via CLI
Allow users to view the list of suggested indexes to drop via the CLI. Since this functionality is already available in the Atlas UI, it would be beneficial to extend it to the CLI as well. This would align with the existing feature that lists suggested indexes to be created, as documented here (https://www.mongodb.com/docs/atlas/cli/current/command/atlas-performanceAdvisor-suggeste
2 votes -
Add instructions for windows local development.
It took me some research, but I was able to run the mongodb/atlas:latest docker image on a windows machine using Docker Desktop. I had to add this config on WSL nestedVirtualization=true (see https://learn.microsoft.com/en-us/windows/wsl/wsl-config).
Please add this to the documentation to save some troubleshooting time for other windows developers that might want to try this feature locally.
1 voteSupport for local development on Windows via the Atlas CLI is coming soon.
In the meantime, if what you are going for is a Docker-first experience, you can follow the steps described at https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-docker/. The image document there will work with Docker Desktop on windows.
-
skip past MongoDB CLI version 1.31.1 for dependabot / renovate (current version 1.18.0)
Currently the latest release for the cli is 1.18 i.e. mongodb/atlas:v1.18.0, but according to common versioning patterns mongodb/atlas:v1.31.0
should have been created after the current version, so vulnerability management systems like renovate will falsely believe this to be the latest version.Could you release versions higher than 1.31.1 from now on?
1 vote -
Official Docker Image for Atlas Search
It Could be very useful test Atlas search locally using a dedicated Docker Image, so it is portable to a Kubernetes cluster
9 votesWe now have a docker image that includes the MongoDB server and Atlas Search and Vector Search: https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-docker/. This image is designed (and licensed for) development and testing locally and in CI/CD. It is not intended for production use.
The image is currently in public preview and we expect to GA it later in the year (2024).
-
Token retrival as a API / CLI / endpoint call
When we try to authenticate using Atlas CLI or Administration API, We require to go to shell and need to give approval / confirmation / consent. Would be a great feature to get token as a response of API call / CLI request which will allow seamless integration between the client app and MongoDB Atlas. More use cases will be opened for SaaS, PaaS applications.
1 vote -
atlas clusters sampleData reload
Hi Jakob/Guss/Colm,
Any chance of adding a new command to sampleData - specifically:
atlas clusters sampleData reload <cluster>The command would literally check if the cluster has the sampleData loaded but it would also check the counts and the hashes so that if there wasn't an exact match so the data in some or all of the collections had been changed, then the existing sample data would be dropped and reloaded?
Thanks!
Eoin1 vote -
atlas clusters sampleData loaded command
Hi Jakob/Guss/Colm,
Any chance of adding a new command to sampleData - specifically:
atlas clusters sampleData loaded <cluster>The command would literally check if the cluster has the sampleData present?
I'd find that helpful in some of the lab scripts I'm writing as I'd avoid an unnecessary call to load the sampleData if it was already present. It throws a nasty looking red warning for learners when I do it by default to ensure the data is there.Thanks!
Eoin1 vote -
Add Multi-Factor Authentication settings to be managed via Atlas CLI
At the moment, there is currently no method to manage or view Multi-Factor Authentication settings via the Atlas CLI.
The alerts set in this moment to control MFA seem to be quite poor and it is not possible to get specific information about users.1 vote -
alerts list should allow filtering by date and sort inversely by date
The 'alert list' list all alerts since the beginning of time. We can list open alerts, but we can't practically list alerts that were generated recently without going through all alerts ever produced for a project. I'd like to see what alerts were produced and are open or produce recently but closed.
Additionally, what is a "tracking" alert?
1 vote -
Option To Return Errors As JSON
Hi,
When using the
--output jsonI would expect the errors to be returned as JSON just like the success output. However, the output for errors seems to continue to be a flat string.It would be helpful from a scripting perspective to have the output as JSON when requested so we can include better logic in our scripts when errors occur. For example:
{ "code": "409", "message": "The cluster name already exists" }Please let me know if you need more information about the request.
Thanks,
2 votesHi Nic,
Thank you for taking the time to raise this request. We'll look into it and update this feedback when we decide to roadmap it for the near future.
Thank you,
Jakub
-
add option to return output as a text instead of array
when you call cli with -o json-path option you always recieve output as an array in brackets. it would be useful to add a key to return output as plain text, so it can used in scripts without further processing (the same way as aws cli does) :
current state :
export org_id=$(atlas organizations list -o json-path='$.results[?(@.name =="MyOrg")].id' )
echo $org_id
[5ccefa1079358eebfef9456e]
suggested output
echo $org_id 5ccefa1079358eebfef9456e2 votes -
Allow for specifying config file path.
Currently, the config for Atlas CLI lives in a specific directory defined by the tool: https://www.mongodb.com/docs/atlas/cli/stable/atlas-cli-save-connection-settings/#std-label-config-toml-location
While the config can be both set by CLI and edited with
atlas config editcommand, both of those options are specific to the tool. As someone who uses multiple CLI tools, I prefer to have all my configs organized the way it works for me and not have to remember idiosyncratic configuration for one of the tools I'm using.1 voteThank you for filing another idea! We appreciate your feedback and contribution.
We’ll investigate internally what would it take to deliver the right experience to users to allow setting the path to the configuration file.
In meantime, could you please share what would be the best way to configure the path to config file within the Atlas CLI from your perspective?
Keep the ideas coming!
Jakub
-
Ability to download/point to latest tool versions
This is especially important for a headless environment. And can be applied to more than just the Atlas CLI and the MongoDb Shell
This documentation tells you to manually construct the string: https://www.mongodb.com/docs/database-tools/installation/installation-linux/#installation
It would be ideal to programmatically access the latest version, instead of having to manually build a download string and use that to access a static version.
Other languages and tools have solved this problem. Could MongoDb do this, too?
It looks like someone tried to do this for Windows: https://community.chocolatey.org/packages/mongodb-shell#versionhistory
But that doesn't look like an officially supported solution, It would be amazing if this existed,…
1 voteThank you for taking the time to file this request. Your feedback helps us make the Atlas CLI a better place for you and other users. At the same time I’d like to apologise for the late reply.
Programmatic usage of the Atlas CLI is an area we plan to improve and further simplify. We can see how having an ability to download always the latest version of the Atlas CLI can simplify some of the automated actions.
As a next step we’ll look into some more details how this could be achieved.
We’ll update this idea as soon as we have more details.
In the meantime, could you share more details on what do you use this automation for?
Keep the ideas coming!
Jakub
-
list all Atlas Search indexes for a cluster
The list Atlas Search indexes command,
https://www.mongodb.com/docs/atlas/cli/stable/command/atlas-clusters-search-indexes-list/ought to not require the collections and db parameters. It should list indexes for all for the cluster and for a database.
2 votes
- Don't see your idea?