diff options
| author | SpeakinTelnet <105018871+SpeakinTelnet@users.noreply.github.com> | 2024-08-02 10:37:00 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-08-02 16:37:00 +0200 |
| commit | 2cb403e89f618548b340181b5690639768305aad (patch) | |
| tree | 0e84a89db709c46b9452854595f5ffc18511bab2 /plugins/toolbox/README.md | |
| parent | 0f752036988f7acc25c3ac87e1f6e268bb15e742 (diff) | |
| download | zsh-2cb403e89f618548b340181b5690639768305aad.tar.gz zsh-2cb403e89f618548b340181b5690639768305aad.tar.bz2 zsh-2cb403e89f618548b340181b5690639768305aad.zip | |
feat(toolbox): add function to show toolbox name (#12594)
Co-authored-by: Carlo Sala <carlosalag@protonmail.com>
Diffstat (limited to 'plugins/toolbox/README.md')
| -rw-r--r-- | plugins/toolbox/README.md | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/plugins/toolbox/README.md b/plugins/toolbox/README.md index bc04a906b..d957d9bc4 100644 --- a/plugins/toolbox/README.md +++ b/plugins/toolbox/README.md @@ -10,7 +10,8 @@ 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. +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: @@ -18,9 +19,11 @@ You can use it by adding `$(toolbox_prompt_info)` to your `PROMPT` or `RPROMPT` 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 | +| Alias | Command | Description | +| ----- | --------------- | ------------------------------------ | +| tbe | `toolbox enter` | Enters the toolbox environment | +| tbr | `toolbox run` | Run a command in an existing toolbox | |