Skip to content

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.


You can install the Atlas CLI via, Homebrew, Apt, Yum, or a binary download. Help us improve the MongoDB Atlas CLI by posting your ideas and suggestions for improvements.

To report bugs, please use our mongodbcli github issues.


15 results found

  1. Add `atlas backups restores watch` command

    I like the ability to monitor snapshot progress with atlas snapshot watch. It lets me wait for the snapshot to finish up before progressing on to some future step of an automated workflow.

    Could we add the same watch command to atlas backup restore? The API I'm envisioning is just this:

    atlas backups restores watch <restoreId> [options]
    

    Where [options] are all the usual suspects like --projectId --profile and so forth. Like the snapshots watch command, this will help me wait for a database to finish restoring some snapshot before going and doing some other step of an automated workflow.

    5 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    6 comments  ·  Atlas CLI  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  2. Allow all IPs for local atlas deployments

    Hello,

    we want to create a docker container which runs the atlas-cli with --type local, the base is the official mongodb/atlas docker image. We need this so we can work with atlas-search. The access list which can be provided during deployment setup, is not passed down to the mongod config and we get blocked. A reverse proxy doesn't help in this case. If we enter the final podman image and modify the config, we can't restart the server without crashing the container and which breaks again.
    We would really appreciate it if we could somehow get bind IPs activated.

    Thank…

    3 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    completed  ·  3 comments  ·  Atlas CLI  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  3. Add a command to open the CLI config on my system editor

    A new command like mongocli config edit that opens the config file on my system editor

    3 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    completed  ·  1 comment  ·  Atlas CLI  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  4. Add commands to stop/start/restart a mongodb process in a cluster

    Currently, we see that mongocli supports stop/start the "entire" cluster which is not suitable for general maintenance scenario which requires cluster availability.

    Commands to stop/start/restart a mongodb process in a cluster will be useful for the scenario of the server maintenance that requires MongoDB Administrator to stop a single node prior to the maintenance time and start it afterward.

    3 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  5. Allow to perform rolling compact via restapi

    Allow to perform rolling compact via CM/OM restAPI (processes.lastCompact parameter)

    3 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  6. Please help with official github action to setup Atlas CLI

    Please help with official github action from Atlas in Github Action Marketplace to setup Atlas CLI, same as https://github.com/andreaangiolillo/atlas-cli-github-action

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  Atlas CLI  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  7. option for activate/deactivate monitoring/backup agents

    Currently, there is no command for simple activation and deactivation of monitoring/backup agents.

    2 votes

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  8. Using atlas cli local deployment feature in a docker-compose based automatic testing environment

    Is it possible to use this in a CI based on docker compose for automated testing?

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  9. JSON

    An export function to export the configuration of an existing Cluster to a JSON config file, of the kind used by Atlas CLI to create clusters.

    I can imagine this as a flag for a detailed output of "atlas cluster describe "

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  Atlas CLI  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Thanks for raising this suggestion.

    As per the comment earlier, this is already available with "--output json"  flag. If you'd like to export it to a file, feel free to add "> filename.json" at the end of command.


    I hope this helps.

    Thanks,

    Jakub

  10. Please help with official docker image which is preinstalled with Atlas CLI

    Please help with official docker image which is preinstalled with Atlas CLI, same as

    mcr.microsoft.com/azure-cli which gives us the built image with azure cli
    amazon/aws-cli - Docker Image | Docker Hub

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  Atlas CLI  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  11. Add `edit` to `atlas config` help listing.

    When listing help for atlas config the edit option is not currently visible:
    ```
    ~ 🍤 atlas config --help 23:14:37 UTC
    Configure settings in a user profile.
    All settings are optional. You can specify settings individually by running:
    $ atlas config set --help

    You can also use environment variables (MONGODBATLAS*) when running the tool.
    To find out more, see the documentation: https://dochub.mongodb.org/core/atlas-cli-env-variables.

    Usage:
    atlas config [command]

    Available Commands:
    init Configure a profile to store access settings for your MongoDB deployment.
    set Configure specific properties of a profile.
    list Return a list of available profiles by name.
    describe…

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  Atlas CLI  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Hi Alicja,


    Thank you again for raising this feedback. This new command "atlas config edit" is available on Atlas CLI since version 1.2.0.


    Looking forward to seeing more feedback on the Atlas CLI.


    Thanks,

    Jakub

  12. Add description of JSON file used to create cluster.

    According to doco https://www.mongodb.com/docs/atlas/cli/upcoming/command/atlas-clusters-create/

    "For full control of your deployment, or to create multi-cloud clusters, provide a JSON configuration file with the --file flag."

    it would be nice to get detailed description what should be in this file, what can be changed and what is the expected format of parameters in this file.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    0 comments  ·  Atlas CLI  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Hi Sergey,


    Apologies for the late response here and thank you for raising it in the first place. 

    In version 1.5.0 of the Atlas CLI we've updated the command's help to provide better guidelines and links to more details on the configuration file.


    You'll see the following information

    -f, --file string                   Path to an optional JSON configuration file that defines cluster settings. To learn more about configuration files for the Atlas CLI, see https://www.mongodb.com/docs/atlas/cli/stable/cluster-config-file/. To learn more about configuration files for MongoCLI, see https://www.mongodb.com/docs/mongocli/stable/reference/mms-cluster-settings-file/.


    Please let me know if there's anything unclear.


    Thanks,

    Jakub

  13. Add --currentIp to atlas accessList

    Would be nice to have the --currentIp option when using "atlas accessList".
    The current workaround in linux/macOS is

    mongocli atlas accessList create curl ifconfig.me

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    completed  ·  1 comment  ·  Atlas CLI  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  14. Support setting userToDNMapping in LDAP config

    There are flags to save other LDAP configuration settings but none for this portion. I would imagine it to be three flags with two being mutually exclusive (per docs at https://docs.mongodb.com/manual/reference/configuration-options/#security.ldap.userToDNMapping):
    [ --mappingMatch <regex> { --mappingLdapQuery <query> | --mappingSubstitution <DN> } ]

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  Atlas CLI  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  15. Add command to restart the cluster

    Refer to the Ops Manager Commands => https://docs.mongodb.com/mongocli/stable/reference/ops-manager/cluster-commands/, there are the commands to startup/shutdown cluster but not restart.
    It will be helpful to have a restart command that will rolling restart a cluster.

    1 vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    We’ll send you updates on this idea

    1 comment  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)
  • Don't see your idea?

Feedback and Knowledge Base