atlas deployments connect
On this page
Connect to a deployment that is running locally or in Atlas. If the deployment is paused, make sure to run atlas deployments start first.
Syntax
Command Syntax
atlas deployments connect [deploymentName] [options]
Arguments
Name | Type | Required | Description |
|---|---|---|---|
deploymentName | string | false | Name of the deployment that you want to connect to. |
Options
Name | Type | Required | Description |
|---|---|---|---|
--connectWith | string | false | Method for connecting to the deployment. Valid values are compass, connectionString and mongosh. |
--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. |
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. |