{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/328", "result": {"data":{"issuesJson":{"id":"eb5f384b-b355-59f4-a2a9-0f61e498f778","title":"jonmosco/kube-ps1: Kubernetes Bash/Zsh提示符插件。","number":328,"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
Reposjonmosco/kube-ps1
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

kube-ps1: Kubernetes prompt for bash and zsh

\n

\"GitHub
\n\"CI\"

\n

A script that lets you add the current Kubernetes context and namespace
\nconfigured on kubectl to your Bash/Zsh prompt strings (i.e. the $PS1).

\n

Inspired by several tools used to simplify usage of kubectl.

\n

\"prompt

\n

Installing

\n

Packages

\n

MacOS Brew Ports

\n

Homebrew package manager:

\n
brew update\nbrew install kube-ps1
\n

Arch Linux

\n

AUR Package available at https://aur.archlinux.org/packages/kube-ps1/.

\n

Oh My Zsh

\n

https://github.com/ohmyzsh/ohmyzsh

\n

kube-ps1 is included as a plugin in the oh-my-zsh project. To enable it, edit your ~/.zshrc and
\nadd the plugin:

\n
plugins=(\n  kube-ps1\n)\nPROMPT='$(kube_ps1)'$PROMPT # or RPROMPT='$(kube_ps1)'
\n

Zsh zinit plugin

\n

Using zinit

\n

Update .zshrc with:

\n
zinit light jonmosco/kube-ps1\nPROMPT='$(kube_ps1)'$PROMPT # or RPROMPT='$(kube_ps1)'
\n

Fig

\n

Install kube-ps1 in zsh, bash, or fish with one click.

\n

\n

From Source (git clone)

\n
    \n
  1. Clone this repository
    2. \n
  2. Source the kube-ps1.sh in your ~/.zshrc or your ~/.bashrc
    3. \n
\n

Zsh

\n
source /path/to/kube-ps1.sh\nPROMPT='$(kube_ps1)'$PROMPT # or RPROMPT='$(kube_ps1)'
\n

Bash

\n
source /path/to/kube-ps1.sh\nPS1='[\\u@\\h \\W $(kube_ps1)]\\$ '
\n

Requirements

\n

The default prompt assumes you have the kubectl command line utility installed.
\nOfficial installation instructions and binaries are available:

\n

Install and Set up kubectl

\n

If using this with OpenShift, the oc tool needs installed. It can be obtained
\nfrom brew ports:

\n
brew install openshift-cli
\n

or the source can be downloaded:

\n

OC Client Tools

\n

Set the binary to oc with the following variable:

\n
KUBE_PS1_BINARY=oc
\n

If neither binary is available, the prompt will print the following:

\n
(<symbol>|BINARY-N/A:N/A)
\n

Helper utilities

\n

There are several great tools that make using kubectl very enjoyable:

\n\n

Tmux port

\n

I have begun porting kube-ps1 to tmux as a status line plugin. If you prefer
\ntmux, and like the functionality provided by kube-ps1, checkout the
\nkube-tmux project

\n

Prompt Structure

\n

The default prompt layout is:

\n
(<symbol>|<context>:<namespace>)\n
\n

If the current-context is not set, kube-ps1 will return the following:

\n
(<symbol>|N/A:N/A)\n
\n

Enabling/Disabling

\n

If you want to stop showing Kubernetes status on your prompt string temporarily
\nrun kubeoff. To disable the prompt for all shell sessions, run kubeoff -g.
\nYou can enable it again in the current shell by running kubeon, and globally
\nwith kubeon -g.

\n
kubeon     : turn on kube-ps1 status for this shell.  Takes precedence over\n             global setting for current session\nkubeon -g  : turn on kube-ps1 status globally\nkubeoff    : turn off kube-ps1 status for this shell. Takes precedence over\n             global setting for current session\nkubeoff -g : turn off kube-ps1 status globally\n
\n

Symbol

\n

The default symbols are UTF8 and should work with most fonts. If you want to use the Kubernetes and OpenShift
\nglyphs, you need to install a patched font that contains the glyph. Nerd Fonts provides both glyphs. Follow their installation instructions to install the patched font.

\n

KUBE_PS1_SYMBOL_CUSTOM options

\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
OptionsSymbolDescription
default (empty string)⎈Default symbol (Unicode \\u2388)
img☸️Symbol often used to represent Kubernetes (Unicode \\u2638)
oc\"openshift-glyph\"Symbol representing OpenShift (Unicode \\ue7b7)
k8s\"k8s-glyph\"Symbol representing Kubernetes (Unicode \\ue7b7)
\n

To set the symbol to one of the custom glyphs, add the following to your ~/.bashrc or ~/.zshrc:

\n
KUBE_PS1_SYMBOL_CUSTOM=img
\n

To set the symbol to the default, set the KUBE_PS1_SYMBOL to an empty string.

\n

Heres a demo of the symbols in action:
\n\"kube-ps1-symbols\"

\n

If the font is not properly installed, and the glyph is not available, it will display an empty set of brackets or similar:

\n
 echo -n \"\\ue7b7\"\n
\n

Customization

\n

The default settings can be overridden in ~/.bashrc or ~/.zshrc by setting
\nthe following variables:

\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\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\n\n\n\n\n\n
VariableDefaultMeaning
KUBE_PS1_BINARYkubectlDefault Kubernetes binary
KUBE_PS1_NS_ENABLEtrueDisplay the namespace. If set to false, this will also disable KUBE_PS1_DIVIDER
KUBE_PS1_PREFIX(Prompt opening character
KUBE_PS1_SYMBOL_ENABLEtrue Display the prompt Symbol. If set to false, this will also disable KUBE_PS1_SEPARATOR
KUBE_PS1_SYMBOL_PADDINGfalseAdds a space (padding) after the symbol to prevent clobbering prompt characters
KUBE_PS1_SYMBOL_CUSTOM⎈ Change the Default prompt symbol. Unicode \\u2388. Options are k8s, img, oc
KUBE_PS1_SYMBOL_COLORblueChange the Default symbol color.
KUBE_PS1_SEPARATOR|Separator between symbol and context name
KUBE_PS1_DIVIDER:Separator between context and namespace
KUBE_PS1_SUFFIX)Prompt closing character
KUBE_PS1_CLUSTER_FUNCTIONNo default, must be user suppliedFunction to customize how cluster is displayed
KUBE_PS1_NAMESPACE_FUNCTIONNo default, must be user suppliedFunction to customize how namespace is displayed
KUBE_PS1_HIDE_IF_NOCONTEXTfalseHide the kube-ps1 prompt if no context is set
\n

To disable a feature, set it to an empty string:

\n
KUBE_PS1_SEPARATOR=''
\n

Colors

\n

The default colors are set with the following variables:

\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\n\n\n\n\n\n
VariableDefaultMeaning
KUBE_PS1_PREFIX_COLORnullSet default color of the prompt prefix
KUBE_PS1_SYMBOL_COLORblueSet default color of the Kubernetes symbol
KUBE_PS1_CTX_COLORredSet default color of the context
KUBE_PS1_SUFFIX_COLORnullSet default color of the prompt suffix
KUBE_PS1_NS_COLORcyanSet default color of the namespace
KUBE_PS1_BG_COLORnullSet default color of the prompt background
\n

Blue was used for the default symbol to match the Kubernetes color as closely
\nas possible. Red was chosen as the context name to stand out, and cyan for the
\nnamespace.

\n

Set the variable to an empty string if you do not want color for each
\nprompt section:

\n
KUBE_PS1_CTX_COLOR=''
\n

Names are usable for the following colors:

\n
black, red, green, yellow, blue, magenta, cyan\n
\n

256 colors are available by specifying the numerical value as the variable
\nargument.

\n

Customize display of cluster name and namespace

\n

You can change how the cluster name and namespace are displayed using the
\nKUBE_PS1_CLUSTER_FUNCTION and KUBE_PS1_NAMESPACE_FUNCTION variables
\nrespectively.

\n

For the following examples let's assume the following:

\n

cluster name: sandbox.k8s.example.com
\nnamespace: alpha

\n

If you're using domain style cluster names, your prompt will get quite long
\nvery quickly. Let's say you only want to display the first portion of the
\ncluster name (sandbox), you could do that by adding the following:

\n
function get_cluster_short() {\n  echo \"$1\" | cut -d . -f1\n}\n\nKUBE_PS1_CLUSTER_FUNCTION=get_cluster_short
\n

The same pattern can be followed to customize the display of the namespace.
\nLet's say you would prefer the namespace to be displayed in all uppercase
\n(ALPHA), here's one way you could do that:

\n
function get_namespace_upper() {\n    echo \"$1\" | tr '[:lower:]' '[:upper:]'\n}\n\nexport KUBE_PS1_NAMESPACE_FUNCTION=get_namespace_upper
\n

In both cases, the variable is set to the name of the function, and you must have defined the function in your shell configuration before kube_ps1 is called. The function must accept a single parameter and echo out the final value.

\n

Bug Reports and shell configuration

\n

Due to the vast ways of customizing the shell, please try the prompt with a
\nminimal configuration before submitting a bug report.

\n

This can be done as follows for each shell before loading kube-ps1:

\n

Bash:

\n
bash --norc
\n

Zsh:

\n
zsh -f\nor\nzsh --no-rcs
\n

For the prompt symbol, a patched font that contains the glyphs must be installed.
\nNerd Fonts Downloads provides patched
\nfonts containing the glyphs. Please consult their documentation for this, support
\nis out of scope for this project.

\n

Contributors

\n

Thank you to everyone in the community for their contributions to kube-ps1!

\n\n \n","updatedAt":"2025-05-21T16:08:44Z","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":"jonmosco","color":"771853"}}]},"comments":{"edges":[]}}},"pageContext":{"number":328,"previous":{"title":"prometheus-operator/kube-prometheus: 使用 Prometheus 监控 Kubernetes 和在 Kubernetes 上运行的应用程序","number":327},"next":{"title":"resmoio/kubernetes-event-exporter: 将 K8s 的事件同步到其他平台中，比如 ES，Kafka，file，Webhook 等","number":329}}}, "staticQueryHashes": ["151096407","2861350382"]}