Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uselagoon/lagoon-cli
A CLI for Lagoon - Docker Build and Deploy System for Kubernetes
https://github.com/uselagoon/lagoon-cli
hacktoberfest
Last synced: 2 months ago
JSON representation
A CLI for Lagoon - Docker Build and Deploy System for Kubernetes
- Host: GitHub
- URL: https://github.com/uselagoon/lagoon-cli
- Owner: uselagoon
- License: mit
- Created: 2019-04-23T17:52:09.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T04:55:20.000Z (10 months ago)
- Last Synced: 2024-04-13T16:13:07.430Z (10 months ago)
- Topics: hacktoberfest
- Language: Go
- Homepage: https://uselagoon.github.io/lagoon-cli
- Size: 8.43 MB
- Stars: 22
- Watchers: 13
- Forks: 16
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
## Lagoon CLI
[](https://pkg.go.dev/github.com/uselagoon/lagoon-cli)
[](https://github.com/uselagoon/lagoon-cli/actions/workflows/goreleaser.yaml)
[](https://github.com/uselagoon/lagoon-cli/actions/workflows/coverage.yaml)
[](https://goreportcard.com/report/github.com/uselagoon/lagoon-cli)
[](https://securityscorecards.dev/viewer/?uri=github.com/uselagoon/lagoon-cli)
[](https://www.bestpractices.dev/projects/9386)
This is a CLI for interacting with a [Lagoon](https://github.com/uselagoon/lagoon) instance. By default, it is configured
to work against [Amazee.io](https://www.amazee.io/) instances.
If you run the CLI in a directory that has a valid `.lagoon.yml` and `docker-compose.yml` that references your project in lagoon, then you don't need to specify your project name on the command line as the CLI can read these files to determine the project. You can still define a project name though if you want to target a different project.
## Install
The preferred method is installation via [Homebrew](https://brew.sh/).
```
brew tap uselagoon/lagoon-cli
brew install lagoon
```
Alternatively, you may install by downloading one of the pre-compiled binaries from the [releases page](https://github.com/uselagoon/lagoon-cli/releases)
If you are building from source, see the Build section below
### Usage
Once installed, to use the Lagoon CLI, run the following command
```
lagoon
```
### Commands
For the full list of commands see the docs for [Lagoon CLI](https://uselagoon.github.io/lagoon-cli/commands/lagoon/)
## Building
### Requirements
Install `Go` - https://go.dev/doc/install
You also need `mockgen`, it can be installed using the following command once `Go` is installed.
```
go install go.uber.org/mock/[email protected]
```
Note: You should make sure you have your `GOPATH` configured and in your path, see https://pkg.go.dev/cmd/go#hdr-GOPATH_environment_variable
### Run tests
```
make test
```
### Build locally
You can compile the binary and load it into your `GOPATH` bin directory using the following.
```
make build
```
Alternatively, these will compile a binary inside a `builds` directory in this repository, you can place them wherever you wish.
```
make build-linux
#macos
make build-darwin
make build-darwin-arm64
```
### Build using Docker
You can build lagoon-cli without installing `go` by running the `docker-build` make command. This will use the `Dockerfile.build` to build the cli inside of a docker container, then copy the binaries into the `builds/` directory once complete
```
make build-docker-darwin
make build-docker-linux
```
### Run all
```
make all #locally
make all-docker-linux
make all-docker-darwin
```
### Install
```
make ARTIFACT_DESTINATION=/usr/local/bin install-linux
make ARTIFACT_DESTINATION=/usr/local/bin install-darwin
```
### Notes
Versions can also be defined, and the binaries will be version tagged
```
make VERSION=v0.0.1 ...
```
### Acknowledgements
[Matt Glaman](https://github.com/mglaman) - Initial conception and development - Thanks Matt!