Configure the MongoDB CLI¶

On this page

Prerequisites

Procedure
Next Steps

You can define the settings that the MongoDB CLI uses to interact with MongoDB services like Atlas, Cloud Manager, and Ops Manager by using the mongocli config command. The first time you run this command, the MongoDB CLI creates a configuration file called mongocli.toml to store your settings.

Prerequisites¶

To configure the MongoDB CLI:

Add your IP or CIDR block to the API whitelist for your MongoDB service.
Generate a Programmatic API Key if you don't already have one.
Note
Programmatic API Keys are role-based. Different roles have different privileges and capabilities, and some MongoDB CLI commands are available to some roles but not others. Be sure that the roles assisgned to your Programmatic API Key are appropriate for the commands you intend to use.

To learn more about generating a Programmatic API Key for your MongoDB service, see the following documentation:

Procedure¶

The mongocli config command varies slightly depending on the MongoDB service for which you want to configure the MongoDB CLI.

Next Steps¶

Edit your configuration file to add or modify profiles.
Set environment variables to enable easier scripting.
Enable autocomplete to see available commands and their syntax directly in your shell.

← Install or Update the MongoDB CLI MongoDB CLI Configuration File →