Skip to content

Latest commit

 

History

History
77 lines (48 loc) · 1.98 KB

README.md

File metadata and controls

77 lines (48 loc) · 1.98 KB

MongoDB Atlas CLI

The MongoDB Atlas CLI is a modern command line interface that enables you to manage MongoDB Atlas from the terminal.

atlascli-atlas-quickstart

Installing

Homebrew

brew install mongodb-atlas-cli

See Install or Update the Atlas CLI to see all the installation methods available.

Pre-built Binaries

Download the appropriate version for your platform from Atlas CLI releases. After you download the library, you can run it from anywhere and don't need to install it into a global location. This works well for shared hosts and other systems where you don't have a privileged account.

You can place this binary somewhere in your PATH for ease of use. /usr/local/bin is the most probable location.

Build From Source

Fetch Source

git clone https://github.com/mongodb/mongodb-atlas-cli.git
cd mongodb-atlas-cli

Build

To build atlascli, run:

make build

The resulting atlas binary is placed in ./bin.

Install

To install the atlas binary in $GOPATH/bin, run:

make install

Note: running make build is not needed when running make install.

Usage

To get a list of available commands, run atlas help or check our documentation for more details.

Configuring Atlas CLI

To use atlascli, open your terminal, run atlas auth login, and follow the prompted steps.

Shell Completions

If you install via homebrew no additional actions are needed.

To get specific instructions for your preferred shell, run:

atlas completion <bash|zsh|fish|powershell> --help

Contributing

See our CONTRIBUTING.md guide.

License

MongoDB Atlas CLI is released under the Apache 2.0 license. See LICENSE