1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-30 16:21:59 +00:00
ohmyzsh/plugins/vagrant-prompt/README.md

1.7 KiB

vagrant-prompt

This plugin prompts the status of the Vagrant VMs. It supports single-host and multi-host configurations as well.

To use it, add vagrant-prompt to the plugins array in your zshrc file:

plugins=(... vagrant-prompt)

Alberto Re alberto.re@gmail.com

Usage

To display Vagrant info on your prompt add the vagrant_prompt_info to the $PROMPT or $RPROMPT variable in your theme. Example:

PROMPT="$PROMPT"' $(vagrant_prompt_info)'
# or
RPROMPT='$(vagrant_prompt_info)'

Customization

vagrant_prompt_info makes use of the following custom variables, which can be set in your .zshrc file:

ZSH_THEME_VAGRANT_PROMPT_PREFIX="%{$fg_bold[blue]%}["
ZSH_THEME_VAGRANT_PROMPT_SUFFIX="%{$fg_bold[blue]%}]%{$reset_color%} "
ZSH_THEME_VAGRANT_PROMPT_RUNNING="%{$fg_no_bold[green]%}●"
ZSH_THEME_VAGRANT_PROMPT_POWEROFF="%{$fg_no_bold[red]%}●"
ZSH_THEME_VAGRANT_PROMPT_SUSPENDED="%{$fg_no_bold[yellow]%}●"
ZSH_THEME_VAGRANT_PROMPT_NOT_CREATED="%{$fg_no_bold[white]%}○"

State to variable mapping

The plugin uses the output reported by vagrant status to print whichever symbol matches, according to the following table:

State Symbol
running ZSH_THEME_VAGRANT_PROMPT_RUNNING
not running ZSH_THEME_VAGRANT_PROMPT_POWEROFF
poweroff ZSH_THEME_VAGRANT_PROMPT_POWEROFF
paused ZSH_THEME_VAGRANT_PROMPT_SUSPENDED
saved ZSH_THEME_VAGRANT_PROMPT_SUSPENDED
suspended ZSH_THEME_VAGRANT_PROMPT_SUSPENDED
not created ZSH_THEME_VAGRANT_PROMPT_NOT_CREATED