kubebox

= Kubebox Antonin Stefanutti https://github.com/astefanutti[@astefanutti] // Meta :description: CLI console for Kubernetes clusters // Settings :idprefix: :idseparator: - :experimental: // Aliases ifdef::env-github[] :note-caption: :information_source: :icon-edit: :pencil2: endif::[] ifndef::env-github[] :icons: font :icon-edit: icon:pencil[fw] endif::[] // URIs :uri-terminal-forever: http://www.commitstrip.com/en/2016/12/22/terminal-forever/

{description}

image::http://astefanutti.github.io/kubebox/kubebox.gif[]

== Run

=== NPM

Install Kubebox globally and run it:

$ npm install -g kubebox
$ kubebox

Or locally:

$ npm install kubebox
$ `npm bin`/kubebox

=== Docker

You can run Kubebox using Docker, e.g.:

$ docker run -it --rm astefanutti/kubebox

You may want to mount your home directory so that Kubebox can rely on the ~./kube/config file, e.g.:

$ docker run -it --rm -v ~/.kube/:/root/.kube/:ro astefanutti/kubebox

== Usage

{icon-edit}

== Commands

[cols="1v,2v"] |=== |Keybinding |Description

|kbd:[n] |Change current namespace

|kbd:[<-], kbd:[->] |Navigate screen

|kbd:[q], kbd:[CTRL+c] |Exit

|===

== CLI

image::http://astefanutti.github.io/kubebox/terminal-forever.jpg[link={uri-terminal-forever}]