atlas local setup

Syntax

atlas local setup [deployment_name] [options]

Arguments

Options

The default is false.

• • --connectWith

  • string

  • false

  • Method for connecting to the deployment after setup.

If not provided, the user will be prompted to select a connection method.

• • --force

  • false

  • Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action.

The default is false.

• • --image

  • string

  • false

  • Alternative docker image to use for the deployment.

The default is the official MongoDB Atlas Local image. To learn more about the official MongoDB Atlas Local image, see https://hub.docker.com/r/mongodb/mongodb-atlas-local

• • --initdb

  • string

  • false

  • Flag that uses a folder to be mapped into LOCAL deployment for initialization

The folder must exist and be a directory.

• • --loadSampleData

  • false

  • Flag that indicates whether to load sample data into the deployment.

The default is false.

• • --mdbVersion

  • string

  • false

  • MongoDB version to use for the deployment.

Expected format: <major>[.<minor>[.<patch>]] or 'latest'. Some examples: 8, 8.2, 8.2.1, latest

• • --password

  • string

  • false

  • Password for the user

• • --port

  • int

  • false

  • Port that the MongoDB server listens to for client connections.

The port must be between 1 and 65535.

• • --skipPullImage

  • false

  • Flag that indicates whether to skip the pull image step.

This will prevent the CLI from pulling the latest MongoDB Atlas Local image. Use with caution as you might end up with an outdated image.

The default is false.

• • --username

  • string

  • false

  • Username for authenticating to MongoDB

Inherited Options