mirror of https://github.com/foomo/squadron.git synced 2026-06-01 17:10:09 +00:00

Files

Kevin Franklin Kim dba3bf6a42 docs: initial docs

2026-05-27 22:51:08 +02:00

1.6 KiB

Raw Permalink Blame History

title

title
Installation

Installation

Squadron is a single Go binary. Pick whichever method fits your workflow.

Prerequisites

Squadron shells out to the standard toolchain, so make sure these are available on your PATH:

helm — chart install / upgrade / diff / rollback
docker (with buildx) — image builds and bakes
kubectl — access to your cluster

Install with `go install`

go install github.com/foomo/squadron/cmd/squadron@latest

This installs the squadron binary into $GOPATH/bin.

Download a release binary

Pre-built binaries for Linux, macOS, and Windows are attached to every GitHub release. Download the archive for your platform, extract it, and move squadron onto your PATH.

Docker image

docker run --rm foomo/squadron version

Images are published to Docker Hub.

From source

git clone https://github.com/foomo/squadron.git
cd squadron
make install   # builds and installs to $GOPATH/bin

This repository uses mise to pin tool versions (Go, golangci-lint, lefthook, bun, biome); run mise install once to match them.

Verify

squadron version

Shell completion

Squadron can generate completion scripts for bash, zsh, fish, and PowerShell:

squadron completion zsh > "${fpath[1]}/_squadron"

See squadron completion for the other shells.

1.6 KiB Raw Permalink Blame History