stow/oh-my-zsh/.oh-my-zsh/plugins/toolbox/README.md

   1 # toolbox plugin
   2
   3 Plugin for [toolbox](https://containertoolbx.org), a tool to use containerized CLI environments.
   4
   5 To use it, add `toolbox` to your plugins array in your `.zshrc` file:
   6
   7 ```zsh
   8 plugins=(... toolbox)
   9 ```
  10
  11 ## Prompt function
  12
  13 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.
  14
  15 You can use it by adding `$(toolbox_prompt_info)` to your `PROMPT` or `RPROMPT` variable:
  16
  17 ```zsh
  18 RPROMPT='$(toolbox_prompt_info)'
  19 ```
  20
  21 ## Aliases
  22
  23 | Alias | Command              | Description                            |
  24 |-------|----------------------|----------------------------------------|
  25 | tb    | `toolbox enter`      | Enters the toolbox environment         |