Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas CLI
/
Manage Atlas

Run Atlas CLI Commands with Docker

On this page

  • Complete The Prerequisites
  • Follow These Steps

This tutorial shows you how to run Atlas CLI commands with Docker in the following ways:

  • Run Docker in interactive mode

  • Run Docker as a daemon (detached mode)

To learn more about interactive mode and detached mode, see docker run.

For more information on our Atlas CLI docker image, see our Docker Hub repository.

You can also create a local Atlas deployment with Docker. To learn more, see Create a Local Atlas Deployment with Docker.

Complete The Prerequisites

Before you begin, complete the following prerequisites:

  1. Install the Docker engine or Docker desktop.

  2. Pull the Docker image to install the Atlas CLI with Docker.

  3. (Optional) To run in interactive mode with an environment file, create an environment file that contains valid Atlas CLI environment variables, including API key environment variables that provide your API keys.

Follow These Steps

To run Atlas CLI commands with Docker, select one of the following options and follow the steps:

1

Get a shell.

Run the command to get a shell in interactive mode.

Without an Environment File

To get a shell without an environment file, run the following command:

docker run --rm -it mongodb/atlas bash

With an Environment File

To get a shell using an environment file, run the following command, replacing atlas.env with the name of the environment file:

docker run --env-file atlas.env --rm -it mongodb/atlas bash
2

Authenticate and run Atlas CLI commands.

To authenticate and run commands, set up API keys in the environment file. To learn more, see Atlas CLI environment variables.

To authenticate without an environment file, you can run atlas auth login to authenticate:

atlas auth login

After you authenticate, you can run Atlas CLI commands. For example, you can run atlas --help to learn about available commands:

atlas --help
1

Start the daemon.

Run the following command to start the daemon:

docker run -d --name mongodb/atlas mongodb/atlas
2

Get a shell.

Run the following command to get a shell with an environment file:

docker exec --env-file atlas.env --rm -it mongodb/atlas bash
3

Authenticate and run Atlas CLI commands.

To authenticate and run commands, set up API keys in the environment file. To learn more, see Atlas CLI environment variables.

After you set up API keys, you can run Atlas CLI commands by adding docker exec --env-file ./atlas.env --rm mongodb/atlas before each Atlas CLI command. For example, to run the atlas --help command with an environment file, run the following command, replacing atlas.env with the name of the environment file:

docker exec --env-file ./atlas.env --rm mongodb/atlas atlas --help

Back

Test Automations

Next

Reference