Skip to content

CLOUDP-60401: Update README to use new brew repo #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 8, 2020
Merged

CLOUDP-60401: Update README to use new brew repo #92

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,62 +3,63 @@

`mongocli` is a tool for managing your MongoDB cloud services

![Screenshot 2020-01-03 at 10 49 27](https://user-images.githubusercontent.com/461027/73472371-d6656480-4382-11ea-8bfb-535d91cf1fb4.png)
![Screenshot 2020-04-07 at 16 27 14](https://user-images.githubusercontent.com/461027/78688122-d3d83b80-78ec-11ea-84f9-06a24ed7f75a.png)

# Installing
## Installing

## Hombrew on macOS
### Hombrew on macOS or Linux

```bash
brew install mongodb-labs/mongocli/mongocli
brew tap mongodb/brew
brew install mongocli
```

## Pre-built Binaries
### Pre-built Binaries
Download the appropriate version for your platform from [mongocli releases](https://github.com/mongodb/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 install it somewhere in your PATH for easy use. `/usr/local/bin` is the most probable location.

## Build from Source
### Build from Source

### Prerequisite Tools
#### Prerequisite Tools
- [Git](https://git-scm.com/)
- [Go (at least Go 1.13)](https://golang.org/dl/)

### Fetch and Install
#### Fetch and Install

```bash
git clone https://github.com/mongodb/mongocli.git
cd mongocli
make install
```

# Usage
## Usage

Run `mongocli help` for a list of available commands
or check our [online documentation](https://docs.mongodb.com/mongocli/master/) for more details

## Getting started
### Getting started

Run `mongocli config` to set up your credentials.

You can also use `MCLI_PUBLIC_API_KEY`, `MCLI_PRIVATE_API_KEY`, and optionally `MCLI_OPS_MANAGER_URL`
to define some of the authentication variables

## ZSH Completion (experimental)
### ZSH Completion (experimental)
Add the following to your `.zshrc` file

```bash
source <(mongocli completion zsh)
compdef _mongocli mongocli
```

# Contributing
## Contributing

See our [CONTRIBUTING.md](CONTRIBUTING.md) Guide.

# License
## License

MongoDB CLI is released under the Apache 2.0 license. See [LICENSE](LICENSE)