zrun

_ _ . . . _ . . . _ _ .

zrun is a comprehensive command-line interface (CLI) that provides a range of functionalities from installing k3s, managing Helm Deployments & Argocd applications to Git operations and more...

Install

curl -sfL https://raw.githubusercontent.com/zcubbs/zrun/main/scripts/install/install.sh | bash

Demo

Available Commands

about - Print the info about ZRun
argo - ArgoCD Commands
awx - AWX Management Commands
certmanager - cert-manager Commands
completion - Generate the autocompletion script for the specified shell
config - List CLI configuration
git - Git Helper Commands
hello - Used for test purposes
helm - Helm Application Deployment/Control Commands
help - Help about any command
info - A palette that contains system info commands
k3s - K3s management commands
k8s - Kubernetes Management Commands
k9s - Run K9s
os - OS Helper Commands
traefik - traefik Commands
upgrade - Used to upgrade ZRun to the latest version
vault - Vault Helper Commands
version - Print the version number of ZRun

Global Flags

-h, --help - Help for this command
-v, --verbose - Verbose output

Sub-Commands

k3s - K3s management commands
- Usage: k3s [flags] or k3s [command]
- Available Sub-Commands:
  - install - Install k3s
  - uninstall - Uninstall k3s
argo - ArgoCD Commands
- Usage: argo [flags] or argo [command]
- Available Sub-Commands:
  - add-application - Manage ArgoCD Applications
  - add-project - Add project to ArgoCD
  - add-repository - Add repository to ArgoCD
  - install - Install argo-cd Chart
- Flags:
  - -n, --namespace string - Namespace (default "argo-cd")
certmanager - cert-manager Commands
- Usage: certmanager [flags] or certmanager [command]
- Available Sub-Commands:
  - install - Install cert-manager Chart
  - issuer - Setup cert-manager issuer
traefik - traefik Commands
- Usage: traefik [flags] or traefik [command]
- Available Sub-Commands:
  - ingressroute - Create IngressRoute
  - install - Install traefik Chart
helm - Helm Application Deployment/Control Commands
- Usage: helm [flags] or helm [command]
- Available Sub-Commands:
  - install-chart - List all helm releases
  - install-helm - Install helm CLI
  - list - List all helm releases
  - uninstall-chart - List all helm releases

Contributing

If you want to contribute to this project, please read the contributing guidelines.

Pre-requisites

Go 1.20 or later
Docker: (depending on OS)
- Docker 20.10 or later
- Docker Compose 1.29 or later
- Rancher Desktop 0.6.0 or later
GNU Make 4.3 or later
GNU Bash 5.1 or later
GoSec
- go install github.com/securego/gosec/v2/cmd/gosec@latest
golangci-lint 1.42 or later
- go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
Cobra CLI 1.2 or later
- go install github.com/spf13/cobra-cli@latest
Virtual Machines:
- Windows
  - VirtualBox 6.1 or later
  - Vagrant 2.2 or later
- MacOS
  - Lima 0.6.0 or later
  - nerdctl 0.12.0 or later

Tooling

Lint

make lint

Test

make test

Cobra

Extending the command line:

cobra-cli add <command>

Vagrant

Spin up a local Ubuntu VM (with a builtin zrun binary for testing:

make vssh

License

Apache 2.0