{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/309", "result": {"data":{"issuesJson":{"id":"b0787d2a-ce2d-5c77-a0f5-63ef2c9fa502","title":"hidetatz/kubecolor: 可以给 kubectl 命令行输出内容着色的一个工具","number":309,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Reposhidetatz/kubecolor
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

kubecolor

\n

\"image\"

\n

\"test\"
\n\"Go
\n\"codecov\"

\n

Colorize your kubectl output

\n\n

\"image\"

\n\n

\"image\"

\n\n

\"image\"

\n\n

\"image\"

\n

What's this?

\n

kubecolor colorizes your kubectl command output and does nothing else.
\nkubecolor internally calls kubectl command and try to colorizes the output so
\nyou can use kubecolor as a complete alternative of kubectl. It means you can write this in your .bash_profile:

\n
alias kubectl=\"kubecolor\"
\n

If you use your .bash_profile on more than one computer (e.g. synced via git) that might not all have kubecolor
\ninstalled, you can avoid breaking kubectl like so:

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

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.
\nEven if what you want to do is not supported by kubecolor right now, kubecolor still can just show kubectl output without any decorations,
\nso you don't need to switch kubecolor and kubectl but you always can use kubecolor.

\n

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

\n

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

\n

Installation

\n

Download binary via GitHub release

\n

Go to Release page then download the binary which fits your environment.

\n

Mac and Linux users via Homebrew

\n
brew install hidetatz/tap/kubecolor
\n

Manually via go command

\n

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

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

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

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

Usage

\n

kubecolor understands every subcommands and options which are available for kubectl. What you have to do is just using kubecolor
\ninstead of kubectl like:

\n
kubecolor --context=your_context get pods -o json
\n

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

\n
alias kubectl=\"kubecolor\"
\n

Dynamic tty support

\n

When the kubecolor output tty is not standard output, it automatically disables the colorization.
\nFor 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.
\nYou can force kubecolor do colorization at such cases by passing --force-colors flag. See the upcoming section for more details.

\n

Flags

\n

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

\n\n

Prints the version of kubecolor (not kubectl one).

\n\n

When your terminal's background color is something light (e.g white), default color preset might look too bright and not readable.
\nIf so, specify --light-background as a command line argument. kubecolor will use a color preset for light-backgrounded environment.

\n\n

By default, kubecolor never output the result in colors when the tty is not a terminal standard output.
\nIf you want to force kubecolor to show the result in colors for non-terminal tty, you can specify this flag.
\nFor example, when you want to pass kubecolor result to grep (kubecolor get pods | grep pod_name), this option is useful.

\n\n

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

\n

Autocompletion

\n

kubectl provides autocompletion feature. If you are
\nalready using it, you might have to configure it for kubecolor.
\nPlease also refer to kubectl official doc for kubectl autocomplete.

\n

Bash

\n

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

\n
# autocomplete for kubecolor\ncomplete -o default -F __start_kubectl kubecolor
\n

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

\n
complete -o default -F __start_kubectl k
\n

Zsh

\n

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

\n
# get zsh complete kubectl\nsource <(kubectl completion zsh)\nalias kubectl=kubecolor\n# make completion work with kubecolor\ncompdef kubecolor=kubectl
\n

fish

\n

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

\n

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

\n
    \n
  1. \n

    Use evanlucas/fish-kubectl-completions with kubecolor:

    \n\n
    2. \n
  2. \n

    Use awinecki/fish-kubecolor-completions

    \n

    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 for the kubecolor command.

    \n

    For this purpose, you can use awinecki/fish-kubecolor-completions.

    \n
    3. \n
\n

Specify what command to execute as kubectl

\n

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:

\n
KUBECTL_COMMAND=\"kubectl.1.19\" kubecolor get po
\n

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

\n

Supported kubectl version

\n

Because kubecolor internally calls kubectl command, if you are using unsupported kubectl version, it's also not supported by kubecolor.
\nKubernetes version support policy can be found in official doc.

\n

kubectl plugins

\n

Even if kubectl supports plugin feature, it is not supported by kubecolor, including Krew.
\nIt means you can use plugins from kubecolor (e.g. you can do kubecolor plugin_name xxx), but the result won't be colorized.

\n

Contributions

\n

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

\n

LICENSE

\n

MIT

\n

Author

\n

@hidetatz

","updatedAt":"2025-05-21T16:07:31Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"K8S-Tools","color":"2d411a"}},{"node":{"name":"hidetatz","color":"26704c"}}]},"comments":{"edges":[]}}},"pageContext":{"number":309,"previous":{"title":"kubeclipper/kubeclipper: KubeClipper 是一个轻量级的 Web 服务，为 Kubernetes 集群生命周期管理 提供友好的 Web 控制台 GUI、API 和 CLI 工具。","number":308},"next":{"title":"aylei/kubectl-debug: 能够便捷地进行 Kubernetes 上的 Pod 排障诊断工具","number":310}}}, "staticQueryHashes": ["151096407","2861350382"]}