kubic

command module
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 20, 2022 License: MIT Imports: 6 Imported by: 0

README

kubic

tui for k8s

What is it.

kubic is a tui k8s explorer.

The idea is to free from the need to keep namespaces, deployments, pods names in your head.

It's a good replacement for kubectl or more precisely it's an additional tool that takes over the most of work.

Features

  • doesn't require configuration for start, just kubernetes config
  • vim mappings + arrows for navigation
  • simple, sweet design powered by Charm libraries

UI screenshots

Different color scheme example.

Requirements

  • kubernetes config file

The best way is to keep it in ~/.kube/config path. But you can set path on running.

Installation

  • Download archive from Releases
  • Extract archive
chmod +x kubic
mv kubic ~/.local/bin

Run

  1. With default config.

You can run kubic without any parameters if you have kubernetes config in ~/.kube/config path nad need to use it.

kubic
  1. With custom config.

You can run it with --config or shot -c parameter and set path to the config path. Or with environment variable KUBIC_KUBERNETES_CONFIG_PATH.

kubic -c /path/to/the/config/file
  1. With custom color scheme.

If you want's to use different color scheme, put style.json in the same directory with kubic binary and run kubic without additional parameters. kubic will use this file automatically.

You can set path path to your json file with --theme parameter (short way -t) or with environment variable KUBIC_THEME_FILE_PATH.

kubic -t /path/to/the/json/style/file

Flags list:

Short Flag Long Flag Environment Variable Is Required Type
-c --config KUBIC_KUBERNETES_CONFIG_PATH False string
-t --theme KUBIC_THEME_FILE_PATH False string

Customization

You can set your own color scheme with json file.

Example

Classes are predefined. Set your own color with hex.

{
    "main-text": "#ffffff",
    "selected-text": "#61b0de",
    "inactive-text": "#616363",
    "tab-borders": "#109f93",
    "namespace-sign": "#eb24a9"
}

Roadmap

  • k8s calls list
  • Namespaces list (kubectl get namespace)
  • Deployments list (kubectl get deployments --namespace=ns)
  • Pods list (kubectl get pods --namespace=ns)
  • Deployment info (kubectl get deployment deployment-name --namespace=ns -o=json)
  • Pod info (kubectl get pods pod-name --namespace=ns -o=json)
  • Pod logs (kkubectl logs pod-name --namespace=ns)

Powered by Charm.

The Charm logo

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg
config
Package config keeps all config files.
Package config keeps all config files.
k8s
ui
ui/shared/elements/divider
Package divider keeps helpers to draw dividers.
Package divider keeps helpers to draw dividers.
ui/shared/themes
Package themes keeps default styles.
Package themes keeps default styles.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL