A hybrid command-line/UI development experience for cloud-native development
Branch: master
Clone or download
starpit chore(release): publish %s
 - @kui-shell/core@2.10.0
 - @kui-shell/builder@0.10.0
 - @kui-shell/proxy@0.10.0
 - @kui-shell/test@0.0.6
 - @kui-shell/plugin-apache-composer@0.15.0
 - @kui-shell/plugin-bash-like@0.0.17
 - @kui-shell/plugin-core-support@0.10.0
 - @kui-shell/plugin-editor@0.0.17
 - @kui-shell/plugin-grid@0.0.16
 - @kui-shell/plugin-k8s@0.10.0
 - @kui-shell/plugin-manager@0.0.16
 - @kui-shell/plugin-openwhisk-debug@0.0.16
 - @kui-shell/plugin-openwhisk-editor-extensions@0.0.9
 - @kui-shell/plugin-openwhisk@0.10.0
 - @kui-shell/plugin-proxy-support@0.10.0
 - @kui-shell/plugin-tutorials@0.10.0
 - @kui-shell/plugin-wskflow@0.0.16
Latest commit 0f87aa3 Feb 21, 2019


Kui Shell

Build Status License Conventional Commits lerna

Kui Shell offers a new development experience for building cloud-native applications. By combining 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.

When running locally (the first and second options), we suggest that you add the bin directory to your PATH; the above links provide the specifics. This will enable kubectl kui to work.

The Kui Experience

Kui screenshot

Click the image to see Kui in motion. For more of the backstory of Kui, read on!

This is a CLI, with Visualizations on the Side

Kui uses Electron to provide you with an augmented but CLI-focused development experience. By using Electron, the same experience carries over, from local development on your laptop, to a browser-based experience.

When running locally, you will have access to your filesystem and your favorite terminal and text editor. To help with complex data, Kui offers a suite of visualizations. You can gracefully flip between the terminal and these visualizations, without having to switch to your browser, log in, wait for pages to load, and navigate through complex menu structures.

For example, to see a visual summary of your Kubernetes pods, issue this command from your favorite terminal:

Example Command Thumbnail of Output
kubectl kui get pods --ui

Without the --ui option, Kui will display the output in your terminal directly; you will observe that the output is identical to that of kubectl, with the possible addition of syntax coloration. With Kui, you have the power to navigate between these modes in a graceful and flexible manner.

kubectl get pods drilldown animated gif

Now try clicking on a row. You should see the "sidecar" sweep in from the right. This split screen mode allows you to drill down to the details of your pods. You can click on one, then another, for rapid inspection of several of your resources. The animated gif should give you a sense of the possibilities (click on it to see a larger version).

Further Reading and Examples

Kui also has support for Apache OpenWhisk and Apache Composer. In all three cases, from Kubernetes, to serverless, to serverless composition, the story is the same: you can gracefully transition into the world of visualizations without altering your normal productive workflows.