A wrapper plugin for vagrant that allows for
calling vagrant
commands from outside of the box directory. The plugin also
ships with a few extra commands that help to manage more than one box, along
with custom tab-completion for both zsh
and bash
.
View on GitHub | GitHub Pages
This program's purpose is best explained with a screenshot. Notice, I'm running
the commands from within my home directory, which is not where my vagrant box
directories are located.
Clone the repository in your $ZSH_CUSTOM/plugins
directory. Note that the
directory name needs to be vb
, so clone it as such.
git clone https://github.com/evanthegrayt/vagrant-box-wrapper.git \
$ZSH_CUSTOM/plugins/vb
Then add the plugin to your $HOME/.zshrc
file in the plugins
array:
plugins=(vb) # Obviously, leave your other plugins in the array.
Clone the repository in your $BASH_IT_CUSTOM
directory
git clone https://github.com/evanthegrayt/vagrant-box-wrapper.git \
$BASH_IT_CUSTOM/vb
Files in this directory that end with .bash
are automatically sourced, so
there's nothing else to do.
Clone the repository wherever you like, and source either the vb.plugin.zsh
file for zsh
, or vb.plugin.bash
file for bash
, from one of your startup
files, such as ~/.zshrc
or ~/.bashrc
, respectively.
# Where $INSTALLATION_PATH is the path to where you installed the plugin.
source $INSTALLATION_PATH/vb.plugin.zsh # in ~/.zshrc
source $INSTALLATION_PATH/vb.plugin.bash # in ~/.bashrc
If you're using a version of zsh
/bash
that doesn't support the completion
features, or you just don't want to use them, just source the vb.sh
file
directly.
source $INSTALLATION_PATH/vb.sh # in either ~/.zshrc or ~/.bashrc
To use this function, you need to add VB_BOXES_LOCATION=[dir]
and
VB_BOXES=([BOX NAMES])
as variables in either a startup file, or a file named
$HOME/.vbrc
.
VB_BOX_LOCATION
should be a string set to the path where the boxes are located.VB_BOXES
should be an array, with each element being a directory that contains a vagrant box.
# These lines should go in either a startup file, such as `~/.zshrc` or
# `~/.bashrc`, or ~/.vbrc.
VB_BOXES_LOCATION="/path/to/where/boxes/are"
VB_BOXES=(vagrant_box_1 vagrant_box_2 vagrant_box_3)
You can view my .vbrc
file
here.
The vb
command comes with a few unique arguments.
Argument | What it does |
---|---|
switch |
Switches the box to the next in the array. |
list |
Displays all available boxes, and which is currently being used. |
cd |
Changes your current directory to the current box location. |
echo |
Lists the full path to the current box. |
use [BOX] |
Skips cycling of boxes and sets current box to BOX . |
-h |
Gives a brief usage. |
Any other argument, vb
will attempt to forward to the vagrant
command. Use
this feature to run common vagrant
commands, such as up
, ssh
, halt
,
etc., from anywhere.
You can enable/disable colored terminal output, and even change
the colors, by adding the following to your ~/.vbrc
or a startup file.
VB_COLOR=false # Default: true. Setting to false disables colors
# The following lines would make the colored output bold.
VB_SUCCESS_COLOR='\e[1;92m' # Bold green. Default: '\e[0;92m' (green)
VB_WARNING_COLOR='\e[1;93m' # Bold yellow. Default: '\e[0;93m' (yellow)
VB_ERROR_COLOR='\e[1;91m' # Bold red. Default: '\e[0;91m' (red)
By default, the cache file is $ZSH_CACHE_DIR/vb.cache
if running .oh-my-zsh
,
or ~/.cache/vb/vb.cache
if not. To change this, change VB_CACHE
to a
directory or file name in ~/.vbrc
or a startup file. Note that if pointed to a
directory (either an existing directory, or a string ending in /
), the file
name will always be named vb.cache
. If the directory doesn't exist, it will be
created with mkdir -p
.
VB_CACHE=$HOME/.vb.cache
If you have an idea or find a bug, please create an issue. Just make sure the topic doesn't already exist.
If you have an issue with tab-completion, make sure you have completion enabled for your shell (bash / zsh). If, after reading the manual, you still have problems, feel free to submit an issue.
I do these projects for fun, and I enjoy knowing that they're helpful to people. Consider starring the repository if you like it! If you love it, follow me on github!