Use the Atlas CLI to work with Atlas, including using MongoDB Search and MongoDB Vector Search, throughout the entire software development lifecycle from your local environment to the cloud.
Important
The atlas deployments commands are deprecated as of Atlas CLI version 1.52.0. Use atlas local commands for local deployments. We updated this page to use the atlas local command.
With the atlas local commands, you can perform the following actions:
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 MongoDB Search and MongoDB Vector Search indexes for your local and cloud Atlas deployments.
Note
For local Atlas deployments, you can manage only deployments that you created with the atlas local 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 atlas local Atlas CLI commands for local Atlas deployments. You can use all Atlas CLI commands for cloud Atlas deployments.
Supported Actions
You can perform the following actions with the atlas local command for local and cloud Atlas deployments including, but not limited to:
Connect with
mongosh, Compass, MongoDB for VS Code (versions 1.13.0+), or return the connection string for an Atlas deployment.Create or manage MongoDB Search indexes to run a full-text search on an Atlas deployment.
Create or manage MongoDB Vector Search indexes to run a semantic search on an Atlas deployment.
To learn all of the actions that the atlas local command supports, see atlas local.
Tutorials
Use the following resources for step-by-step guidance to run atlas local commands:
Tutorial | Objective |
|---|---|
Use the | |
Use the | |
Use the |