Skip to content
This repository has been archived by the owner on Sep 28, 2021. It is now read-only.
/ kcui Public archive

A simple terminal tool to monitor the k8s pods and logs

License

Notifications You must be signed in to change notification settings

ZacharyChang/kcui

Repository files navigation

KCUI - Kubernetes Console User Interface

Build Status Go Report Card

Introduction

KCUI is a simple tool to monitor the k8s pods and logs. From this tool you can easily watch the pods status and logs changing.

example

Features

  1. Configuration from kubeconfig file (default from $HOME/.kube/config)

  2. Change namespace from command params (default as 'default')

  3. List current pods in the panel.

  4. Tail logs from selected pod.

Run

./kcui

Usage

./kcui --help
NAME:
   KCUI - A simple tool to monitor the k8s pods and logs.

USAGE:
   kcui [global options] command [command options] [arguments...]

VERSION:
   v0.1.2

COMMANDS:
     help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --kubeconfig value  Path to the kube config. This can be set from environment value 'KUBECONFIG' (default: "/Users/zachary/.kube/config") [$KUBECONFIG]
   --namespace value   Namespace to query. (default: "default")
   --debug             Run with debug mode
   --help, -h          show help
   --version, -v       print the version

Installation

macOS

curl -Lo kcui https://github.com/ZacharyChang/kcui/releases/download/v0.1.2/kcui_darwin && chmod +x kcui

Linux

curl -Lo kcui https://github.com/ZacharyChang/kcui/releases/download/v0.1.2/kcui_linux && chmod +x kcui

Windows ( not tested )

curl -Lo kcui.exe https://github.com/ZacharyChang/kcui/releases/download/v0.1.2/kcui_windows.exe

Commands

Key Description

,

Navigate pod list

Enter

Select item

Ctrl+q, Esc

Exit

TODO

  • Multiple containers log support (Not supported yet)

  • Log view can be scrolled, and filtered with keywords

  • Interactive with pod container, like 'kubectl exec'

Thanks

  • tview: Rich interactive widgets for terminal-based UIs written in Go

  • client-go: Go client for Kubernetes

  • kubebox: Terminal and Web console for Kubernetes