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

## Hostname customization

This plugin automatically modifies the `HOST` variable when inside a toolbox container. This enables
prompt formats using `%m` to display the toolbox name with the format `toolbx-{name}` instead of just
the regular hostname.

For example, if you're in a toolbox named "dev", your prompt will show `toolbx-dev` instead of just `toolbx` wherever `%m` is used.

This functionality is enabled by default when loading the plugin and doesn't require any additional configuration.

## Aliases

| Alias | Command         | Description                          |
| ----- | --------------- | ------------------------------------ |
| tbe   | `toolbox enter` | Enters the toolbox environment       |
| tbr   | `toolbox run`   | Run a command in an existing toolbox |