-
Notifications
You must be signed in to change notification settings - Fork 88
CLOUDP-112242: Updated README.MD #1001
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.
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
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
7900850
Updated README.MD
andreaangiolillo 49fd175
Update README.md
andreaangiolillo 7869f91
Update README.md
andreaangiolillo d7dbe20
Update README.md
andreaangiolillo 1383e31
Merge remote-tracking branch 'origin/master' into CLOUDP-112242
andreaangiolillo e25b397
Update README.md
andreaangiolillo 2322848
addressed PR comments
andreaangiolillo 75173d4
Merge remote-tracking branch 'origin/master' into CLOUDP-112242
andreaangiolillo 8e19b2d
Update README.md
andreaangiolillo a76cab1
Addressed PR comments
andreaangiolillo 66d5f20
Update README.md
andreaangiolillo 2123590
Remamed AtlasCLI to Atlas CLI
andreaangiolillo 581cb0f
Addressed Design's comments
andreaangiolillo 70618eb
Addressed Doc comments
andreaangiolillo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,113 +1,18 @@ | ||
| <p align="center"> | ||
| <img width="80" height="80" src="https://raw.github.com/mongodb/mongocli/master/mongocli.svg" alt="MongoDB CLI Logo"> | ||
| </p> | ||
|
|
||
| ## MongoDB Atlas CLI | ||
|
|
||
|  | ||
|  | ||
|
|
||
| The MongoDB CLI is a modern command line interface that enables you to manage your MongoDB services from the terminal. | ||
|
|
||
|  | ||
| The MongoDB Atlas CLI repository contains the following modern command line interfaces: | ||
| - [Atlas CLI](atlascli.md) | ||
| - [MongoDB CLI](mongocli.md) | ||
|
|
||
| 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](https://docs.mongodb.com/mongocli/stable/) for instructions on how to | ||
| install, set up, and reference available commands. | ||
|
|
||
| ## Installing | ||
|
|
||
| ### Homebrew on macOS | ||
|
|
||
| ```bash | ||
| brew install mongocli | ||
| ``` | ||
|
|
||
| ### 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 place this binary somewhere in your `PATH` for easy use. | ||
| `/usr/local/bin` is the most probable location. | ||
|
|
||
| ### Build From Source | ||
|
|
||
| #### Prerequisite Tools | ||
| - [Git](https://git-scm.com/) | ||
| - [Go (at least Go 1.17)](https://golang.org/dl/) | ||
|
|
||
| #### Fetch Source | ||
|
|
||
| ```bash | ||
| git clone https://github.com/mongodb/mongocli.git | ||
| cd mongocli | ||
| ``` | ||
|
|
||
| #### Build | ||
|
|
||
| To build `mongocli`, run: | ||
|
|
||
| ```bash | ||
| make build | ||
| ``` | ||
|
|
||
| The resulting `mongocli` binary is placed in `./bin`. | ||
|
|
||
| #### Install | ||
|
|
||
| To install the `mongocli` binary in `$GOPATH/bin`, run: | ||
|
|
||
| ```bash | ||
| 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](https://docs.mongodb.com/mongocli/master/) 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](https://docs.atlas.mongodb.com/configure-api-access/), | ||
| [Ops Manager](https://docs.opsmanager.mongodb.com/current/tutorial/configure-public-api-access/), | ||
| or [Cloud Manager](https://docs.cloudmanager.mongodb.com/tutorial/manage-programmatic-api-keys/) | ||
|
|
||
| ### Configuring `mongocli` | ||
|
|
||
| Run `mongocli config` to set up your credentials, | ||
| this is optional, you can use [env variables](https://docs.mongodb.com/mongocli/stable/configure/environment-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](#hombrew-on-macos) no additional actions are needed. | ||
|
|
||
| To get specific instructions for your preferred shell run: | ||
|
|
||
| ```bash | ||
| mongocli completion <bash|zsh|fish|powershell> --help | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| See our [CONTRIBUTING.md](CONTRIBUTING.md) guide. | ||
|
|
||
| ## License | ||
|
|
||
| MongoDB CLI is released under the Apache 2.0 license. See [LICENSE](LICENSE) | ||
| MongoDB CLI and Atlas CLI are released under the Apache 2.0 license. See [LICENSE](LICENSE) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # Atlas CLI (Pre-Release) | ||
|
|
||
| The MongoDB Atlas CLI is a modern command line interface that enables you to manage MongoDB Atlas from the terminal. | ||
|
|
||
|  | ||
|
|
||
| ## Installing | ||
|
|
||
| Atlas CLI is currently in the pre-release phase. Do not use it in a production environment. | ||
|
|
||
| ### Pre-built Binaries | ||
|
|
||
| Download the appropriate version for your platform from [Atlas CLI releases](https://github.com/mongodb/mongocli/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 | ||
|
|
||
| ```bash | ||
| git clone https://github.com/mongodb/mongocli.git | ||
| cd mongocli | ||
| ``` | ||
|
|
||
| #### Build | ||
|
|
||
| To build `atlascli`, run: | ||
|
|
||
| ```bash | ||
| make build-atlascli | ||
| ``` | ||
|
|
||
| The resulting `atlas` binary is placed in `./bin`. | ||
|
|
||
| #### Install | ||
|
|
||
| To install the `atlas` binary in `$GOPATH/bin`, run: | ||
|
|
||
| ```bash | ||
| make install-atlascli | ||
| ``` | ||
|
|
||
| **Note:** running `make build-atlascli` is not needed when running `make install-atlascli`. | ||
|
|
||
|
|
||
| ## 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](#hombrew-on-macos) no additional actions are needed. | ||
|
|
||
| To get specific instructions for your preferred shell, run: | ||
|
|
||
| ```bash | ||
| atlas completion <bash|zsh|fish|powershell> --help | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| # MongoDB CLI | ||
|
|
||
| The MongoDB CLI is a modern command line interface that enables you to manage your MongoDB services from the terminal. | ||
|
|
||
|  | ||
|
|
||
| Use simple, one-line commands to interact with MongoDB Atlas, Cloud Manager, or Ops Manager, and automate management tasks for your deployments. | ||
|
|
||
| ## Documentation | ||
|
|
||
| See the [official docs](https://docs.mongodb.com/mongocli/stable/) for instructions on how to | ||
| install, set up, and reference available commands. | ||
|
|
||
| ## Installing | ||
|
|
||
| ### Homebrew on macOS | ||
|
|
||
| ```bash | ||
| brew install mongocli | ||
| ``` | ||
|
|
||
| ### Pre-built Binaries | ||
|
|
||
| Download the appropriate version for your platform from [mongocli releases](https://github.com/mongodb/mongocli/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 | ||
|
|
||
| ```bash | ||
| git clone https://github.com/mongodb/mongocli.git | ||
| cd mongocli | ||
| ``` | ||
|
|
||
| #### Build | ||
|
|
||
| To build `mongocli`, run: | ||
|
|
||
| ```bash | ||
| make build | ||
| ``` | ||
|
|
||
| The resulting `mongocli` binary is placed in `./bin`. | ||
|
|
||
| #### Install | ||
|
|
||
| To install the `mongocli` binary in `$GOPATH/bin`, run: | ||
|
|
||
| ```bash | ||
| make install | ||
| ``` | ||
|
|
||
| **Note:** running `make build` is not needed when running `make install`. | ||
|
|
||
| ## Usage | ||
|
|
||
| To get a list of available commands, run `mongocli help` | ||
| or check our [documentation](https://docs.mongodb.com/mongocli/master/) for more details. | ||
|
|
||
| ### Configuring MongoCLI with Atlas | ||
| To use `mongocli` with Atlas, open your terminal, run `mongocli auth login`, and follow the prompted steps. | ||
|
|
||
| ### Configuring MongoCLI with Ops Manager and Cloud Manager | ||
|
|
||
| #### Getting API Keys (Ops manager / Cloud Manager) | ||
| To use `mongocli`, create API keys. To learn more, see the documentation for the service you're using: | ||
| - [Atlas](https://docs.atlas.mongodb.com/configure-api-access/), | ||
| - [Ops Manager](https://docs.opsmanager.mongodb.com/current/tutorial/configure-public-api-access/), | ||
| - [Cloud Manager](https://docs.cloudmanager.mongodb.com/tutorial/manage-programmatic-api-keys/) | ||
|
|
||
| #### Set up your credentials | ||
| To set up your credentials, run `mongocli config`, or use [env variables](https://docs.mongodb.com/mongocli/stable/configure/environment-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](#hombrew-on-macos) no additional actions are needed. | ||
|
|
||
| To get specific instructions for your preferred shell, run: | ||
|
|
||
| ```bash | ||
| mongocli completion <bash|zsh|fish|powershell> --help | ||
| ``` | ||
andreaangiolillo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.