Use the Atlas CLI to work with Atlas, including using Atlas Search and Atlas Vector Search, throughout the entire software development lifecycle from your local environment to the cloud.
atlas deployments command and subsequent related commands
are available as a Public Preview. The feature and corresponding
documentation may change at any time in the Public Preview stage. To
ask questions and provide feedback, see the Atlas CLI
Local Development Community Forum.
atlas deployments commands, you can perform the following
Create and manage local Atlas deployments. Local Atlas deployments reside on your computer and provide a non-production environment for development.
Create and manage Atlas cloud deployments. Cloud Atlas deployments reside in the cloud for non-production and production use.
Manage Atlas Search and Atlas Vector Search indexes for your local and cloud Atlas deployments.
For local Atlas deployments, you can manage only deployments that
you created with the
atlas deployments command. If you created a
local Atlas deployment without using the Atlas CLI, you can't
manage that deployment with the Atlas CLI.
You can use only
atlas deployments Atlas CLI commands with
local Atlas deployments. You can use all Atlas CLI commands,
atlas deployments commands, with cloud Atlas
You can perform the following actions with the
command for local and cloud Atlas deployments including, but not limited to:
Create or manage Atlas Search indexes to run a full-text search on an Atlas deployment.
Create or manage Atlas Vector Search indexes to run a semantic search on an Atlas deployment.
To learn all of the actions that the
atlas deployments command
supports, see atlas deployments.
Use the following resources for step-by-step guidance to run