Awesome Open Source
Awesome Open Source
Sponsorship

The Kui Framework for Graphical Terminals

Build Status License codecov Type Coverage

Kui combines the power of familiar CLIs with visualizations in high-impact areas. Kui enables you to manipulate complex JSON and YAML data models, integrate disparate tooling, and provides quick access to aggregate views of operational data.

Installation

We offer prebuilt images that provide Kubernetes enhancements:

Kui-MacOS.tar.bz2 | Kui-Linux-x64.zip | Kui-Linux-arm64.zip | Kui-Win32-x64.zip

To run Kui as a kubectl plugin (for kubectl 1.12+). These distributions contain a kubectl-kui script that serves as a kubectl plugin for Kui. For Windows and Linux, add the unpacked directory to your PATH; for MacOS, the script is nested inside of the application:

curl -L https://macos-tarball.kui-shell.org/ | tar jxf -
export PATH=$PWD/Kui-darwin-x64/Kui.app/Contents/Resources:$PATH
kubectl kui get pods

After the final command, you should see a popup window listing pods in your current namespace.

You may also install Kui as an ibmcloud CLI plugin.

Contributing

If you want to help, please take a look at the developer guide and our guidelines.

Kui is a CLI, with Visualizations on the Side

To help with complex data, Kui offers a suite of visualizations. You can quickly flip between the terminal and these visualizations, without having to switch to a browser, log in, and navigate through complex menu structures.

Kui uses Electron to provide you with an augmented but CLI-focused development experience. You will have access to your filesystem and your favorite terminal and text editor. At the same time, one may offer a hosted Kui, allowing the same experience in both a local- and browser-based experience.

More Resources

  • Developer Guide
  • Kui can form the basis for delivering CLI-driven GUI experiences. For example, Kui has a custom client for Apache OpenWhisk: Oui

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
typescript (9,470
cli (1,618
kubernetes (1,562
ui (943
electron (879
visualization (735
plugin (711
serverless (588
dashboard (396
kubectl (72
openwhisk (16

Find Open Source By Browsing 7,000 Topics Across 59 Categories