{"id":13564704,"url":"https://github.com/kubernetes-sigs/kui","last_synced_at":"2026-01-12T00:57:46.558Z","repository":{"id":36984317,"uuid":"159242360","full_name":"kubernetes-sigs/kui","owner":"kubernetes-sigs","description":"A hybrid command-line/UI development experience for cloud-native development","archived":false,"fork":false,"pushed_at":"2025-03-29T04:41:18.000Z","size":90318,"stargazers_count":2887,"open_issues_count":6,"forks_count":185,"subscribers_count":35,"default_branch":"master","last_synced_at":"2025-04-08T22:35:35.656Z","etag":null,"topics":["cli","dashboard","electron","kubectl","kubernetes","plugin","ui","visualization","visualizations"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kubernetes-sigs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-26T22:39:03.000Z","updated_at":"2025-04-08T18:49:03.000Z","dependencies_parsed_at":"2024-12-24T17:06:55.055Z","dependency_job_id":"0de851ae-25c1-4fd9-ab4c-4024e36415b4","html_url":"https://github.com/kubernetes-sigs/kui","commit_stats":{"total_commits":4860,"total_committers":34,"mean_commits":"142.94117647058823","dds":0.1845679012345679,"last_synced_commit":"7ff787d6193a9d47adf82c32304301157a072902"},"previous_names":["ibm/kui"],"tags_count":1078,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubernetes-sigs%2Fkui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubernetes-sigs%2Fkui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubernetes-sigs%2Fkui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubernetes-sigs%2Fkui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kubernetes-sigs","download_url":"https://codeload.github.com/kubernetes-sigs/kui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248201925,"owners_count":21064224,"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","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":["cli","dashboard","electron","kubectl","kubernetes","plugin","ui","visualization","visualizations"],"created_at":"2024-08-01T13:01:34.682Z","updated_at":"2025-04-10T10:47:17.550Z","avatar_url":"https://github.com/kubernetes-sigs.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","HarmonyOS","Uncategorized","electron","cli"],"sub_categories":["Windows Manager","Uncategorized"],"readme":"[![GitHub Stars](https://badgen.net/github/stars/IBM/kui)](https://github.com/IBM/kui/stargazers)\n[![GitHub Forks](https://badgen.net/github/forks/IBM/kui)](https://github.com/IBM/kui/network/members)\n![ts](https://flat.badgen.net/badge/-/TypeScript?icon=typescript\u0026label\u0026labelColor=blue\u0026color=555555)\n![Electron](https://flat.badgen.net/badge/Electron/22/orange)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)\n[![test](https://github.com/kubernetes-sigs/kui/actions/workflows/test.yaml/badge.svg)](https://github.com/kubernetes-sigs/kui/actions/workflows/test.yaml)\n\n[**Blogs**](https://medium.com/the-graphical-terminal) **|** [**PDF Summary**](docs/presentations/kui-cloudnative-devx-2021.pdf) **|** [**Installation**](#install) **|** [**API**](docs/api/README.md) **|** [**Custom Graphical CLIs**](#custom)\n\n# Kui: a Framework for Enhancing CLIs with Graphics\n\n\u003cimg width=\"600\" align=\"right\" src=\"docs/readme/images/kui-experience.gif\"\u003e\n\nWe love CLIs, and think they are critical for interacting in a\nflexible way with the cloud. We need the power to go off the\nrails. But ASCII is tedious.\n\nKui takes your normal `kubectl` command line requests and **responds\nwith graphics**. Instead of ASCII tables, you are presented with\nsortable ones. Instead of copying and pasting long auto-generated\nresource names, in Kui **you just click**.\n\nKui is also fast. It launches in seconds, and can process `kubectl`\ncommands **2-3 times faster** than `kubectl` itself.\n\n\u003cimg height=\"185\" src=\"docs/readme/images/grid-watch.gif\"\u003e\u003cimg height=\"185\" src=\"docs/readme/images/sequence-diagram.png\"\u003e\u003cimg height=\"185\" src=\"docs/readme/images/pod.png\"\u003e\n\n\u003e Help us make Kubernetes tools better by filling out a [quick 2\n\u003e minute survey](https://forms.gle/BMvpscU9Yi5Horp29) on your tool\n\u003e preferences. Thanks!\n\n\u003ca name=\"install\"\u003e\n\n## Installing Kui for Kubernetes\n\nWe offer prebuilt images optimized for an enhanced Kubernetes CLI\nexperience.\n\n\u003cimg width=\"575\" align=\"right\" src=\"docs/readme/images/minisplits.png\"\u003e\n\n#### MacOS (Intel and Apple Silicon)\n\n```bash\nbrew install kui\nkubectl kui get pods\nopen /Applications/Kui.app\n```\n\n#### Windows and Linux\n\n[Download and\nunzip](https://github.com/kubernetes-sigs/kui/releases/latest), then\nadd the unzipped directory to your PATH. Now use `kubectl kui` or\nlaunch the `Kui` executable to use Kui's built-in REPL.\n\n\u003e **Windows Warning**: Please use forward slashes for filepaths, e.g. c:/users, not c:\\users.\n\n#### I don't trust the prebuilts\n\nWe hear you. Choose your platform (e.g. `mac:amd64`), execute the\nfollowing, then look in `./dist/electron`.\n\n```sh\ngit clone git@github.com:kubernetes-sigs/kui.git \u0026\u0026 cd kui \u0026\u0026 npm ci \u0026\u0026 \\\n    npm run build:electron:mac:amd64\n```\n\n\u003ca name=\"custom\"\u003e\n\n## I Want to Make a Custom Graphical CLI\n\nKui is a framework for adding graphics to CLIs. Kui allows for either\na hosted client-server architecture, or the distribution of\ndouble-clickable applications (via [Electron](https://electronjs.org)).\n\nUsing the Kui framework, you can design your own Kubernetes\nenhancements, set a custom theme or custom icon, and enhance the\ncommands of your favorite CLI. Check out the [template\nrepo](https://github.com/kui-shell/KuiClientTemplate). If your\nenhancements would be generally valuable, please PR them back here,\ne.g. awesome Kubernetes enhancements can be integrated with the [core\nKubernetes plugin](plugins/plugin-kubectl).\n\n## Code of Conduct\n\nParticipation in the Kubernetes community is governed by the [Kubernetes Code\nof Conduct](https://github.com/kubernetes-sigs/krew/blob/master/code-of-conduct.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubernetes-sigs%2Fkui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkubernetes-sigs%2Fkui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubernetes-sigs%2Fkui/lists"}