From 2cb403e89f618548b340181b5690639768305aad Mon Sep 17 00:00:00 2001 From: SpeakinTelnet <105018871+SpeakinTelnet@users.noreply.github.com> Date: Fri, 2 Aug 2024 10:37:00 -0400 Subject: feat(toolbox): add function to show toolbox name (#12594) Co-authored-by: Carlo Sala --- plugins/toolbox/README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) (limited to 'plugins/toolbox/README.md') 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 | -- cgit v1.2.3-70-g09d2