pvx

pvx is a fast CLI for generating and applying Kubernetes PersistentVolumeClaims.

Local development

make build
./bin/pvx version

Install once, use anywhere

make install
pvx version

This installs pvx into your GOPATH/bin (usually ~/go/bin).

Quick usage

pvx pvc create app-data --size 20Gi --storage-class standard
pvx pvc create cache --size 5Gi --apply
pvx pvc create logs --file pvc.yaml

Shell completions

# Bash (add to ~/.bashrc)
source <(pvx completion bash)

# Zsh (add to ~/.zshrc)
source <(pvx completion zsh)

# Fish
pvx completion fish | source

Doctor (kubectl / kubeconfig / cluster)

pvx doctor
pvx doctor --kubeconfig /path/to/config --context my-context

CI and release

• CI runs GoReleaser config validation, formatting check, vet, tests, and make build on pushes/PRs.
• Release uses GoReleaser on tags like v0.1.0: GitHub Release assets, checksums, and optional Homebrew formula generation.

Homebrew tap (optional)

.goreleaser.yaml includes a brews section with skip_upload: true so releases work without a tap repo. To publish updates to a tap:

1. Create a GitHub repository named homebrew-tap (or another tap name) under your user or org.
2. In .goreleaser.yaml, set homepage to your app repo URL, set brews[].repository.owner / name to the tap location, and set skip_upload: false.
3. Add a GitHub Actions secret HOMEBREW_TAP_GITHUB_TOKEN with repo scope on the tap repository (GoReleaser uses it to push the formula). The workflow already passes it as HOMEBREW_TAP_GITHUB_TOKEN; if your GoReleaser version expects a different env name, align with GoReleaser brew docs.
4. Tag and push: git tag v0.1.0 && git push origin v0.1.0

Then users can run:

brew tap YOUR_USER/homebrew-tap
brew install pvx