Docs Menu

atlas setup

On this page

  • Syntax
  • Options
  • Inherited Options
  • Examples

Register, authenticate, create, and access an Atlas cluster.

This command takes you through registration, login, default profile creation, creating your first free tier cluster and connecting to it using MongoDB Shell.

atlas setup [options]
Name
Type
Required
Description
--accessListIp
strings
false
IP address to be allowed to access the deployment.
--clusterName
string
false
Name of the cluster.
--currentIp
false
Flag that indicates whether to use the IP Address from the host that is currently executing the command.
--force
false
If specified, skips asking for confirmation before proceeding with a requested action.
--gov
false
Register with Atlas for Government.
-h, --help
false
help for setup
--noBrowser
false
Don't try to open a browser session.
--password
string
false
User's password.
--provider
string
false
Name of your cloud service provider. Valid values are AWS, AZURE, or GCP.
-r, --region
string
false
Physical location of your MongoDB cluster. For a complete list of supported AWS regions, see: https://docs.atlas.mongodb.com/reference/amazon-aws/#amazon-aws. For a complete list of supported Azure regions, see: https://docs.atlas.mongodb.com/reference/microsoft-azure/#microsoft-azure. For a complete list of supported GCP regions, see: https://docs.atlas.mongodb.com/reference/google-gcp/#google-gcp.
--skipMongosh
false
Indicates whether to skip accessing your deployment with MongoDB Shell.
--skipSampleData
false
Indicates whether to skip loading sample data into your Atlas cluster.
--tier
string
false
Tier for each data-bearing server in the cluster. This value defaults to "M0".
--username
string
false
Username for authenticating to MongoDB.
Name
Type
Required
Description
-P, --profile
string
false
Profile to use from your configuration file.
Override default cluster settings like name, provider, or database username by using the command options
$ atlas setup --clusterName Test --provider GCP --username dbuserTest
What is MongoDB Atlas? →
Give Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.