kubectl-fuzzy - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #typescript #machine-learning #deep-learning #nodejs #java #awesome #cli #kubernetes #awesome-list #vue #pytorch #open-source

kubectl-fuzzy

(★ 167)

This tool uses fzf(1)-like fuzzy-finder to do partial or fuzzy search of Kubernetes resources. Instead of specifying full resource names to kubectl commands, you can choose them from an interactive list that you can filter by typing a few characters.

File Explorer

Download Latest Version (.zip)

- - goreleaser.yaml
  - main.yaml
- dependabot.yml
- RELEASE_NOTE_TEMPALTE.md
- - main.go
- - kubectl-fuzzy.gif
  - preview.jpg
- commands.md
- - create.go
  - create_job.go
  - delete.go
  - describe.go
  - exec.go
  - logs.go
  - root.go
  - version.go
- - fuzzyfinder.go
- - kubernetes.go
- - simplify.go
.gitignore
.goreleaser.yaml
CHANGELOG.md
go.mod
go.sum
LICENSE
Makefile
README.md

# Installation Guide

1. Get the code

git clone https://github.com/d-kuro/kubectl-fuzzy

Downloads the entire project code from GitHub to your computer.

cd kubectl-fuzzy

Moves into the project folder you just downloaded.

2. Go

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

3. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make install

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# kubectl-fuzzy

![](https://github.com/d-kuro/kubectl-fuzzy/workflows/main/badge.svg)

Fuzzy and partial string search for kubectl

![](https://raw.githubusercontent.com/d-kuro/kubectl-fuzzy/main/docs/assets/kubectl-fuzzy.gif)

## Summary

This tool uses [fzf(1)](https://manpages.debian.org/unstable/fzf/fzf.1.en.html)-like fuzzy-finder to do partial or fuzzy search of Kubernetes resources.
Instead of specifying full resource names to kubectl commands,
you can choose them from an interactive list that you can filter by typing a few characters.

> 📝 Notes
>
> kubectl >= v1.12.0 is required for plugins to work.
>
> For more information on kuberctl plugins see [documentation](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/)

## Install

### Krew

[Krew](https://krew.sigs.k8s.io/) is the plugin manager for kubectl command-line tool.

> 📝 See the [documentation](https://krew.sigs.k8s.io/docs/user-guide/setup/install/) for how to install Krew.

```shell
kubectl krew update
kubectl krew install fuzzy
```

### Manually

Please download the binaries from the [release page](https://github.com/d-kuro/kubectl-fuzzy/releases).

or

```shell
git clone https://github.com/d-kuro/kubectl-fuzzy.git
cd kubectl-fuzzy
make install
```

## Usage

```console
$ kubectl fuzzy -h
Fuzzy Finder kubectl

Usage:
  kubectl-fuzzy
  kubectl-fuzzy [command]

Available Commands:
  create      Create a resource
  delete      Selecting an object with the fuzzy finder and delete
  describe    Selecting an object with the fuzzy finder and show details
  exec        Selecting a Pod with the fuzzy finder and execute a command in a container
  help        Help about any command
  logs        Selecting a Pod with the fuzzy finder and view the log
  version     Show version

Use "kubectl-fuzzy [command] --help" for more information about a command.
```

## Support Commands

* [x] `kubectl logs`
* [x] `kubectl exec`
* [x] `kubectl describe`
* [x] `kubectl create job --from=cronjob`
* [x] `kubectl delete`
* anything else...

> 📝 See the [documentation](./docs/commands.md) for support commands.

## Preview Mode

![](https://raw.githubusercontent.com/d-kuro/kubectl-fuzzy/main/docs/assets/preview.jpg)

You can use the `--preview` or `-P` option to display a YAML of the Kubernetes object in a fuzzy finder selector.
Or you can use environment variables. `KUBE_FUZZY_PREVIEW_ENABLED=true`
You can switch the display to YAML or JSON with the `--preview-format` option.

e.g.

```shell
kubectl fuzzy describe deployment --preview
or
kubectl fuzzy describe deployment -P
```

The Kubernetes object displayed in the preview window is simplified by default.
Some metadata and statuses have been removed.
Use the `--raw-preview` option to display the unsimplified object.