Skip to content

gabor-boros/klue

klue

Kubernetes troubleshooting that explains why, not just what.

Documentation

Full documentation is published at gabor-boros.github.io/klue.

To build and preview locally: make docs-serve.

Installation

go install github.com/gabor-boros/klue@latest

or

brew install --cask gabor-boros/brew/klue

Or download a prebuilt binary from the releases page.

Usage

klue --help
klue version
klue why pod <name> -n <namespace>
klue why certificate <name> -n <namespace>

Development

Requires Go 1.26+. Run make help to list all available targets.

make build        # build the binary into ./bin
make run ARGS=... # run the CLI with arguments
make test         # run tests
make lint         # run golangci-lint
make fmt          # format the code
make ci           # tidy + vet + lint + race tests
make changelog    # regenerate CHANGELOG.md from git history

Tooling

This project uses pinned versions of the following tools:

Tool Version Purpose
GoReleaser v2.16.0 Build and publish releases
git-cliff v2.12.0 Changelog generation
golangci-lint v2.12.2 Linting and formatting
pre-commit 4.6.0 Git hook management

Install the Go-based tooling and set up git hooks:

make tools        # install golangci-lint, goreleaser, and git-cliff
make pre-commit   # install and run pre-commit hooks

Releasing

Releases are automated via GoReleaser and GitHub Actions. Push a semantic version tag to trigger a release:

git tag v0.1.0
git push origin v0.1.0

Validate the release configuration and build a local snapshot:

make release-check
make snapshot

Community

License

klue is licensed under the Apache License 2.0.

About

Kubernetes troubleshooting that explains why, not just what.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors