Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tardunge/kmux-status
tmux status-lline plugin to render kube-context and other indicators
https://github.com/tardunge/kmux-status
kubectl tmux tmux-plugin
Last synced: 2 months ago
JSON representation
tmux status-lline plugin to render kube-context and other indicators
- Host: GitHub
- URL: https://github.com/tardunge/kmux-status
- Owner: tardunge
- License: mit
- Created: 2021-02-08T17:08:09.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-02-09T10:54:12.000Z (about 4 years ago)
- Last Synced: 2024-08-18T18:12:33.698Z (6 months ago)
- Topics: kubectl, tmux, tmux-plugin
- Language: Shell
- Homepage:
- Size: 3.99 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-tmux - kmux-status - Tmux plugin to render kubernetes context and other indicators on the status-line. (Plugins)
README
# kmux-status
tmux status-line plugin to render kube-context and pod-name indicators.
# Features
- Adds kube-context with namespace to the status-line.
- Shows the pod-name in status-line for the pod being interacted in the current-pane. Works with kubectl only. The following interactions are implemented:
* If you do kubectl `exec` -it pod.
* If you are tailing `logs`(obviously with -f) for a pod.
* If you are `port-forwarding` to a pod.
- Shows the full command tree for the current pane.
# Installation
If you are using zsh and tmux with kubecontext rendered on your prompt, but you deal with one kube-context at a time accross terminals, while rotating contexts over time, then imo it makes sense to have the kubecontext indicated on tmux status-line rather than having it rendered across all your terminal prompts. Incase, if you use different contexts within the scope of different shells, then you need to tap into the shell env to extract the context(it makes more sense to have it rendered in your prompt itself for this scenario).
## Requirements
- [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/) binary.
- [`pstree`](https://man7.org/linux/man-pages/man1/pstree.1.html) to fetch child processes of the current-pane.
**Note:** Please use this command to check whether tmux is able to find kubectl/pstree: `tmux run-shell -b 'command -v {kubectl}/{pstree}'`
## Install via [TPM](https://github.com/tmux-plugins/tpm/)
Add this line to your `~/.tmux.conf`
```tmux
set -g @plugin 'tardunge/kmux-status'
```
Reload configuration, then press `prefix` + `I` to install plugin.
# Usage
For rendering the current kube-context:
```tmux
# in .tmux.conf
set-option -g status-right '#{kcontext}'
```
For rendering the pod name in the current-pane:
```tmux
# in .tmux.conf
set-option -g status-right '#{kpod}'
```
These (`#{kcontext}` and `#{kpod}`) are the two available formats supported now.
To see the full command which is being executed in the current pane, press `prefix` + `G`. You will be taken to copy mode to the generated output.
```bash
-+= 65725 manojbabu -zsh
\--= 73635 manojbabu kubectl port-forward --namespace default stg-metabase 8080:3000
```
Useful to keep track of ssh-tunnels.
# Customization
Here are available options with their default values:
```tmux
# in .tmux.conf
set-option -g @kmux-kcontext-icon "⎈" # defaults to K8
set-option -g @kmux-kpod-exec-icon "E" # defaults to E
set-option -g @kmux-kpod-log-icon "L" # defaults to L
set-option -g @kmux-kpod-port-fw-icon "P" # defaults to P
```
# License
[MIT](https://github.com/tardunge/kmux-status/blob/main/LICENSE)