diff options
| author | Carlo Sala <carlosalag@protonmail.com> | 2022-03-22 22:39:37 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-22 22:39:37 +0100 |
| commit | 50113a53f379b7d98e6921ba58e8440324beb32c (patch) | |
| tree | 574141ad53d1f3116f85d97cad073d3c69df9f44 /plugins/toolbox/README.md | |
| parent | c96fc233c4903ba75fba5bc55e7f91f9dc8e460e (diff) | |
| download | zsh-50113a53f379b7d98e6921ba58e8440324beb32c.tar.gz zsh-50113a53f379b7d98e6921ba58e8440324beb32c.tar.bz2 zsh-50113a53f379b7d98e6921ba58e8440324beb32c.zip | |
feat(toolbox): add plugin to show `toolbox` prompt info (#10685)
Diffstat (limited to 'plugins/toolbox/README.md')
| -rw-r--r-- | plugins/toolbox/README.md | 19 |
1 files changed, 19 insertions, 0 deletions
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)' +``` |