kubecolor Kubecolor
winget install --id=Kubecolor.kubecolor -e Colorize your kubectl output
Kubecolor is a tool designed to enhance the readability of your kubectl output by adding colors, making logs and resources more accessible and easier to navigate. This software supports custom color themes, including options for light backgrounds and colorblind-adjusted schemes, ensuring inclusivity for all users. It features dynamic TTY detection, which means it sends plaintext when called programmatically, preserving the integrity of your data without altering its content. Additionally, Kubecolor offers alias support, allowing you to use it as a substitute for kubectl, and includes autocompletion functionality for a seamless workflow experience.
Ideal for Kubernetes operators and developers who value clarity and efficiency in their command-line interactions, Kubecolor ensures that your work environment is both productive and visually intuitive. By enhancing the readability of your outputs without modifying the underlying data, Kubecolor serves as an invaluable tool for anyone working with Kubernetes CLI tools. It can be conveniently installed via winget, integrating effortlessly into your existing setup.
README
kubecolor
Kubecolor is a kubectl wrapper used to add colors to your kubectl output.
You can also change color theme for light-background environment (click to expand)
> 
>
> 
>
> 
[New!] We also have colorblind-adjusted color themes (click to expand)
> 
>
> 
>
> 
>
> Note:
> As of version v0.3.0, both deuteranopia and tritanopia themes are the same as protanopia. They may differ in future versions when we better tune them. Set your configuration to match your color-blindness type so you will benefit of the future changes. We gladly accept suggestions on how to improve them.
What's this?
kubecolor is a wrapper that colorizes your kubectl command output and does nothing else.
It internally calls kubectl command and try to colorizes the output so
you can alias kubecolor as a substitute for when you want to run kubectl,
meaning you can write this in your .bash_profile:
alias kubectl="kubecolor"
# Also works for OpenShift CLI
alias oc="env KUBECTL_COMMAND=oc kubecolor"
Features
- Does not tamper with the output. It only adds colors to the
kubectloutput. - Dynamic TTY detection to send plaintext when called programatically
- Supports autocompletion
- Custom color themes
Getting started
Head over to our documentation:
Contributing
Always welcome. There are multiple ways to contribute:
-
Starring the repository and spreading the word ❤️
-
Creating issues of bug reports or feature requets
-
Updating documentation, either in this repo or in the documentation repo (kubecolor.github.io)
-
Submitting patches (look for "good first issue" if you want something small to get started)
For code contributions, please see: CONTRIBUTING.md
Versioning
This project tries to follow SemVer 2.0.0 on the command-line interface (CLI), i.e which flags and environment variables it accepts.
We do not however promise compatibility on the Go source code. If you import kubecolor's Go module and use it as a library, then things may unexpectedly break within minor or patch version changes.
> [!WARNING] > As we have not yet reached v1.0.0, we may have some breaking changes > in cases where it is deemed necessary.
LICENSE
MIT
Author
This project is a heavily modified version of the original kubecolor, archived at https://github.com/hidetatz/kubecolor