Navigation

Install the MongoDB CLI

On this page

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.

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

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

Prerequisites

To install the MongoDB CLI using Homebrew, you must:

  1. Use a MacOS or Linux operating system.
  2. Install Homebrew.

Prerequisites

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

copy 
sudo apt-get install gnupg

Prerequisites

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

  1. Git.
  2. Go v1.14 or newer.

Procedure

1

Install the MongoDB CLI

Invoke the following brew commands:

copy 
brew tap mongodb/brew
brew install mongocli
2

Verify your installation.

To verify your mongocli installation, run the help command:

copy 
mongocli help

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

1

Configure yum for your edition of MongoDB.

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

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

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

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

Install the MongoDB CLI.

Invoke the following yum command:

copy 
sudo yum install -y mongocli
3

Verify your installation.

To verify your mongocli installation, run the help command:

copy 
mongocli help

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

1

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-4.2.asc.

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

A succesful command returns an OK.

2

Create a list file for your edition of MongoDB.

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

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

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

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

Reload the local package database.

Invoke the following command:

copy 
sudo apt-get update
4

Install the MongoDB CLI.

Invoke the following command:

copy 
sudo apt-get install -y mongocli
5

Verify your installation.

To verify your mongocli installation, run the help command:

copy 
mongocli help

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

1

Install the MongoDB CLI.

  1. Download and extract the correct binary for your operating system:

    Operating System Download
    Windows .zip
    MacOS .tar.gz
    Ubuntu/Debian .deb
    RHEL/CentOS/SLES/AMZ .rpm
    Linux .tar.gz

    Note

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

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

2

Add mongocli to your PATH.

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

  1. Add the location of the executable to your PATH or
  2. 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:

copy 
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.5.0-macOS_x86_64 directory.

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

copy 
cd mcli_1.5.0-macOS_x86_64
mv mongocli /usr/local/bin
3

Verify your installation.

To verify your mongocli installation, run the help command:

copy 
mongocli help

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

1

Install the MongoDB CLI.

  1. Clone the repository:

    copy 
    git clone https://github.com/mongodb/mongocli.git

  2. Change directories to your local repostiory:

    copy 
    cd mongocli

  3. Install MongoDB CLI using Go.

    copy 
    make install
2

Add mongocli to your PATH.

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

  1. Add the location of the executable to your PATH or
  2. 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:

copy 
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.5.0-macOS_x86_64 directory.

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

copy 
cd mcli_1.5.0-macOS_x86_64
mv mongocli /usr/local/bin
3

Verify your installation.

To verify your mongocli installation, run the help command:

copy 
mongocli help

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

Next Steps

Configure the MongoDB CLI for your environment.

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.