Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mongodb/mongodb-atlas-cli
MongoDB Atlas CLI and MongoDB CLI enable you to manage your MongoDB in the Cloud
https://github.com/mongodb/mongodb-atlas-cli
golang hacktoberfest infrastructure mongodb mongodb-atlas mongodb-cloud-manager mongodb-ops-manager
Last synced: about 1 month ago
JSON representation
MongoDB Atlas CLI and MongoDB CLI enable you to manage your MongoDB in the Cloud
- Host: GitHub
- URL: https://github.com/mongodb/mongodb-atlas-cli
- Owner: mongodb
- License: apache-2.0
- Created: 2020-01-28T12:54:33.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-12T09:55:55.000Z (3 months ago)
- Last Synced: 2024-08-12T12:16:14.683Z (3 months ago)
- Topics: golang, hacktoberfest, infrastructure, mongodb, mongodb-atlas, mongodb-cloud-manager, mongodb-ops-manager
- Language: Go
- Homepage: https://www.mongodb.com/docs/atlas/cli/stable/
- Size: 26.7 MB
- Stars: 160
- Watchers: 32
- Forks: 69
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-mongodb - MongoDB Atlas CLI - Official Atlas API command-line client (Tools / Shell)
README
## MongoDB Atlas CLI
The MongoDB Atlas CLI is a modern command line interface that enables you to manage MongoDB Atlas from the terminal.
## Installing
### Homebrew
```bash
brew install mongodb-atlas-cli
```
See [Install or Update the Atlas CLI](https://www.mongodb.com/docs/atlas/cli/current/install-atlas-cli/) to see all the installation methods available.
### Pre-built Binaries
Download the appropriate version for your platform from [Atlas CLI releases](https://github.com/mongodb/mongodb-atlas-cli/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/mongodb-atlas-cli.git
cd mongodb-atlas-cli
```
#### Build
To build `atlascli`, run:
```bash
make build
```
The resulting `atlas` binary is placed in `./bin`.
#### Install
To install the `atlas` 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 `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 --help
```
## Contributing
See our [CONTRIBUTING.md](CONTRIBUTING.md) guide.
## License
MongoDB Atlas CLI is released under the Apache 2.0 license. See [LICENSE](LICENSE)