Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d-kuro/kubectl-fuzzy
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.
https://github.com/d-kuro/kubectl-fuzzy
go golang kubectl kubectl-plugin kubectl-plugins kubernetes
Last synced: 3 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/d-kuro/kubectl-fuzzy
- Owner: d-kuro
- License: apache-2.0
- Created: 2020-06-14T00:42:59.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-18T15:29:37.000Z (8 months ago)
- Last Synced: 2024-06-18T22:54:40.008Z (5 months ago)
- Topics: go, golang, kubectl, kubectl-plugin, kubectl-plugins, kubernetes
- Language: Go
- Homepage:
- Size: 3.75 MB
- Stars: 154
- Watchers: 3
- Forks: 13
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# kubectl-fuzzy
Fuzzy and partial string search for kubectl
## 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
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.