Install or Update the MongoDB CLI

On this page

Install the MongoDB CLI

Update the MongoDB CLI
Next Steps

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoCLI.

You can use the MongoDB Command Line Interface (mongocli) to deploy and manage MongoDB clusters in Atlas, Cloud Manager, and Ops Manager. For operating system and MongoDB service version requirements, see Compatibility.

Install the MongoDB CLI

To install the MongoDB CLI, choose one of the following methods:

Install with a package manager like Homebrew, Yum, or Apt.
Download and extract the binary.
Clone the GitHub repository and install the MongoDB CLI with Go.

Prerequisites

To install the MongoDB CLI using Homebrew, you must:

Use a MacOS or Linux operating system.
Install Homebrew.

Prerequisites

To install the MongoDB CLI using Apt, you must install gnupg:

sudo apt-get install gnupg

Prerequisites

To install the MongoDB CLI, you must install the following tools:

Procedure

Install the MongoDB CLI

Invoke the following brew commands:

brew install mongocli

Verify your installation.

To verify your mongocli installation, run the help command:

mongocli help

The command returns the available commands and options for the MongoDB CLI.

Configure `yum` for your edition of MongoDB.

Create a /etc/yum.repos.d/mongodb-org-5.0.repo file so that you can install MongoDB CLI directly using yum.

[mongodb-org-5.0]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/5.0/x86_64/
gpgcheck=1
enabled=1
gpgkey=https://www.mongodb.org/static/pgp/server-5.0.asc

Create a /etc/yum.repos.d/mongodb-enterprise-5.0.repo file so that you can install MongoDB CLI directly using yum:

[mongodb-enterprise-5.0]
name=MongoDB Repository
baseurl=https://repo.mongodb.com/yum/redhat/$releasever/mongodb-enterprise/5.0/$basearch/
gpgcheck=1
enabled=1
gpgkey=https://www.mongodb.org/static/pgp/server-5.0.asc

Install the MongoDB CLI.

Invoke the following yum command:

sudo yum install -y mongocli

Verify your installation.

To verify your mongocli installation, run the help command:

mongocli help

The command returns the available commands and options for the MongoDB CLI.

Import the public key used by `apt`.

From a terminal, issue the following command to import the MongoDB public GPG Key from https://www.mongodb.org/static/pgp/server-5.0.asc.

wget -qO - https://www.mongodb.org/static/pgp/server-5.0.asc | sudo apt-key add -

A successful command returns an OK.

Create a list file for your edition of MongoDB.

Create the list file /etc/apt/sources.list.d/mongodb-org-5.0.list for your version of Ubuntu.

echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/5.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-5.0.list

echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu bionic/mongodb-org/5.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-5.0.list

Create a /etc/apt/sources.list.d/mongodb-enterprise.list file for MongoDB.

echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.com/apt/ubuntu focal/mongodb-enterprise/5.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list

echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.com/apt/ubuntu bionic/mongodb-enterprise/5.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-enterprise.list

Reload the local package database.

Invoke the following command:

sudo apt-get update

Install the MongoDB CLI.

Invoke the following command:

sudo apt-get install -y mongocli

Verify your installation.

To verify your mongocli installation, run the help command:

mongocli help

The command returns the available commands and options for the MongoDB CLI.

Install the MongoDB CLI.

Download and extract the correct binary for your operating system:

Operating System	Download
Windows	.zip, .msi
MacOS	.zip (x86-64), .zip (ARM)
Ubuntu/Debian	.deb (x86-64), .deb (ARM)
RHEL/CentOS/SLES/AMZ	.rpm (x86-64), .rpm (ARM)
Linux	.tar.gz (x86-64), .tar.gz (ARM)

Note

Replace or remove any existing MongoDB CLI binaries to prevent conflicts between versions.

Run the executable file.
Tip
You can run the binary from any directory. Because you don't need to install the MongoDB CLI into a global location, you can use it on shared hosts and other systems where you don't have a privileged account.

Add `mongocli` to your `PATH`.

To run mongocli commands from anywhere in your system, you must either:

Add the location of the executable to your PATH or
Move the executable to a directory in your PATH.

You can accomplish this in several ways, depending on your personal settings and environment. Consult the documentation for your shell and operating system for more examples.

Example

In the following example, the user downloads and installs the MongoDB CLI by cloning the GitHub repository. The mongocli executable file saves to the location specified by your $GOPATH environment variable. The default location is $HOME/go on Unix systems and %USERPROFILE%\go on Windows.

The user then adds this directory to their PATH:

export PATH="$HOME/go:$PATH"

Example

In the following example, the user downloads and extracts a binary for the MongoDB CLI to the /mcli_1.20.4-macOS_x86_64 directory.

The user then moves the executable file to a directory already in their PATH:

cd mcli_1.20.4-macOS_x86_64
mv mongocli /usr/local/bin

Verify your installation.

To verify your mongocli installation, run the help command:

mongocli help

The command returns the available commands and options for the MongoDB CLI.

Install the MongoDB CLI.

Clone the repository:
```
git clone https://github.com/mongodb/mongocli.git
```
Change directories to your local repostiory:
```
cd mongocli
```
Install MongoDB CLI using Go.
```
make install
```

Add `mongocli` to your `PATH`.

To run mongocli commands from anywhere in your system, you must either:

Add the location of the executable to your PATH or
Move the executable to a directory in your PATH.

You can accomplish this in several ways, depending on your personal settings and environment. Consult the documentation for your shell and operating system for more examples.

Example

The user then adds this directory to their PATH:

export PATH="$HOME/go:$PATH"

Example

In the following example, the user downloads and extracts a binary for the MongoDB CLI to the /mcli_1.20.4-macOS_x86_64 directory.

The user then moves the executable file to a directory already in their PATH:

cd mcli_1.20.4-macOS_x86_64
mv mongocli /usr/local/bin

Verify your installation.

To verify your mongocli installation, run the help command:

mongocli help

The command returns the available commands and options for the MongoDB CLI.

Update the MongoDB CLI

To update the MongoDB CLI, follow the procedure for the method with which you installed the MongoDB CLI:

Procedure

Update the MongoDB CLI

Invoke the following brew commands:

brew update
brew upgrade mongocli

Verify your update.

To verify your mongocli update, run the --version command:

mongocli --version

The command returns your MongoDB CLI version.

Procedure

Update the MongoDB CLI.

Invoke the following yum command:

yum update mongocli

Verify your update.

To verify your mongocli update, run the --version command:

mongocli --version

The command returns your MongoDB CLI version.

Procedure

Update the MongoDB CLI.

Invoke the following command:

sudo apt-get install --only-upgrade mongocli

Verify your update.

To verify your mongocli update, run the --version command:

mongocli --version

The command returns your MongoDB CLI version.

Procedure

Update the MongoDB CLI.

Remove any existing MongoDB CLI binaries to prevent conflicts between versions.

Download and extract the correct binary for your operating system:

Operating System	Download
Windows	.zip, .msi Note The `.msi` download for Windows replaces old installations of the MongoDB CLI, so you don't need to remove existing binaries first.
MacOS	.tar.gz (x86-64), .tar.gz (ARM)
Ubuntu/Debian	.deb (x86-64), .deb (ARM)
RHEL/CentOS/SLES/AMZ	.rpm (x86-64), .rpm (ARM)
Linux	.tar.gz (x86-64), .tar.gz (ARM)

Run the executable file.

Verify your update.

To verify your mongocli update, run the --version command:

mongocli --version

The command returns your MongoDB CLI version.

Procedure

Update the MongoDB CLI.

Change directories to your local mongocli repostiory:
```
cd mongocli
```

Update your local repository with the latest changes from MongoDB:
```
git pull
```
Reinstall MongoDB CLI using Go.
```
make install
```

Verify your update.

To verify your mongocli update, run the --version command:

mongocli --version

The command returns your MongoDB CLI version.

Next Steps

Configure the MongoDB CLI for your environment.
Enable autocomplete to see available commands and their syntax directly in your shell.

Install the MongoDB CLI

Prerequisites

Prerequisites

Prerequisites

Procedure

Install the MongoDB CLI

Verify your installation.

Configure yum for your edition of MongoDB.

Install the MongoDB CLI.

Verify your installation.

Import the public key used by apt.

Create a list file for your edition of MongoDB.

Reload the local package database.

Install the MongoDB CLI.

Verify your installation.

Install the MongoDB CLI.

Note

Tip

Add mongocli to your PATH.

Example

Example

Verify your installation.

Install the MongoDB CLI.

Add mongocli to your PATH.

Example

Example

Verify your installation.

Update the MongoDB CLI

Procedure

Update the MongoDB CLI

Verify your update.

Procedure

Update the MongoDB CLI.

Verify your update.

Procedure

Update the MongoDB CLI.

Verify your update.

Procedure

Update the MongoDB CLI.

Note

Verify your update.

Procedure

Update the MongoDB CLI.

Verify your update.

Next Steps

Configure `yum` for your edition of MongoDB.

Import the public key used by `apt`.

Add `mongocli` to your `PATH`.

Add `mongocli` to your `PATH`.