- This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of the Atlas CLI.
Configure and manage your user profiles.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
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.
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for config |
Inherited Options
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. |
Related Commands
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.