/mongocli-test

MongoDB CLI enables you to manage your MongoDB in the Cloud

Primary LanguageGoApache License 2.0Apache-2.0

MongoDB CLI Logo

GO tests golangci-lint

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

mongocli-atlas-quickstart

Use simple, one-line commands to interact with MongoDB Atlas, Cloud Manager, or Ops Manager, and to automate management tasks for your deployments.

Documentation

See the official docs for instructions on how to install, set up, and reference available commands.

Installing

Homebrew on macOS

brew install mongocli

Pre-built Binaries

Download the appropriate version for your platform from mongocli releases. Once downloaded, the binary can be run from anywhere. You 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.

Ideally, you should place this binary somewhere in your PATH for easy use. /usr/local/bin is the most probable location.

Build From Source

Prerequisite Tools

Fetch Source

git clone https://github.com/mongodb/mongocli.git
cd mongocli

Build

To build mongocli, run:

make build

The resulting mongocli binary is placed in ./bin.

Install

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

make install

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

Usage

Run mongocli help for a list of available commands or check our online documentation for more details.

Getting API Keys

To use mongocli you'll need to get API keys, to get them follow the documentation appropriate for the service you're using, Atlas, Ops Manager, or Cloud Manager

Configuring mongocli

Run mongocli config to set up your credentials, this is optional, you can use env variables instead.

If you're working with Atlas Gov, Ops Manager or Cloud Manager you need to define the service using --service

For Atlas Gov, mongocli config --service cloudgov.

For Ops Manager, mongocli config --service ops-manager.

For Cloud Manager, mongocli config --service cloud-manager.

Shell Completions

If you install via homebrew no additional actions are needed.

To get specific instructions for your preferred shell run:

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

Contributing

See our CONTRIBUTING.md guide.

License

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