Docs Menu
Docs Home
/ /
Atlas CLI
/

atlas config

On this page

  • Options
  • Inherited Options
  • Related Commands

Configure and manage your user profiles.

Configure settings in a user profile. All settings are optional. You can specify settings individually by running: $ atlas config set --help

You can also use environment variables (MONGODB_ATLAS_*) when running the tool. To find out more, see the documentation: https://dochub.mongodb.org/core/atlas-cli-env-variables.

Name
Type
Required
Description
-h, --help
false
help for config
Name
Type
Required
Description
-P, --profile
string
false
Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
  • atlas config delete - Delete a profile.

  • atlas config describe - Return the profile you specify.

  • atlas config edit - Opens the config file with the default text editor.

  • atlas config init - Configure a profile to store access settings for your MongoDB deployment.

  • atlas config list - Return a list of available profiles by name.

  • atlas config rename - Rename a profile.

  • atlas config set - Configure specific properties of a profile.

Back

zsh