Skip to content

Commit 952f73b

Browse files
andreaangiolilloandreaangiolillo
authored
CLOUDP-112242: Updated README.MD (#1001)
1 parent a1a4923 commit 952f73b

File tree

3 files changed

+164
-100
lines changed

3 files changed

+164
-100
lines changed

‎README.md‎

Lines changed: 5 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -1,113 +1,18 @@
1-
<p align="center">
2-
<img width="80" height="80" src="https://raw.github.com/mongodb/mongocli/master/mongocli.svg" alt="MongoDB CLI Logo">
3-
</p>
4-
1+
## MongoDB Atlas CLI
52

63
![GO tests](https://github.com/mongodb/mongocli/workflows/GO%20tests/badge.svg)
74
![golangci-lint](https://github.com/mongodb/mongocli/workflows/golangci-lint/badge.svg)
85

9-
The MongoDB CLI is a modern command line interface that enables you to manage your MongoDB services from the terminal.
10-
11-
![mongocli-atlas-quickstart](https://user-images.githubusercontent.com/461027/126986233-0dd5c82a-2c75-4887-ab66-eb018c59e093.gif)
6+
The MongoDB Atlas CLI repository contains the following modern command line interfaces:
7+
- [Atlas CLI](atlascli.md)
8+
- [MongoDB CLI](mongocli.md)
129

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

15-
## Documentation
16-
17-
See the [official docs](https://docs.mongodb.com/mongocli/stable/) for instructions on how to
18-
install, set up, and reference available commands.
19-
20-
## Installing
21-
22-
### Homebrew on macOS
23-
24-
```bash
25-
brew install mongocli
26-
```
27-
28-
### Pre-built Binaries
29-
30-
Download the appropriate version for your platform from [mongocli releases](https://github.com/mongodb/mongocli/releases).
31-
Once downloaded, the binary can be run from anywhere.
32-
You don't need to install it into a global location.
33-
This works well for shared hosts and other systems where you don't have a privileged account.
34-
35-
Ideally, you should place this binary somewhere in your `PATH` for easy use.
36-
`/usr/local/bin` is the most probable location.
37-
38-
### Build From Source
39-
40-
#### Prerequisite Tools
41-
- [Git](https://git-scm.com/)
42-
- [Go (at least Go 1.17)](https://golang.org/dl/)
43-
44-
#### Fetch Source
45-
46-
```bash
47-
git clone https://github.com/mongodb/mongocli.git
48-
cd mongocli
49-
```
50-
51-
#### Build
52-
53-
To build `mongocli`, run:
54-
55-
```bash
56-
make build
57-
```
58-
59-
The resulting `mongocli` binary is placed in `./bin`.
60-
61-
#### Install
62-
63-
To install the `mongocli` binary in `$GOPATH/bin`, run:
64-
65-
```bash
66-
make install
67-
```
68-
69-
**Note:** running `make build` is not needed when running `make install`.
70-
71-
## Usage
72-
73-
Run `mongocli help` for a list of available commands
74-
or check our [online documentation](https://docs.mongodb.com/mongocli/master/) for more details.
75-
76-
### Getting API Keys
77-
78-
To use `mongocli` you'll need to get API keys, to get them follow the documentation
79-
appropriate for the service you're using,
80-
[Atlas](https://docs.atlas.mongodb.com/configure-api-access/),
81-
[Ops Manager](https://docs.opsmanager.mongodb.com/current/tutorial/configure-public-api-access/),
82-
or [Cloud Manager](https://docs.cloudmanager.mongodb.com/tutorial/manage-programmatic-api-keys/)
83-
84-
### Configuring `mongocli`
85-
86-
Run `mongocli config` to set up your credentials,
87-
this is optional, you can use [env variables](https://docs.mongodb.com/mongocli/stable/configure/environment-variables/) instead.
88-
89-
If you're working with Atlas Gov, Ops Manager or Cloud Manager you need to define the service using `--service`
90-
91-
For Atlas Gov, `mongocli config --service cloudgov`.
92-
93-
For Ops Manager, `mongocli config --service ops-manager`.
94-
95-
For Cloud Manager, `mongocli config --service cloud-manager`.
96-
97-
### Shell Completions
98-
99-
If you install via [homebrew](#hombrew-on-macos) no additional actions are needed.
100-
101-
To get specific instructions for your preferred shell run:
102-
103-
```bash
104-
mongocli completion <bash|zsh|fish|powershell> --help
105-
```
106-
10712
## Contributing
10813

10914
See our [CONTRIBUTING.md](CONTRIBUTING.md) guide.
11015

11116
## License
11217

113-
MongoDB CLI is released under the Apache 2.0 license. See [LICENSE](LICENSE)
18+
MongoDB CLI and Atlas CLI are released under the Apache 2.0 license. See [LICENSE](LICENSE)

‎atlascli.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Atlas CLI (Pre-Release)
2+
3+
The MongoDB Atlas CLI is a modern command line interface that enables you to manage MongoDB Atlas from the terminal.
4+
5+
![atlascli-atlas-quickstart](https://user-images.githubusercontent.com/5663078/156184669-57c8ddce-6f0a-4e84-9311-2d996cb27942.gif)
6+
7+
## Installing
8+
9+
Atlas CLI is currently in the pre-release phase. Do not use it in a production environment.
10+
11+
### Pre-built Binaries
12+
13+
Download the appropriate version for your platform from [Atlas CLI releases](https://github.com/mongodb/mongocli/releases).
14+
After you download the library, you can run it from anywhere and don't need to install it into a global location.
15+
This works well for shared hosts and other systems where you don't have a privileged account.
16+
17+
You can place this binary somewhere in your `PATH` for ease of use.
18+
`/usr/local/bin` is the most probable location.
19+
20+
### Build From Source
21+
22+
#### Fetch Source
23+
24+
```bash
25+
git clone https://github.com/mongodb/mongocli.git
26+
cd mongocli
27+
```
28+
29+
#### Build
30+
31+
To build `atlascli`, run:
32+
33+
```bash
34+
make build-atlascli
35+
```
36+
37+
The resulting `atlas` binary is placed in `./bin`.
38+
39+
#### Install
40+
41+
To install the `atlas` binary in `$GOPATH/bin`, run:
42+
43+
```bash
44+
make install-atlascli
45+
```
46+
47+
**Note:** running `make build-atlascli` is not needed when running `make install-atlascli`.
48+
49+
50+
## Usage
51+
52+
To get a list of available commands, run `atlas help`
53+
or check our documentation for more details.
54+
55+
### Configuring Atlas CLI
56+
To use `atlascli`, open your terminal, run `atlas auth login`, and follow the prompted steps.
57+
58+
### Shell Completions
59+
60+
If you install via [homebrew](#hombrew-on-macos) no additional actions are needed.
61+
62+
To get specific instructions for your preferred shell, run:
63+
64+
```bash
65+
atlas completion <bash|zsh|fish|powershell> --help
66+
```

‎mongocli.md‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# MongoDB CLI
2+
3+
The MongoDB CLI is a modern command line interface that enables you to manage your MongoDB services from the terminal.
4+
5+
![mongocli-atlas-quickstart](https://user-images.githubusercontent.com/461027/126986233-0dd5c82a-2c75-4887-ab66-eb018c59e093.gif)
6+
7+
Use simple, one-line commands to interact with MongoDB Atlas, Cloud Manager, or Ops Manager, and automate management tasks for your deployments.
8+
9+
## Documentation
10+
11+
See the [official docs](https://docs.mongodb.com/mongocli/stable/) for instructions on how to
12+
install, set up, and reference available commands.
13+
14+
## Installing
15+
16+
### Homebrew on macOS
17+
18+
```bash
19+
brew install mongocli
20+
```
21+
22+
### Pre-built Binaries
23+
24+
Download the appropriate version for your platform from [mongocli releases](https://github.com/mongodb/mongocli/releases).
25+
After you download the library, you can run it from anywhere and don't need to install it into a global location.
26+
This works well for shared hosts and other systems where you don't have a privileged account.
27+
28+
You can place this binary somewhere in your `PATH` for ease of use.
29+
`/usr/local/bin` is the most probable location.
30+
31+
### Build From Source
32+
33+
#### Fetch Source
34+
35+
```bash
36+
git clone https://github.com/mongodb/mongocli.git
37+
cd mongocli
38+
```
39+
40+
#### Build
41+
42+
To build `mongocli`, run:
43+
44+
```bash
45+
make build
46+
```
47+
48+
The resulting `mongocli` binary is placed in `./bin`.
49+
50+
#### Install
51+
52+
To install the `mongocli` binary in `$GOPATH/bin`, run:
53+
54+
```bash
55+
make install
56+
```
57+
58+
**Note:** running `make build` is not needed when running `make install`.
59+
60+
## Usage
61+
62+
To get a list of available commands, run `mongocli help`
63+
or check our [documentation](https://docs.mongodb.com/mongocli/master/) for more details.
64+
65+
### Configuring MongoCLI with Atlas
66+
To use `mongocli` with Atlas, open your terminal, run `mongocli auth login`, and follow the prompted steps.
67+
68+
### Configuring MongoCLI with Ops Manager and Cloud Manager
69+
70+
#### Getting API Keys (Ops manager / Cloud Manager)
71+
To use `mongocli`, create API keys. To learn more, see the documentation for the service you're using:
72+
- [Atlas](https://docs.atlas.mongodb.com/configure-api-access/),
73+
- [Ops Manager](https://docs.opsmanager.mongodb.com/current/tutorial/configure-public-api-access/),
74+
- [Cloud Manager](https://docs.cloudmanager.mongodb.com/tutorial/manage-programmatic-api-keys/)
75+
76+
#### Set up your credentials
77+
To set up your credentials, run `mongocli config`, or use [env variables](https://docs.mongodb.com/mongocli/stable/configure/environment-variables/) instead.
78+
79+
If you're working with Atlas Gov, Ops Manager or Cloud Manager you need to define the service using `--service`
80+
81+
- For Atlas Gov, `mongocli config --service cloudgov`
82+
- For Ops Manager, `mongocli config --service ops-manager`
83+
- For Cloud Manager, `mongocli config --service cloud-manager`
84+
85+
### Shell Completions
86+
87+
If you install via [homebrew](#hombrew-on-macos) no additional actions are needed.
88+
89+
To get specific instructions for your preferred shell, run:
90+
91+
```bash
92+
mongocli completion <bash|zsh|fish|powershell> --help
93+
```

0 commit comments

Comments
 (0)