kubetui

Kubetui is a terminal user interface (TUI) tool designed for monitoring Kubernetes resources.
It provides an easy-to-use interface for developers and operators to access important information about their applications and infrastructure.

Installation

To install Kubetui, you can use the following methods:

1. Using cargo install: Kubetui is available on crates.io, the official Rust package registry. Install it by running the following command:

   ```shell

   Install with rustls version

   cargo install kubetui ```

   or

   ```shell

   Install with openssl version

   cargo install kubetui --no-default-features --features openssl-tls ```

   Make sure you have Rust and Cargo installed before running the command. If you choose the OpenSSL version, you will need to have the OpenSSL library installed as well.

2. Downloading the binary: Alternatively, you can download the precompiled binary from the GitHub Release page that matches your operating system. Once downloaded, you can run the binary directly without any additional installation steps.

Choose the method that suits your needs and preferences.

Features

Kubetui offers the following features to help you monitor and manage your Kubernetes resources:

• Pods List and Container Logs: Easily view a list of pods and their container logs.
• ConfigMap and Secret Watching: Monitor ConfigMaps and secrets, and decode their data.
• Network-related Resources: Explore a list of network-related resources and their descriptions.
• Events Watching: Stay updated with a real-time view of Kubernetes events.
• Specific Resources Watching (List / YAML): View specific resources in list or YAML format.
• Namespace Multiple Selections: Select and view multiple namespaces simultaneously.
• Context Selection: Change the Kubernetes context you want to operate on.
• Clipboard Support (Text Copy): Copy text conveniently using mouse actions.
• Mouse Event Support: Leverage mouse events for a smoother user experience.
• Search Functionality: Easily search for specific keywords within the interface.
• Item Filtering: Filter items based on multiple keywords separated by spaces.

Overall, kubetui is a powerful tool designed to provide a safe and efficient way to access and monitor your Kubernetes resources. With its user-friendly interface and comprehensive features, it simplifies the process of managing your applications and infrastructure.

Usage

sh kubetui

```sh $ kubetui -h kubernetes terminal user interface

Usage: kubetui [OPTIONS]

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

Key Bindings

General

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

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 |

View Control

| Key | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------- | | j, k, Down, Up, PgDn, PgUp | Change the selected item / Scroll the view | | Left, Right | Scroll horizontally in 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 |

Text View

| Key | Description | | ---------------------------- | ------------------------------------------------------------------------------ | | / | Activate search mode and open the search form | | Enter | Confirm the input | | q, Esc | Disable search mode and close the search form (when search mode is active) |

Search Mode

| Key | Description | | ---------------------------- | ------------------------------- | | n, N | Go to the next / previous match | | q, Esc | Disable search mode |

Table View

| Key | Description | | -------------------------------- | --------------------- | | / | Open the filter form | | Enter, ESC | Close the filter form |

Popup

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

Input Form

| Key | Description | | --------------------------------- | ------------------------------------------------ | | Home | Move the cursor to the beginning | | End | Move the cursor to the end | | Ctrl+w | Delete text from the cursor to the beginning | | Ctrl+k | Delete text from the cursor to the end | | Left, Right | Move the cursor to the previous / next character |

Contributing

Bug reports and pull requests are welcome.

License

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