{"id":30221034,"url":"https://github.com/iron-e/kzf","last_synced_at":"2026-04-13T17:32:07.301Z","repository":{"id":307194249,"uuid":"1022352943","full_name":"Iron-E/kzf","owner":"Iron-E","description":"fzf-powered Kubernetes TUI","archived":false,"fork":false,"pushed_at":"2025-08-06T00:03:53.000Z","size":72,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":0,"default_branch":"trunk","last_synced_at":"2025-08-06T02:20:54.531Z","etag":null,"topics":["bash","bash-script","fzf","fzf-interface","fzf-scripts","fzf-wrapper","k8s","kubernetes","kubernetes-monitoring","nix-flake","shell","shell-script","terminal-based","terminal-ui","tui"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Iron-E.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-18T22:46:43.000Z","updated_at":"2025-08-06T00:03:47.000Z","dependencies_parsed_at":"2025-07-30T00:56:02.780Z","dependency_job_id":"02f59d24-7fa4-4b26-972a-253878ce3676","html_url":"https://github.com/Iron-E/kzf","commit_stats":null,"previous_names":["iron-e/kzf"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/Iron-E/kzf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Iron-E%2Fkzf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Iron-E%2Fkzf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Iron-E%2Fkzf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Iron-E%2Fkzf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Iron-E","download_url":"https://codeload.github.com/Iron-E/kzf/tar.gz/refs/heads/trunk","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Iron-E%2Fkzf/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270400153,"owners_count":24577110,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-14T02:00:10.309Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","bash-script","fzf","fzf-interface","fzf-scripts","fzf-wrapper","k8s","kubernetes","kubernetes-monitoring","nix-flake","shell","shell-script","terminal-based","terminal-ui","tui"],"created_at":"2025-08-14T09:48:41.589Z","updated_at":"2026-04-13T17:32:07.295Z","avatar_url":"https://github.com/Iron-E.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# kzf\n\n`kzf` is an fzf-powered Kubernetes TUI.\n\n\u003cdetails\u003e\u003csummary\u003ePreview\u003c/summary\u003e\n\n\u003cimg width=\"1887\" height=\"471\" alt=\"cap\" src=\"https://github.com/user-attachments/assets/2c4de5e8-6b59-4db1-a6d5-6038048945e1\" /\u003e\n\nTODO: add gif\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eMotivation\u003c/summary\u003e\n\n`kubectl` is a very useful tool.\n\nWhile iterating on new services in Kubernetes, though, its verbosity\nadds a noticeable \"navigation\" cost to inspecting the state of the cluster.\nThis is especially apparent when drilling into problems that a service may be experiencing.\n\nShell aliases help ([I have many](https://github.com/Iron-E/dotfiles/blob/594b9a383be9907ba3fcee7f333fca32cc277681/home-manager/hosts/_extras_/programs%2Bservices/ctl/kubectl/shell.nix)),\nbut do little when inspecting resources that have dynamic names (e.g. `Pod`s attached to `ReplicaSet`s).\n\nA shell's autocomplete could then, in theory, further reduce the navigation cost.\nHowever, a slow connection to the cluster will end up adding more to the navigation\ncost than it saves.\n\n[k9s] is a good solution to this problem, however, [its issues with MFA](https://github.com/derailed/k9s/issues/2048)\nprevent those in many corporate environments from using it.\n\nAfter seeing what `fzf` could do via [`fzf-lua`](https://github.com/ibhagwan/fzf-lua),\nthe idea for a new Kubernetes TUI, powered by `fzf` arose.\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eGoals\u003c/summary\u003e\n\n`kzf` is not a replacement or substitute for `kubectl`.\n\nThis project aims to optimize the processes of:\n\n- inspecting the current state of resources in a cluster.\n- comparing the state of resources across `--context`s and `--namespace`s.\n\nThis project does not aim to be a substitute/replacement for:\n\n- `kubectl`\n\n\tNot all features of `kubectl` will be implemented.\n\n\t`kubectl` features unrelated to resource inspection/debugging\n\t(or those which are difficult/unfit to implement with `fzf`)\n\tare unlikely to be implemented.\n\n\tThe following is an inexhaustive list of unsupported features:\n\n\t- Non-resource inspection: `annotate`, `apply`, `auth`, `diff`, `explain`, `kustomize`, `label`, `replace`, `scale`, `taint`\n\t- Difficult interface (PR welcome): `debug`, `port-forward`\n- An observability stack.\n\n\t`kzf` provides no special mechanism to show how the history of a cluster contributed to its current state.\n\n\u003c/details\u003e\n\n## Features\n\n- Attaching to containers\n- Colors (via [`kubecolor`])\n- Deleting resources (w/ confirmation)\n- Describing resources\n- Executing commands in containers\n- Fuzzy selection (via [`fzf`])\n- Restarting rollouts\n- Showing resource YAML\n- Switching contexts \u0026 namespaces\n- Viewing logs\n- Watching resources (live views)\n\n## Installation\n\n### Manual\n\n**Requirements:**\n\n- [`bash`]\n- [`curl`]\n- [`fzf`]\n- [`getopt`][util-linux]\n- [`kubectl`]\n- A `$PAGER`\n\nClone this repository and copy [src/kzf.sh](./src/kzf.sh) to any location in your `$PATH`.\n\n### Nix Flake\n\n\u003e [!TIP]\n\u003e\n\u003e You can try `kzf` without changing any Nix configuration:\n\u003e\n\u003e ```sh\n\u003e # run kzf\n\u003e nix run github:Iron-E/kzf\n\u003e\n\u003e # enter a temporary shell with kzf installed\n\u003e nix shell github:Iron-E/kzf\n\u003e ```\n\n**Requirements:**\n\n- A `$PAGER`\n\nAdd `kzf` to your flake inputs:\n\n```nix\n{\n  # ...\n  inputs = {\n    # ...\n\n    kzf.url = \"github:Iron-E/kzf\";\n\n    # ...\n  };\n\n  outputs = inputs@{ ... }: {\n    # ...\n  };\n}\n```\n\nThen, you can reference `kzf` in `outputs` as `inputs.kzf.packages.\u003cSYSTEM\u003e.default` (e.g. `inputs.kzf.packages.\"x86_64-linux\".default`.\n\n## Usage\n\n\u003e [!NOTE]\n\u003e\n\u003e `kzf` can integrate with the following tools:\n\u003e\n\u003e - [`kubecolor`]\n\u003e - [`tspin`] (tailspin)\n\u003e - [`viddy`]\n\u003e - [`zellij`]\n\nSee `kzf -h` for help information, and press F1 while inside `kzf` to see a list of keyboard shortcuts.\n\n## Configuration\n\nThere is no built-in configuration mechanism for `kzf`. Instead, one may use e.g. aliases.\n\n## Contributing\n\nThe [nix flake](./flake.nix) contains a developer environment.\nThis environment configures pre-commit hooks and vendors dev dependencies.\n\nPlease try to use it when contributing to the project.\n\n## Similar Projects\n\n- [`k9s`]\n- [`kdash`]\n\n[`bash`]: https://cgit.git.savannah.gnu.org/cgit/bash.git/\n[`curl`]: https://curl.se/\n[`fzf`]: https://github.com/junegunn/fzf\n[`k9s`]: https://github.com/derailed/k9s\n[`kdash`]: https://github.com/kdash-rs/kdash\n[`kubecolor`]: https://github.com/kubecolor/kubecolor\n[`kubectl`]: https://kubernetes.io/docs/tasks/tools/\n[`tspin`]: https://github.com/bensadeh/tailspin\n[`viddy`]: https://github.com/sachaos/viddy\n[`zellij`]: https://github.com/zellij-org/zellij\n[util-linux]: https://github.com/util-linux/util-linux\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firon-e%2Fkzf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Firon-e%2Fkzf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firon-e%2Fkzf/lists"}