From 50113a53f379b7d98e6921ba58e8440324beb32c Mon Sep 17 00:00:00 2001 From: Carlo Sala Date: Tue, 22 Mar 2022 22:39:37 +0100 Subject: feat(toolbox): add plugin to show `toolbox` prompt info (#10685) --- plugins/toolbox/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 plugins/toolbox/README.md (limited to 'plugins/toolbox/README.md') diff --git a/plugins/toolbox/README.md b/plugins/toolbox/README.md new file mode 100644 index 000000000..aac2bb3b0 --- /dev/null +++ b/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)' +``` -- cgit v1.2.3-70-g09d2