1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-28 07:11:57 +00:00
ohmyzsh/plugins/toolbox/README.md
2022-06-15 16:14:19 +02:00

25 lines
793 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)'
```
## Aliases
| Alias | Command | Description |
|-------|----------------------|----------------------------------------|
| tb | `toolbox enter` | Enters the toolbox environment |