diff options
author | 2025-02-13 14:13:49 +0530 | |
---|---|---|
committer | 2025-02-13 14:13:49 +0530 | |
commit | 8a2e1006b3b272126332aa064f3ad95387129544 (patch) | |
tree | 944c80ac612a65980d94a54ba11b6c7102037ecf /.config/zsh/oh-my-zsh/plugins/toolbox/README.md | |
parent | dcbb16d8b08ff5956abef5e6478b59df2e93ad35 (diff) | |
download | dotfiles-master.tar.gz dotfiles-master.tar.bz2 dotfiles-master.zip |
Diffstat (limited to '.config/zsh/oh-my-zsh/plugins/toolbox/README.md')
-rw-r--r-- | .config/zsh/oh-my-zsh/plugins/toolbox/README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/.config/zsh/oh-my-zsh/plugins/toolbox/README.md b/.config/zsh/oh-my-zsh/plugins/toolbox/README.md new file mode 100644 index 0000000..aac2bb3 --- /dev/null +++ b/.config/zsh/oh-my-zsh/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)' +``` |