summaryrefslogtreecommitdiff
path: root/plugins/kubectx/README.md
diff options
context:
space:
mode:
authorStanisław Szydło <st4nson@gmail.com>2021-06-13 17:23:13 +0200
committerGitHub <noreply@github.com>2021-06-13 08:23:13 -0700
commit5152d381bb828a4ed41fdbb430eb05970a8bb25c (patch)
treeab6cc49ab3ab9b7bd3b1f755dcedfe047666676b /plugins/kubectx/README.md
parentc65153739adc34b68ebf8b37dbd61dd845a55790 (diff)
downloadzsh-5152d381bb828a4ed41fdbb430eb05970a8bb25c.tar.gz
zsh-5152d381bb828a4ed41fdbb430eb05970a8bb25c.tar.bz2
zsh-5152d381bb828a4ed41fdbb430eb05970a8bb25c.zip
feat(kubectx): adding a new plugin for 'kubectx' (#6114)
Co-authored-by: Marc Cornellà <marc.cornella@live.com> Co-authored-by: Robby Russell <robby@planetargon.com>
Diffstat (limited to 'plugins/kubectx/README.md')
-rw-r--r--plugins/kubectx/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/plugins/kubectx/README.md b/plugins/kubectx/README.md
new file mode 100644
index 000000000..9a1df2617
--- /dev/null
+++ b/plugins/kubectx/README.md
@@ -0,0 +1,26 @@
+# kubectx - show active kubectl context
+
+This plugins adds ```kubectx_prompt_info()``` function. It shows name of the
+active kubectl context (```kubectl config current-context```).
+
+You can use it to customize prompt and know if You are on prod cluster ;)
+
+_Example_. Add to **.zshrc**:
+
+```
+RPS1='$(kubectx_prompt_info)'
+```
+
+### custom ctx names
+
+One can rename default context name for better readability.
+
+_Example_. Add to **.zshrc**:
+```
+kubectx_mapping[minikube] = "mini"
+kubectx_mapping[context_name_from_kubeconfig]="$emoji[wolf_face]"
+kubectx_mapping[production_cluster]="%{$fg[yellow]%}prod!%{$reset_color%}"
+```
+
+![staging](stage.png)
+![production](prod.png)