mongodb-atlas
用於在整個軟件開發生命週期(從本地環境一直到雲端)管理 MongoDB Atlas。。通過x-cmd一鍵安裝,即刻體驗高效工作流程。
| Language | typescript |
| Homepage | https://www.mongodb.com/try/download/atlascli |
x install mongodb-atlas
MongoDB Atlas CLI:在終端裏掌控雲資料庫的全生命週期管理
管理 MongoDB Atlas 雲資料庫,你還在網頁控制枱裏點點點?MongoDB Atlas CLI(命令名 atlas)提供了一個更直接、更高效的方式——從本地開發環境到雲端生產環境,用簡短的命令在幾秒鐘內完成複雜的資料庫管理任務。對於習慣命令列工作流的開發者來説,這意味着不必在瀏覽器和終端之間頻繁切換,一條命令就能完成原本需要多次點擊的操作。
核心定位:貫穿軟件開發生命週期的 Atlas 管理工具
MongoDB Atlas CLI 是 MongoDB 官方推出的現代命令列接口,核心目標是讓你能夠從終端管理 MongoDB Atlas 的整個生命週期。它的設計哲學很直接:把雲控制枱的常用操作搬到終端,同時保持腳本化和自動化的能力。
這個工具專注於 Atlas 雲服務,支持從本地開發環境一直到雲端生產環境的統一管理。你可以用它來程序化地創建和管理 Atlas 部署、創建 Atlas Search 和 Vector Search 索引,以及其他各種雲資源管理任務。
核心功能一覽
| 功能域 | 具體能力 | 適用場景 |
|---|---|---|
| 集羣管理 | 創建、修改、刪除 Atlas 集羣;調整實例規格、存儲容量、自動擴展策略 | 開發測試環境快速搭建、生產集羣擴縮容 |
| 資料庫用户 | 管理資料庫用户和角色;配置 SCRAM、X.509、AWS IAM 等認證方式 | 自動化用户權限管理、CI/CD 環境配置 |
| 網絡訪問 | 配置 IP 訪問白名單(Network Access List)、私有端點(Private Endpoint)、VPC 對等連接 | 安全合規、混合雲網絡架構 |
| 搜索與向量索引 | 創建 Atlas Search 索引、Vector Search 索引,支持全文檢索和向量相似性搜索 | AI 應用、語義搜索、推薦系統 |
| 備份恢復 | 管理雲備份策略、創建快照、執行時間點恢復(PITR) | 數據保護、災難恢復演練 |
| 監控告警 | 查看集羣指標、配置告警規則、集成第三方通知渠道 | 運維監控、性能優化 |
| 組織與項目 | 管理 Atlas 組織和項目結構、API 密鑰、團隊成員 | 多團隊協作、資源隔離 |
安裝與快速上手
通過 x-cmd 安裝(推薦)
x env use mongodb-atlas其他安裝方式
# macOS (Homebrew)
brew install mongodb-atlas-cli
# 驗證安裝
atlas --version更多安裝方法可參考 MongoDB 官方文檔。
首次配置與認證
安裝完成後,需要完成一次性認證配置:
# 使用 atlas CLI 進行認證
atlas auth login
# 按提示在瀏覽器中完成 MongoDB Atlas 賬號授權
# 授權成功後,CLI 會保存訪問令牌,後續命令無需再次登錄認證完成後,你可以立即開始管理雲資源。CLI 會自動使用保存的憑證與 Atlas API 通信。
常用操作示例
一鍵快速入門(atlas setup)
atlas setup 命令用一條命令完成以下所有操作:
- 註冊一個 Atlas 帳户(如果沒有)
- 使用 Atlas 賬號進行身份驗證
- 創建一個免費資料庫(M0 集羣)
- 將示例數據載入 Atlas 資料庫
- 將你的 IP 地址添加到項目的 IP 訪問列表中
- 為 Atlas 資料庫部署創建 MongoDB 用户
- 使用 MongoDB Shell
mongosh連接到新部署的資料庫
atlas setup快速創建集羣
# 創建免費層集羣(M0),適合開發和測試
atlas cluster create my-demo-cluster \
--provider AWS \
--region US_EAST_1 \
--tier M0 \
--projectId <your-project-id>
# 查看集羣狀態
atlas cluster describe my-demo-cluster管理資料庫用户
# 創建讀寫用户
atlas dbusers create \
--username app-user \
--password <password> \
--role readWriteAnyDatabase \
--projectId <your-project-id>
# 列出所有用户
atlas dbusers list配置網絡訪問
# 添加當前 IP 到白名單
atlas accessLists create --currentIp
# 添加特定 IP 段
atlas accessLists create --ip 203.0.113.0/24 --comment "Office Network"連接資料庫
# 獲取連接字符串
atlas cluster connectionString describe my-demo-cluster
# 直接連接(需要本地安裝 mongosh)
atlas cluster connect my-demo-cluster創建搜索索引
# 創建 Atlas Search 索引
atlas search index create \
--clusterName my-demo-cluster \
--database sample_mflix \
--collection movies \
--name default \
--file search-index.json為什麼選擇 CLI 而非網頁控制枱?
效率提升 - 對於高頻操作,命令列比圖形界面快得多。創建集羣、添加用户、查看狀態,一條命令秒級完成,不需要等待頁面加載和多次點擊。
腳本化與自動化 - CLI 的輸出可以輕易被腳本處理。你可以用 Shell 腳本批量創建測試環境、用 Cron 定時備份、用 CI/CD Pipeline 自動配置資料庫資源。
基礎設施即代碼(IaC) - CLI 命令可以納入版本控制,與 Terraform、Ansible 等工具配合,實現雲資源的聲明式管理。團隊可以評審和審計每一次配置變更。
集成開發工作流 - 在 IDE 終端或 Tmux 會話中,開發、部署、資料庫管理可以在同一個界面完成,減少上下文切換的認知負擔。
技術實現細節
MongoDB Atlas CLI 基於 Go 語言開發,採用現代 CLI 設計模式:
命令結構:使用
cobra框架,命令按資源類型組織(atlas cluster、atlas dbusers、atlas accessLists等),支持子命令、參數、Flag 的自動補全。配置文件:認證信息存儲在
~/.config/atlascli/config.toml,支持多配置文件切換,方便管理多個 Atlas 組織。Shell 補全:原生支持 Bash、Zsh、Fish 的自動補全,Homebrew 安裝後自動配置。
輸出格式:支持表格(默認)、JSON、Go 模板等多種輸出格式,便於腳本解析:
bashatlas cluster list -o json | jq '.[] | select(.name | contains("prod"))'
典型應用場景
開發環境快速搭建 - 新功能開發前,用一條命令創建臨時 Atlas 集羣,開發完成後清理,實現資源的按需使用。
CI/CD 集成 - 在 GitHub Actions、GitLab CI 或 Jenkins Pipeline 中使用 CLI 動態創建測試資料庫、配置網絡白名單、運行集成測試、最後清理資源。
多項目管理 - 通過配置文件或環境變量切換不同的 Atlas 項目,統一管理工作流,避免在多個瀏覽器標籤頁間來回切換。
運維腳本編寫 - 編寫定期巡檢腳本,檢查集羣狀態、備份完整性、安全合規性,異常時發送告警通知。
災難恢復演練 - 使用 CLI 快速創建恢復測試環境,驗證備份數據的可恢復性,確保 RTO/RPO 符合業務要求。
AI 應用開發 - 利用 Vector Search 索引功能,為 RAG(檢索增強生成)應用快速搭建向量資料庫基礎設施。
與 MongoDB CLI(mongocli)的區別
| 工具 | 定位 | 適用場景 | 維護狀態 |
|---|---|---|---|
mongocli | 通用 MongoDB 雲管理工具 | Cloud Manager、Ops Manager 用户 | 維護中,新功能較少 |
atlas (mongodb-atlas) | 專注 Atlas 雲服務 | MongoDB Atlas 用户 | 活躍開發,推薦新用户使用 |
如果你是 MongoDB Atlas 用户,建議直接使用 atlas CLI(即 mongodb-atlas)。它的命令設計更貼近 Atlas 的資源模型,功能更新更及時,文檔也更完善。mongocli 仍適用於需要同時管理 Cloud Manager 或 Ops Manager 的場景。
總結
MongoDB Atlas CLI 代表了資料庫雲服務的終端化趨勢——讓開發者能在熟悉的環境中高效管理雲資源。對於習慣命令列工作流、追求自動化和效率的團隊來説,它是 Atlas 網頁控制枱的有力補充,甚至是替代方案。
如果你正在使用 MongoDB Atlas,花 10 分鐘嘗試一下 CLI,很可能會發現一些原本繁瑣的操作變得異常簡單。畢竟,在終端裏敲一行命令就能搞定的事,何必打開瀏覽器呢?
來源:
https://github.com/mongodb/mongodb-atlas-cli
https://www.mongodb.com/docs/atlas/cli/
官方下載:
幫助我們改善文檔
X-CMD 的文檔內容來自命令的幫助文檔、多個數據源以及文檔庫生成。文檔中如果有錯誤或不明確的地方,歡迎通過這些方式進行告知~
完成验证加入微信群