semihbkgr / kubecolor

Colorize your kubectl output

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 kubectl output.
• Dynamic TTY detection to send plaintext when called programatically
• Supports autocompletion
• Custom color themes

Getting started

Head over to our documentation:

• Usage / Getting started
• Usage / How it works
• Setup / Installation

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

@kubecolor