https://github.com/banzaicloud/banzai-cli
CLI for Banzai Cloud Pipeline platform
https://github.com/banzaicloud/banzai-cli
cli cloud helm kubernetes pipeline shell
Last synced: about 1 year ago
JSON representation
CLI for Banzai Cloud Pipeline platform
- Host: GitHub
- URL: https://github.com/banzaicloud/banzai-cli
- Owner: banzaicloud
- License: apache-2.0
- Created: 2018-11-22T08:14:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-24T23:14:06.000Z (over 3 years ago)
- Last Synced: 2025-03-27T07:48:03.382Z (about 1 year ago)
- Topics: cli, cloud, helm, kubernetes, pipeline, shell
- Language: Go
- Homepage:
- Size: 2.42 MB
- Stars: 30
- Watchers: 4
- Forks: 10
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This is a command-line interface for the [Banzai Cloud Pipeline](https://try.pipeline.banzai.cloud/) platform.
### Installation
Use the following command to quickly install the CLI:
```
$ curl https://getpipeline.sh | sh
```
The [script](scripts/getcli.sh) automatically chooses the best distribution package for your platform.
Available packages:
- [Debian package](https://banzaicloud.com/downloads/banzai-cli/latest?format=deb)
- [RPM package](https://banzaicloud.com/downloads/banzai-cli/latest?format=rpm)
- binary tarballs for [Linux](https://banzaicloud.com/downloads/banzai-cli/latest?os=linux) and [macOS](https://banzaicloud.com/downloads/banzai-cli/latest?os=darwin).
You can also select the installation method (one of `auto`, `deb`, `rpm`, `brew`, `tar` or `go`) explicitly:
```
$ curl https://getpipeline.sh | sh -s -- deb
```
On macOS, you can directly Homebrew:
```
$ brew install banzaicloud/tap/banzai-cli
```
Alternatively, fetch the source and compile it using `go get`:
```
$ go get github.com/banzaicloud/banzai-cli/cmd/banzai
```
### Logging in
To use the command you will have to log in.
You can either log in interactively using a web browser, or provide an API endpoint and a token manually.
For interactive login, just run `banzai login`, and follow the instructions given.
### Use
See [command reference](https://banzaicloud.com/docs/pipeline/cli/reference/) in the [official documentation](https://banzaicloud.com/docs/pipeline/cli/).
### Use Docker image
Logging in
```
$ docker run --rm -v $(PWD)/banzai-cli:/root/ ghcr.io/banzaicloud/banzai-cli login --token -e https://try.pipeine.banzai.cloud/pipeline
```
Select organization
```
$ docker run --rm -ti -v $(PWD)/banzai-cli:/root/ ghcr.io/banzaicloud/banzai-cli organization select
```
List clusters
```
$ docker run --rm -ti -v $(PWD)/banzai-cli:/root/ ghcr.io/banzaicloud/banzai-cli cluster list
```
Run cluster shell
```
$ docker run --rm -ti -v $(PWD)/banzai-cli:/root/ ghcr.io/banzaicloud/banzai-cli cluster shell
```