mongocli
is a tool for managing your MongoDB cloud services
brew tap mongodb/brew
brew install mongocli
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.
git clone https://github.com/mongodb/mongocli.git
cd mongocli
To build mongocli
, run:
make build
The resulting mongocli
binary is placed in ./bin
.
To install the mongocli
binary in $GOPATH/bin
, run:
make install
Note: running make build
is not needed when running make install
.
Run mongocli help
for a list of available commands
or check our online documentation for more details.
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
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
.
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
If you install via homebrew there's nothing else to do. For other installations please refer to your preferred shell instructions.
$ 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
source <(mongocli completion zsh)
To load completions for each session, execute once:
mongocli completion zsh > "${fpath[1]}/_mongocli"
mongocli completion fish | source
See our CONTRIBUTING.md Guide.
MongoDB CLI is released under the Apache 2.0 license. See LICENSE