1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-22 05:40:08 +00:00
ohmyzsh/plugins/toolbox/README.md
SpeakinTelnet 2cb403e89f
feat(toolbox): add function to show toolbox name (#12594)
Co-authored-by: Carlo Sala <carlosalag@protonmail.com>
2024-08-02 16:37:00 +02:00

29 lines
941 B
Markdown

# 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 |