feat: move configuration files inside home folder
This commit is contained in:
29
home/.config/zsh/ohmyzsh/plugins/toolbox/README.md
Normal file
29
home/.config/zsh/ohmyzsh/plugins/toolbox/README.md
Normal file
@ -0,0 +1,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 |
|
Reference in New Issue
Block a user