浏览代码

feat(toolbox): add plugin to show `toolbox` prompt info (#10685)

Carlo Sala 2 年之前
父节点
当前提交
50113a53f3
共有 2 个文件被更改,包括 22 次插入0 次删除
  1. 19 0
      plugins/toolbox/README.md
  2. 3 0
      plugins/toolbox/kubectx.plugin.zsh

+ 19 - 0
plugins/toolbox/README.md

@@ -0,0 +1,19 @@
+# toolbox plugin
+
+Plugin for [toolbox](https://containertoolbx.org), a tool to use containerized CLI environments.
+
+To use it, add `toolbox` to your plugins array in your `.zshrc` file:
+
+```zsh
+plugins=(... toolbox)
+```
+
+## Prompt function
+
+This plugins adds `toolbox_prompt_info()` function. Using it in your prompt, it will show the toolbox indicator ⬢ (if you are running in a toolbox container), and nothing if not.
+
+You can use it by adding `$(toolbox_prompt_info)` to your `PROMPT` or `RPROMPT` variable:
+
+```zsh
+RPROMPT='$(toolbox_prompt_info)'
+```

+ 3 - 0
plugins/toolbox/kubectx.plugin.zsh

@@ -0,0 +1,3 @@
+function toolbox_prompt_info() {
+  [[ -f /run/.toolboxenv ]] && echo "⬢"
+}