From 1eb69e9a795cc19450178c07d8d382622bc7ad70 Mon Sep 17 00:00:00 2001 From: Pedro Pereira Date: Fri, 16 Oct 2026 15:19:13 -0300 Subject: first commit --- .config/zsh/oh-my-zsh/plugins/toolbox/README.md | 29 +++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .config/zsh/oh-my-zsh/plugins/toolbox/README.md (limited to '.config/zsh/oh-my-zsh/plugins/toolbox/README.md') 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..d957d9b --- /dev/null +++ b/.config/zsh/oh-my-zsh/plugins/toolbox/README.md @@ -0,0 +1,29 @@ +# 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)' +``` + +In the same way, it adds `toolbox_prompt_name()`, showing the name of the containerized environment. + +## Aliases + +| Alias | Command | Description | +| ----- | --------------- | ------------------------------------ | +| tbe | `toolbox enter` | Enters the toolbox environment | +| tbr | `toolbox run` | Run a command in an existing toolbox | -- cgit v1.3