Skip to content
A hybrid command-line/UI development experience for cloud-native development
TypeScript CSS JavaScript Shell Go Dockerfile Other
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Removed Strapi references Jul 8, 2019
.vscode chore: setup Prettier Jul 3, 2019
bin chore: improve `npm start` Apr 15, 2020
docs chore: move Navigation impls under spi/ May 5, 2020
packages fix: kubectl edit in sidecar doesn't show success message when a reso… May 28, 2020
plugins feat: add Retry button to sidecar toolbar when log streaming stopped … May 28, 2020
tools chore: add installation docs for use as an ibmcloud CLI plugin Apr 24, 2020
.eslintignore chore: performance work Oct 16, 2019
.eslintrc.json feat: carbon tables Feb 13, 2020
.gitignore chore: bump to electron 7.2.1 Mar 27, 2020
.prettierignore feat: introduce plugin-client-default meant for hosting a client defi… Jan 13, 2020
.prettierrc.json chore: setup prettier for html & css files Jul 19, 2019
.travis.yml fix: update ibmcloud plugin compilation to use client version Apr 24, 2020
CHANGELOG.md v8.7.0 May 8, 2020
CONTRIBUTING.md chore: setup Prettier Jul 3, 2019
LICENSE Initial commit Nov 29, 2018
README.md chore: add installation docs for use as an ibmcloud CLI plugin Apr 24, 2020
lerna.json v8.7.0 May 8, 2020
package-lock.json feat(plugins/plugin-kubectl): Terminal tab for Pod kubernetes resources May 23, 2020
package.json feat: patternfly4 themes Apr 29, 2020
tsconfig.json feat: remove plugin-manager Apr 20, 2020

README.md

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-Win32-x64.zip

To run Kui as a kubectl plugin (for kubectl 1.12+), add the unpacked directory to your PATH; e.g. on MacOS:

curl -L https://macos-tarball.kui-shell.org/ | tar jxf -
export PATH=$PWD/Kui-darwin-x64:$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
You can’t perform that action at this time.