Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hidetatz/kubecolor

colorizes kubectl output
https://github.com/hidetatz/kubecolor

kubectl kubernetes

Last synced: 3 months ago
JSON representation

colorizes kubectl output

Awesome Lists containing this project

README 

        
# kubecolor



image



![test](https://github.com/hidetatz/kubecolor/workflows/test/badge.svg?branch=main)

[![Go Report Card](https://goreportcard.com/badge/github.com/hidetatz/kubecolor)](https://goreportcard.com/report/github.com/hidetatz/kubecolor)

[![codecov](https://codecov.io/gh/hidetatz/kubecolor/branch/main/graph/badge.svg?token=k6ysAa5ghD)](https://codecov.io/gh/hidetatz/kubecolor/)



Colorize your kubectl output



* get pods



![image](https://user-images.githubusercontent.com/60682957/95733375-04929680-0cbd-11eb-82f3-adbcfecf4a3e.png)



* describe pods



![image](https://user-images.githubusercontent.com/60682957/95733389-08beb400-0cbd-11eb-983b-cf5138277fe3.png)



* something wrong



![image](https://user-images.githubusercontent.com/60682957/95733397-0a887780-0cbd-11eb-8875-bb1000e0e597.png)



* You can change color theme for light-backgrounded environment



![image](https://user-images.githubusercontent.com/60682957/95733403-0c523b00-0cbd-11eb-9ff9-abc5469e97ca.png)



## What's this?



kubecolor colorizes your `kubectl` command output and does nothing else.

kubecolor internally calls `kubectl` command and try to colorizes the output so

you can use kubecolor as a complete alternative of kubectl. It means you can write this in your .bash_profile:



```sh

alias kubectl="kubecolor"

```

If you use your .bash_profile on more than one computer (e.g. synced via git) that might not all have `kubecolor` 

installed, you can avoid breaking `kubectl` like so: 



```sh

command -v kubecolor >/dev/null 2>&1 && alias kubectl="kubecolor"

```



For now, not all subcommands are supported and some of them might be in the future. If you want something to be supported by kubecolor, you can open an issue in this GitHub repo.

Even if what you want to do is not supported by kubecolor right now, kubecolor still can just show `kubectl` output without any decorations,

so you don't need to switch kubecolor and kubectl but you always can use kubecolor.



Additionally, if `kubectl` resulted an error, kubecolor just shows the error message in red or yellow.



**Please keep in mind that kubecolor has runtime overhead compared to kubectl because it runs kubectl internally and parses the output, then colorizes it.**



## Installation



### Download binary via GitHub release



Go to [Release page](https://github.com/hidetatz/kubecolor/releases) then download the binary which fits your environment.



### Mac and Linux users via Homebrew



```sh

brew install hidetatz/tap/kubecolor

```



### Manually via go command



*Note: if you install kubecolor via go command, --kubecolor-version  might not work*



```sh

go install github.com/hidetatz/kubecolor/cmd/kubecolor@latest

```



If you are not using module mode (or if just above doesn't work), try below:



```sh

go get -u github.com/hidetatz/kubecolor/cmd/kubecolor

```



## Usage



kubecolor understands every subcommands and options which are available for `kubectl`. What you have to do is just using `kubecolor`

instead of `kubectl` like:



```sh

kubecolor --context=your_context get pods -o json

```



If you want to make the colorized kubectl default on your shell, just add this line into your shell configuration file:



```sh

alias kubectl="kubecolor"

```



### Dynamic tty support



When the kubecolor output tty is not standard output, it automatically disables the colorization.

For example, if you are running `kubecolor get pods > result.txt` or `kubecolor get pods | grep xxx`, the output will be passed through to file or another command, so colorization is not applied.

You can force kubecolor do colorization at such cases by passing `--force-colors` flag. See the upcoming section for more details.



### Flags



Available flags for kubecolor. When you pass them, kubecolor will understand them but these flags won't be passed to kubectl.



* `--kubecolor-version`



Prints the version of kubecolor (not kubectl one).



* `--light-background`



When your terminal's background color is something light (e.g white), default color preset might look too bright and not readable.

If so, specify `--light-background` as a command line argument. kubecolor will use a color preset for light-backgrounded environment.



* `--force-colors`



By default, kubecolor never output the result in colors when the tty is not a terminal standard output.

If you want to force kubecolor to show the result in colors for non-terminal tty, you can specify this flag.

For example, when you want to pass kubecolor result to grep (`kubecolor get pods | grep pod_name`), this option is useful.



* `--plain`



When you don't want to colorize output, you can specify `--plain`. Kubecolor understands this option and outputs the result without colorizing.



### Autocompletion



kubectl provides [autocompletion feature](https://kubernetes.io/docs/tasks/tools/install-kubectl/#enable-kubectl-autocompletion). If you are

already using it, you might have to configure it for kubecolor.

Please also refer to [kubectl official doc for kubectl autocomplete](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#kubectl-autocomplete).



#### Bash



For Bash, configuring autocompletion requires adding following line in your shell config file.



```shell

# autocomplete for kubecolor

complete -o default -F __start_kubectl kubecolor

```



If you are using an alias like `k="kubecolor"`, then just change above like:



```shell

complete -o default -F __start_kubectl k

```



#### Zsh



For zsh make sure these lines are present in your zsh config file:

```shell

# get zsh complete kubectl

source <(kubectl completion zsh)

alias kubectl=kubecolor

# make completion work with kubecolor

compdef kubecolor=kubectl

```



#### fish



Fish completion is officially unsupported by `kubectl`, so it is unsupported by `kubecolor` as well.



However, there are 2 ways we can make them work. Please keep in mind these are a kind of "hack" and not officially supported.



1. Use [evanlucas/fish-kubectl-completions](https://github.com/evanlucas/fish-kubectl-completions) with `kubecolor`:



   * Install `kubectl` completions (https://github.com/evanlucas/fish-kubectl-completions):

      ```

      fisher install evanlucas/fish-kubectl-completions

      ```

   * Add the following function to your `config.fish` file:

      ```

      function kubectl

        kubecolor $argv

      end

      ```

2. Use [awinecki/fish-kubecolor-completions](https://github.com/awinecki/fish-kubecolor-completions)



   The first way will override `kubectl` command. If you wish to preserve both `kubectl` and `kubecolor` with completions, you need to copy [evanlucas/fish-kubectl-completions](https://github.com/evanlucas/fish-kubectl-completions) for the `kubecolor` command.



   For this purpose, you can use [awinecki/fish-kubecolor-completions](https://github.com/awinecki/fish-kubecolor-completions).



### Specify what command to execute as kubectl



Sometimes, you may want to specify which command to use as `kubectl` internally in kubecolor. For example, when you want to use a versioned-kubectl `kubectl.1.19`, you can do that by an environment variable:



```shell

KUBECTL_COMMAND="kubectl.1.19" kubecolor get po

```



When you don't set `KUBECTL_COMMAND`, then `kubectl` is used by default.



## Supported kubectl version



Because kubecolor internally calls `kubectl` command, if you are using unsupported kubectl version, it's also not supported by kubecolor.

Kubernetes version support policy can be found in [official doc](https://kubernetes.io/docs/setup/release/version-skew-policy/).



## kubectl plugins



Even if kubectl supports [plugin](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/) feature, it is not supported by kubecolor, including [Krew](https://krew.sigs.k8s.io/).

It means you can use plugins from kubecolor (e.g. you can do `kubecolor plugin_name xxx`), but the result won't be colorized.



## Contributions



Always welcome. Just opening an issue should be also greatful.



## LICENSE



MIT



## Author



[@hidetatz](https://github.com/hidetatz)