Docs Menu

Docs HomeMongoDB Command Line Interface

mongocli atlas quickstart

On this page

  • Syntax
  • Options
  • Inherited Options
  • Examples

Create, configure, and connect to an Atlas cluster.

This command creates a new cluster, adds your public IP to the atlas access list and creates a db user to access your new MongoDB instance.

mongocli atlas quickstart [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.
-Y, --default
false
Flag that indicates whether to run the Quickstart command with all the auto-generated values to deploy and access an Atlas cluster.
--force
false
If specified, skips asking for confirmation before proceeding with a requested action.
-h, --help
false
help for quickstart
--password
string
false
User's password.
--projectId
string
false
Project ID to use. Overrides the settings in the configuration file or environment variable.
--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.
Skip setting cluster name, provider or database username by using the command options:
$ mongocli atlas quickstart --force
$ mongocli atlas quickstart --clusterName Test --provider GCP --username dbuserTest
←  mongocli atlas processes listmongocli atlas security →
Give Feedback
© 2022 MongoDB, Inc.

About

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