k-akashi / kubetui

A tui tool for monitoring kubernetes resources

kubetui

This is a TUI tool for monitoring kubernetes resources.

Installation

Please download a binary from github release.

Features

• Pods list and container logs watching
• ConfigMap and secret watching, and data decoding
• Network related resources list and description
• Events watching
• Specific resources watching (Table / Yaml)
• Namespace multiple selections
• Context selection
• Support clipboard (only mouse action)
• Support mouse event
• Search word
• Filter items (multiple words with space delimited)

Command Option

kubernetes terminal user interface

Usage: kubetui [OPTIONS]

Options:
  -h, --help                           Print help information
  -V, --version                        Print version information
  -A, --all-namespaces[=<true|false>]  Select all namespaces [default: false]
  -c, --context <CONTEXT>              Context
  -C, --kubeconfig <KUBECONFIG>        kubeconfig path
  -l, --logging                        Logging
  -n, --namespaces <NAMESPACES>        Namespaces (e.g. -n val1,val2,val3 | -n val1 -n val2 -n val3)
  -s, --split-mode <v|h>               Window split mode [possible values: v, h, vertical, horizontal]

Key Bindings

General

Key	Description
h, ?	Open the popup for help
Enter	Select item, and trigger event
n	Open the popup for selecting the namespace
N	Open the popup for selecting the namespaces
c	Open the popup for selecting the context
Shift+n	Open the popup for selecting multiple namespaces
Tab, Shift+Tab	Change the focus of view within the active tab
number	Switch the tab (number: 1~6)
ESC	Close the window, or terminate the app (when the popup is not opening)
q	Terminate the app
f	Open the popup for selecting multiple api-resources (only APIs / Yaml tab)

View control

Key	Description
j, k, Down, Up, PgDn, PgUp	Change the item to select / Scroll the view
Left, Right	Scroll horizontally on the view
g	Go to the first item / Go to the top of the view
G	Go to the last item / Go to the bottom of the view

View specific

Text view

Key	Description
/	Activate search mode, open search form
Enter	Confirm input
q, Esc	Disable search mode, close search form (when search mode is enabled)

Search mode

Key	Description
n, N	Goto next / previous match
q, Esc	Disable search mode

Table view

Key	Description
/	Open filter form
Enter, ESC	Close filter form

Popup

Key	Description
Down, Up, PgDn, PgUp	Change the item to select / Scroll the view
Tab, Shift+Tab	Change the focus of view within the active tab
Enter	Select item, and trigger event
ESC	Close the window, or terminate the app (when the popup is not opening)

Input form

Key	Description
Home	Move the cursor to the start
End	Move the cursor to the end
Ctrl+w	Delete the text from the cursor position to the start
Ctrl+k	Delete the text from the cursor position to the end
Left, Right	Move the cursor to a (back, forward) character

Key map

Source	Destination
Ctrl+p	Up
Ctrl+n	Down
Ctrl+f	Right
Ctrl+b	Left
Ctrl+u	PgUp
Ctrl+d	PgDn
Ctrl+h, Backspace	Delete
Ctrl+a	Home
Ctrl+e	End
Ctrl+[	Esc

Contributing

Bug reports and pull requests are welcome.

License

This software is available as open source under the terms of the MIT License.

Screenshots

Watch Resources

1. pods list / container logs

2. ConfigMap / Secret

3. Network

4. Events

5. APIs

6. Yaml

Select Items

1. Select namespace

2. Select namespaces (multiple)

3. Select apis

Filter items

Search word

Help