kubernetes-sigs / kui

A hybrid command-line/UI development experience for cloud-native development

Blogs | PDF Summary | Installation | API | Custom Graphical CLIs

Kui: a Framework for Enhancing CLIs with Graphics

We love CLIs, and think they are critical for interacting in a flexible way with the cloud. We need the power to go off the rails. But ASCII is tedious.

Kui takes your normal kubectl command line requests and responds with graphics. Instead of ASCII tables, you are presented with sortable ones. Instead of copying and pasting long auto-generated resource names, in Kui you just click.

Kui is also fast. It launches in seconds, and can process kubectl commands 2-3 times faster than kubectl itself.

Help us make Kubernetes tools better by filling out a quick 2 minute survey on your tool preferences. Thanks!

Installing Kui for Kubernetes

We offer prebuilt images optimized for an enhanced Kubernetes CLI experience.

MacOS (Intel and Apple Silicon)

brew install kui
kubectl kui get pods
open /Applications/Kui.app

Windows and Linux

Download and unzip, then add the unzipped directory to your PATH. Now use kubectl kui or launch the Kui executable to use Kui's built-in REPL.

Windows Warning: Please use forward slashes for filepaths, e.g. c:/users, not c:\users.

I don't trust the prebuilts

We hear you. Choose your platform (e.g. mac:amd64), execute the following, then look in ./dist/electron.

git clone [email protected]:kubernetes-sigs/kui.git && cd kui && npm ci && \
    npm run build:electron:mac:amd64

I Want to Make a Custom Graphical CLI

Kui is a framework for adding graphics to CLIs. Kui allows for either a hosted client-server architecture, or the distribution of double-clickable applications (via Electron).

Using the Kui framework, you can design your own Kubernetes enhancements, set a custom theme or custom icon, and enhance the commands of your favorite CLI. Check out the template repo. If your enhancements would be generally valuable, please PR them back here, e.g. awesome Kubernetes enhancements can be integrated with the core Kubernetes plugin.

Code of Conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.

kui's Issues

compose yo still has require('@ibm-functions/shell')

add support for apache-composer-python

add build status badge

error in npm install

The error should be in ./app/plugins/modules/field-installed-plugins/src/lib/cmds/install.ts

fix for missing icon in webpack-local

error during npm run webpack

At commit 847481d, on a clean install, somewhere in the logs while running npm run webpack:

ERROR in ./app/plugins/modules/grid/plugin/lib/util.js
Module not found: Error: Can't resolve '../../../composer/lib/composer' in '/Users/rabbah/projects/kui/app/plugins/modules/grid/plugin/lib'
 @ ./app/plugins/modules/grid/plugin/lib/util.js 103:21-62
 @ ./app/plugins sync ^\.\/.*$
 @ ./app/build/core/plugins.js
 @ ./app/build/webapp/bootstrap/boot.js
 @ ./app/build/webapp/bootstrap/webpack.js

ERROR in ./app/plugins/modules/apache-composer/@demos/combinators/async.js
Module not found: Error: Can't resolve 'openwhisk-composer/plugins/cloudant' in '/Users/rabbah/projects/kui/app/plugins/modules/apache-composer/@demos/combinators'
 @ ./app/plugins/modules/apache-composer/@demos/combinators/async.js 2:17-63
 @ ./app/plugins sync ^\.\/.*$
 @ ./app/build/core/plugins.js
 @ ./app/build/webapp/bootstrap/boot.js
 @ ./app/build/webapp/bootstrap/webpack.js

ERROR in ./app/plugins/modules/apache-composer/@demos/combinators/http.js
Module not found: Error: Can't resolve 'openwhisk-composer/plugins/http' in '/Users/rabbah/projects/kui/app/plugins/modules/apache-composer/@demos/combinators'
 @ ./app/plugins/modules/apache-composer/@demos/combinators/http.js 2:13-55
 @ ./app/plugins sync ^\.\/.*$
 @ ./app/build/core/plugins.js
 @ ./app/build/webapp/bootstrap/boot.js
 @ ./app/build/webapp/bootstrap/webpack.js

update badge to point to travis-ci.org

openwhisk command usage bugs

This command is wrong with insufficient arguments, but the error message is weird. We should provide clearer usage helper message.

typescript compilation failures don't fail travis

clean out some old cruft

output in headless mode has the wrong color

The following invocations are successful but they were thrown as error in headless mode.
(I also tested it in master branch and got the same error output.)

add conventional commits badge

clean up travis

it has some unused portions

edge in session flow doesn't seem right

The visited paths are not highlighted.

The data-status of visited path is false. It should be true if edge.source, and edge.target are success.

remove compileSource method in apache-composer

compileSource() is used only by editor and it's redundant with sourceToComposition().

https://github.com/IBM/kui/blob/master/app/plugins/modules/apache-composer/src/lib/utility/compile.ts#L206

update composition command structure

1. Remove wsk from the command tree
2. Change the entity name app

webpack readme typos

travis-local openwhisk

add support for session list --scan-limit

The current feature we have: session list --limit N
Behavior: We search and list at most N sessions in 20 activations.

We want to offer users a new feature: session list --scan-limit N.
Try our best to search and list N sessions (can't guarantee ).

enable session tests in composer3

Investigate the OpenwhiskError in app invoke

The following error log appears everywhere with app invoke but the invocation result is fine.

kui/app/plugins/modules/openwhisk/plugin/lib/cmds/openwhisk-core.js 512:20

 TypeError: Cannot read property 'name' of undefined
    at Object.invoke (/Users/mengting.yan1ibm.com/Documents/GitHub/kui/app/plugins/modules/openwhisk/plugin/lib/cmds/openwhisk-core.js:912:65)
    at entity (/Users/mengting.yan1ibm.com/Documents/GitHub/kui/app/plugins/modules/openwhisk/plugin/lib/cmds/openwhisk-core.js:509:51)
    at process._tickCallback (internal/process/next_tick.js:68:7)

https://travis-ci.com/IBM/kui/jobs/162066066#L2903

separate apache-composer commands

The commands should be separated into files with every command name, rather than gathering in one commands.ts file.

all invokes are asynchronous due to "typeerror"

when i invoke a new action, it invokes async instead of sync - there's an error posted to the console:

improve support for kubectl plugin

e.g. kubectl kui get pods

k8s status should not defualt to ui (i.e. needsUI: true)

changelog updates

Apache-composer command usage bugs collection

dev docs refer to the shell as "fsh"

The docs here will need to be updated https://github.com/IBM/kui/tree/master/docs/dev for example under quick start

git clone [email protected]:ibm-functions/shell.git
$ cd shell
$ ./tools/setup-npmrc.sh && npm install
$ ./fsh.js

reverse i search issues

when the sidecar is open, the reverse-i-search input only gets half of the remaining width

we also should figure out the linux and windows keyboard shortcut story; ctrl+r reloads electron (and the browser) on those platforms

wskflow edge labeling and coloring issues

1. when viewing a session flow, the visited nodes are properly highlighted, but the visited edges are not

2. the Y/N labels for if's do not appear

k8s related error during npm install

Updated to 847481d and with a clean install, I see this error:

Setting up modules true

> [email protected] postinstall /Users/rabbah/projects/kui/app/plugins/modules/k8s
> ../../../../node_modules/.bin/tsc

src/test/k8s/create-pod.ts:23:32 - error TS2345: Argument of type '{ noOpenWhisk: boolean; }' is not assignable to parameter of type 'IBeforeOptions'.
  Object literal may only specify known properties, and 'noOpenWhisk' does not exist in type 'IBeforeOptions'.

23   before(common.before(this, { noOpenWhisk: true }))
                                  ~~~~~~~~~~~~~~~~~

npm ERR! code ELIFECYCLE
npm ERR! errno 2
npm ERR! [email protected] postinstall: `../../../../node_modules/.bin/tsc`
npm ERR! Exit status 2
npm ERR! 
npm ERR! Failed at the [email protected] postinstall script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/rabbah/.npm/_logs/2018-12-01T14_22_13_073Z-debug.log

add license badge to README

preview @demos/if.js broken when run in browser

a recent regression

add a live link to README

reverse-i-search functionality

add README to dist/webpack

document the webpack building process

add support for output streaming to repl

right now, the output is only allowed to publish to the REPL in batch, when the command is done.

session list next button is skipping activations not sessions

When I clicked the next button of session list, activation list --skip N will be issued. We should change this to session list --skip N.

tab completion popup poorly positioned

too far to the right

support app lang js

Add support for the following command:

command: app lang js
usage: convert javascript source code to composition AST

old openwhisk host setting is sticky

notice in this screen shot that i set a new host name but the shell is posting to a different hostname (see bottom of the screen grab).

travis scancode uses git:// rather than https://

improve webpack-local devex

there are a few path issues with the webpack-local env; also, let's add http-server to the devDeps of the webpack packager directory

switch to kubeadm-dind for kube tests

the order of app list result is different in Electron and Headless

It seems like in Electron mode, app list gets sorted by alphabetic order, but in Headless mode, app list is in correct time order. The weird thing is that the code of app list command handler didn't differentiate Headless and Electron. I set debug('apps', apps) after let apps = actions.filter(astUtil.isAnApp), and the order of resulted apps is different in Electron and Headless.

Code Reference:
https://github.com/IBM/kui/blob/master/app/plugins/modules/apache-composer/src/lib/controller/commands.ts#L180-#L194

app list in Electron:

app list in Headless:

error logged during npm install

During npm install, I noticed the following errors.

src/lib/cmds/edit-amd.ts:42:52 - error TS2307: Cannot find module '../../../../apache-composer/plugin/lib/utility/compile'.

42 import { compileSource, sourceToComposition } from '../../../../apache-composer/plugin/lib/utility/compile'
                                                      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

npm ERR! code ELIFECYCLE
npm ERR! errno 2
npm ERR! [email protected] postinstall: `../../../../node_modules/.bin/tsc`
npm ERR! Exit status 2
npm ERR! 
npm ERR! Failed at the [email protected] postinstall script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/rabbah/.npm/_logs/2018-11-29T20_18_19_578Z-debug.log
src/test/composer1/wskflow_tests.ts:200:43 - error TS2345: Argument of type '() => Client<boolean>' is not assignable to parameter of type '() => boolean | Promise<boolean> | (Client<RawResult<any>> & RawResult<any>)'.
  Type 'Client<boolean>' is not assignable to type 'boolean | Promise<boolean> | (Client<RawResult<any>> & RawResult<any>)'.
    Type 'Client<boolean>' is not assignable to type 'Client<RawResult<any>> & RawResult<any>'.
      Type 'Client<boolean>' is not assignable to type 'Client<RawResult<any>>'.
        Type 'boolean' is not assignable to type 'RawResult<any>'.

200     .then(() => this.app.client.waitUntil(() => {
                                              ~~~~~~~

src/test/composer1/zzz-bottom-bar-back-button.ts:69:21 - error TS2531: Object is possibly 'null'.

69       .then(path => path.substring(path.lastIndexOf('/') + 1))
                       ~~~~

src/test/composer1/zzz-bottom-bar-back-button.ts:69:36 - error TS2531: Object is possibly 'null'.

69       .then(path => path.substring(path.lastIndexOf('/') + 1))
                                      ~~~~

src/test/composer1/zzz-bottom-bar-back-button.ts:83:21 - error TS2531: Object is possibly 'null'.

83       .then(path => path.substring(path.lastIndexOf('/') + 1))
                       ~~~~

src/test/composer1/zzz-bottom-bar-back-button.ts:83:36 - error TS2531: Object is possibly 'null'.

83       .then(path => path.substring(path.lastIndexOf('/') + 1))
                                      ~~~~

npm ERR! code ELIFECYCLE
npm ERR! errno 2
npm ERR! @shell/[email protected] postinstall: `../../../../node_modules/.bin/tsc`
npm ERR! Exit status 2
npm ERR! 
npm ERR! Failed at the @shell/[email protected] postinstall script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/rabbah/.npm/_logs/2018-11-29T20_18_19_723Z-debug.log
src/lib/flowCommand.ts:23:26 - error TS2307: Cannot find module '../../../apache-composer/plugin/lib/utility/ast'.

23 import * as astUtil from '../../../apache-composer/plugin/lib/utility/ast'
                            ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

src/lib/preview.ts:34:25 - error TS2307: Cannot find module '../../../apache-composer/plugin/lib/utility/badges'.

34 import * as badges from '../../../apache-composer/plugin/lib/utility/badges'
                           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

src/lib/preview.ts:35:27 - error TS2307: Cannot find module '../../../apache-composer/plugin/lib/utility/messages'.

35 import * as messages from '../../../apache-composer/plugin/lib/utility/messages'  // TODO: import from plugin js file
                             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

src/lib/preview.ts:38:30 - error TS2307: Cannot find module '../../../apache-composer/plugin/lib/utility/compile'.

38 import * as compileUtil from '../../../apache-composer/plugin/lib/utility/compile'
                                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

src/lib/util.ts:18:26 - error TS2307: Cannot find module '../../../apache-composer/plugin/lib/utility/ast'.

18 import * as astUtil from '../../../apache-composer/plugin/lib/utility/ast'
                            ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

src/lib/util.ts:19:25 - error TS2307: Cannot find module '../../../apache-composer/plugin/lib/utility/badges'.

19 import * as badges from '../../../apache-composer/plugin/lib/utility/badges'
                           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

npm ERR! code ELIFECYCLE
npm ERR! errno 2
npm ERR! @shell/[email protected] postinstall: `../../../../node_modules/.bin/tsc && rm -rf node_modules/jquery/src && rm -f node_modules/jquery/external/sizzle/dist/sizzle.js && rm -f node_modules/jquery/dist/core.js && mv -f node_modules/jquery/dist/jquery.min.js node_modules/jquery/dist/jquery.js && rm -f node_modules/jquery/dist/jquery.slim* && mv -f node_modules/jquery/dist/jquery.min.map node_modules/jquery/dist/jquery.map && rm -rf node_modules/d3/src && mv node_modules/d3/d3.min.js node_modules/d3/d3.js && rm -f node_modules/elkjs/lib/elk-worker.js node_modules/elkjs/lib/elk.bundled.js`
npm ERR! Exit status 2
npm ERR! 
npm ERR! Failed at the @shell/[email protected] postinstall script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/rabbah/.npm/_logs/2018-11-29T20_18_20_166Z-debug.log
npm WARN [email protected] No repository field.

added 93 packages in 30.775s

...

> [email protected] compile /Users/rabbah/projects/kui/app
> if [ -d ../dist ]; then cd ../dist/bin && ./compile.js; fi

  ✓ plugin	apache-composer
  ✓ preload	apache-composer
  ✓ plugin	bash-like
  ✓ plugin	core-support
  ✓ preload	core-support
  ✓ plugin	editor
  ✓ preload	editor
  ✓ plugin	field-installed-plugins
  ✓ plugin	grid
  ✓ plugin	k8s
  ✓ plugin	openwhisk
  ✓ plugin	openwhisk-debug
  ✓ plugin	tutorials
  ✓ preload	tutorials
  ✓ plugin	wskflow
commencing seticon
Using appName=Kui and appIcon=../app/content/icons/png/kui.png

done
added 210 packages in 41.676s
added 291 packages in 56.672s

update app list --limit --skip and --count

None of the optional parameters are working now.

k8s module isDirectory utility bug

always fails, due to calling if(isDirectory) rather than if(isDirectory())

remove ugly borders from grid view

enable tslint check

Fix all the tslint errors and enable tslint tests.