» Plugin Usage

Installing a Vagrant plugin is easy, and should not take more than a few seconds.

Please refer to the documentation of any plugin you plan on using formore information on how to use it, but there is one common method forinstallation and plugin activation.

Warning! 3rd party plugins can introduce instabilitiesinto Vagrant due to the nature of them being written by non-core users.

» Installation

Plugins are installed using vagrant plugin install:

# Installing a plugin from a known gem source
$ vagrant plugin install my-plugin
# Installing a plugin from a local file source
$ vagrant plugin install /path/to/my-plugin.gem

Once a plugin is installed, it will automatically be loaded by Vagrant.Plugins which cannot be loaded should not crash Vagrant. Instead,Vagrant will show an error message that a plugin failed to load.

» Usage

Once a plugin is installed, you should refer to the plugin's documentationto see exactly how to use it. Plugins which add commands should be instantlyavailable via vagrant, provisioners should be available viaconfig.vm.provision, etc.

Note: In the future, the vagrant plugin command will include asubcommand that will document the components that each plugin installs.

» Updating

Plugins can be updated by running vagrant plugin update. This willupdate every installed plugin to the latest version. You can update aspecific plugin by calling vagrant plugin update NAME. Vagrant willoutput what plugins were updated and to what version.

To determine the changes in a specific version of a plugin, refer tothe plugin's homepage (usually a GitHub page or similar). It is theplugin author's responsibility to provide a change log if he or shechooses to.

» Uninstallation

Uninstalling a plugin is as easy as installing it. Just use thevagrant plugin uninstall command and the plugin will be removed. Example:

$ vagrant plugin uninstall my-plugin

» Listing Plugins

To view what plugins are installed into your Vagrant environment atany time, use the vagrant plugin list command. This will list the pluginsthat are installed along with their version.