Quick Start¶
On this page
MongoDB CLI provides a command-line interface for managing your MongoDB Atlas, MongoDB Cloud Manager, and MongoDB Ops Manager projects and clusters. This tutorial demonstrates how to download, install, and configure MongoDB CLI. Then, for each platform, it demonstrates how to create a ready-to-go MongoDB cluster.
The reference pages for the commands mentioned in this tutorial are available in the mongocli section.
Prerequisites¶
Before you begin, review and ensure that your environment is compatible for installing and using MongoDB CLI.
This tutorial requires the following:
- A MongoDB account for Atlas and Cloud Manager only
- An Atlas, Cloud Manager, or Ops Manager organization and project
Download and Install MongoDB CLI¶
See Install or Update the MongoDB CLI for information on downloading and installing MongoDB CLI. After installing MongoDB CLI, run the following command to verify installation:
mongocli help
Generate Programmatic Access Keys¶
MongoDB CLI uses Programmatic Access Keys to access the Atlas, Cloud Manager, or Ops Manager projects. Your Programmatic API Key must have:
- The
project owneror higher role - The access list entry for your IP address or CIDR range
To learn more about generating the Programmatic API Key, see:
Configure the MongoDB CLI¶
Next Steps¶
Now that you've installed and configured MongoDB CLI for accessing your MongoDB service, proceed to: