From c56c8d601402f91fcb078f20b5fcb0c791bd8c15 Mon Sep 17 00:00:00 2001 From: Saurabh Kumar Singh Date: Sat, 14 Feb 2026 23:47:37 +0530 Subject: [PATCH] docs: clarify krel install locations + go install Signed-off-by: Saurabh Kumar Singh --- docs/krel/README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/krel/README.md b/docs/krel/README.md index 409660458ea..6a6327e49f1 100644 --- a/docs/krel/README.md +++ b/docs/krel/README.md @@ -15,24 +15,36 @@ Kubernetes Releases. This includes manually executed tasks like generating the R ## Installation -Either download the latest version of `krel` by using the `hack/get-krel` script: +Choose one of the following options: + +**Repo-local (binary in `./bin/krel`):** ```shell ./hack/get-krel ``` -Or compile `krel` by running the `compile-release-tools` script from the root of this repo: +Use `./bin/krel` or add `./bin` to your `PATH`. + +**Build from source (binary in `./bin/krel`):** ```shell ./compile-release-tools krel ``` -Or run the following command in the terminal: +**Go install (binary in your Go bin directory):** ```shell go install k8s.io/release/cmd/krel@latest ``` +This installs to `$(go env GOBIN)` (or `$(go env GOPATH)/bin` when `GOBIN` is unset). +Add that directory to your `PATH` if needed: + +```shell +export PATH="$PATH:$(go env GOBIN):$(go env GOPATH)/bin" +``` + +Note: Examples below assume `krel` is on your `PATH`. For repo-local installs, use `./bin/krel`. ## Usage: krel has several subcommands that perform various tasks during the release lifecycle: