blob: d957d9bc4cae265bb6ca751edc0ecff91554930a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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 |
|
