mongocli

MongoDB CLI enables you to manage your MongoDB in the Cloud


Keywords
infrastructure, golang, mongodb, mongodb-atlas, mongodb-ops-manager, mongodb-cloud-manager
License
Apache-2.0
Install
brew install mongocli

Documentation

MongoDB CLI Logo

GO tests golangci-lint

mongocli is a tool for managing your MongoDB cloud services

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 do this please 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 and you can use env variables instead.

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

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

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

Environment Variables

You can use a combination of the next env variables to override your profile settings

  • MCLI_PUBLIC_API_KEY
  • MCLI_PRIVATE_API_KEY
  • MCLI_PROJECT_ID
  • MCLI_ORG_ID
  • MCLI_OPS_MANAGER_URL
  • MCLI_PROFILE
  • MCLI_OUTPUT
  • MCLI_MONGOSH_PATH

Shell Completions

If you install via homebrew there's nothing else to do. For other installations please refer to your preferred shell instructions.

Bash

$ source <(mongocli completion bash)

To load completions for each session, execute once:

Linux:

mongocli completion bash > /etc/bash_completion.d/mongocli

macOS:

mongocli completion bash > /usr/local/etc/bash_completion.d/mongocli

Zsh

source <(mongocli completion zsh)

To load completions for each session, execute once:

mongocli completion zsh > "${fpath[1]}/_mongocli"

Fish

mongocli completion fish | source

Contributing

See our CONTRIBUTING.md Guide.

License

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