{"id":14155303,"url":"https://github.com/kui-shell/KuiClientTemplate","last_synced_at":"2025-08-06T01:30:56.123Z","repository":{"id":39969275,"uuid":"216923182","full_name":"kui-shell/KuiClientTemplate","owner":"kui-shell","description":"Use this template to make your own custom graphical terminal, via the Kui Grahpical CLI Framework","archived":false,"fork":false,"pushed_at":"2023-04-06T17:11:22.000Z","size":1402,"stargazers_count":30,"open_issues_count":1,"forks_count":8,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-07-23T01:12:18.944Z","etag":null,"topics":["electron","krew","krew-plugin","kubectl","kubectl-plugins","kubernetes","kui","visualization"],"latest_commit_sha":null,"homepage":"https://github.com/kubernetes-sigs/kui","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kui-shell.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-10-22T22:49:21.000Z","updated_at":"2023-11-02T02:20:10.000Z","dependencies_parsed_at":"2024-01-14T04:42:13.974Z","dependency_job_id":"da542ee1-7344-4a58-b1ff-cd8f4dfe63c9","html_url":"https://github.com/kui-shell/KuiClientTemplate","commit_stats":null,"previous_names":["kui-shell/plugin-kubeui"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kui-shell%2FKuiClientTemplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kui-shell%2FKuiClientTemplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kui-shell%2FKuiClientTemplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kui-shell%2FKuiClientTemplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kui-shell","download_url":"https://codeload.github.com/kui-shell/KuiClientTemplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228787220,"owners_count":17972274,"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":["electron","krew","krew-plugin","kubectl","kubectl-plugins","kubernetes","kui","visualization"],"created_at":"2024-08-17T08:02:46.862Z","updated_at":"2024-12-09T02:31:14.567Z","avatar_url":"https://github.com/kui-shell.png","language":"TypeScript","funding_links":[],"categories":["visualization"],"sub_categories":[],"readme":"# Client Template for the Kui Graphical CLI Framework\n\n[Kui](https://github.com/kubernetes-sigs/kui) is a framework for\nextending CLIs with graphical enhancements.  If you wish to extend the\nframework, either by adding custom commands, custom views, or custom\ntheming, this is the place to start!\n\nThis repository offers a few silly animal-oriented commands and views,\nincluding a way to decorate Kubernetes resources with additional tabs.\n\n## Getting Started with Development\n\n```sh\nnpm ci\nnpm run watch\n```\n\nThis will spawn the Webpack watcher. Once it has finished loading, you\nmay open a Kui window via `npm run open`. If this works, you are all\nset for developing your Kui-based magic.\n\n## Details of the customizations in this client\n\nThis [wiki](https://github.com/kubernetes-sigs/kui/wiki) introduces\nthe ways in which this application enhances Kui. In particular, this\nclient extends Kui with:\n\n\u003cimg src=\"docs/images/cattab.png\" align=\"right\" width=\"350\" title=\"Showing the Kubernetes decorations\"\u003e\n\n- Decorations for Kubernetes resources: a `Cat` tab, a 🐶 button, and a 🐱 badge (shown in the upper right with a green background).\n\n- A set of\n  [commands](plugins/plugin-example/src/commands)\n  that use Kui's built-in views. [More info](https://github.com/kubernetes-sigs/kui/wiki#approaches-for-enhancing-kui)\n  - `hello cat` and `hello dog` are simple hello worlds that returns a cat and dog emoji, respectively\n  - `hello sidenav` and `hello catnav` which show how to use the multi-tab \"sidecar\" views, with tabs on top\n     and tabs on the left, respectively\n\n\u003cimg src=\"docs/images/catdogwidget.gif\" align=\"right\" width=\"350\" title=\"Showing the CatDogWidget StatusStripe widget\"\u003e\n\n- A [StatusStripe widget](plugins/plugin-example/src/view/CatDogWidget.tsx) that will be placed along the bottom of the Kui window. [More info](https://github.com/kubernetes-sigs/kui/wiki#approaches-for-enhancing-kui)\n\n### More Documentation on Extending Kui\n\n- [Kui Command Documentation](https://github.com/kubernetes-sigs/kui/wiki/1.-Commands) and [Terminal View Documentation](https://github.com/kubernetes-sigs/kui/wiki/2a.-Terminal-View) uses the [string](plugins/plugin-example/src/view/string), [boolean](plugins/plugin-example/src/view/boolean), and [table](plugins/plugin-example/src/view/table) view as examples of Terminal-oriented command response.\n\n- [TopNavSidecar View Documentation](https://github.com/kubernetes-sigs/kui/wiki/2b.-TopNavSidecar-View) uses [this](plugins/plugin-example/src/view/mmr-example.ts) as an example of TopNavSidecar-oriented command response.\n\n- [LeftNavSidecar View Documentation](https://github.com/kubernetes-sigs/kui/wiki/2c.-LeftNavSidecar-View) uses [this](plugins/plugin-example/src/view/nav-example.ts) as an example of LeftNavSidecar-oriented command response.\n\n## Building for Production: Electron Double-clickables\n\nIf you want to build and distribute your own double-clickable\nElectron-based clients, then use one of these commands, after which\nyour clients will be placed in `./dist/electron`.\n\n```sh\nnpm run build:electron:all # does all of the following...\nnpm run build:electron:mac:amd64\nnpm run build:electron:mac:arm64\nnpm run build:electron:linux:amd64\nnpm run build:electron:linux:arm64\nnpm run build:electron:windows:amd64\n```\n\n## Building for Production: Hosted Web App\n\nTo build a hosted version of Kui, running in a Docker container, use\nthis command:\n\n```sh\nnpx kui-build-docker-with-proxy\n```\n\nThis will generate a Docker image `kui-shell/kui`. To test this\nproduction web app, you can use the script `npx kui-run-cproxy`, and\nthen visit `http://localhost:9080`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkui-shell%2FKuiClientTemplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkui-shell%2FKuiClientTemplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkui-shell%2FKuiClientTemplate/lists"}