Connect to a deployment that is running locally or in Atlas. If the deployment is paused, make sure to run atlas deployments start first.
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.
atlas deployments connect [deploymentName] [options]Name
Type
Required
Description
deploymentName
string
false
Name of the deployment that you want to connect to.
Name
Type
Required
Description
--connectWith
string
false
Method for connecting to the deployment. Valid values are compass, connectionString, mongosh, and vscode.
--connectionStringType
string
false
Type of connection string. If you specify 'private', this option retrieves the connection string for the network peering endpoint. If you specify 'privateEndpoint', this option retrieves the shard optimized connection strings for the private endpoints. This value defaults to "standard".
-h, --help
false
help for connect
--password
string
false
Password for the user.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
--type
string
false
Type of deployment. Valid values are ATLAS or LOCAL.
--username
string
false
Username for authenticating to MongoDB.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4