Contents

---
page_title: "Plugin Usage - Plugins"
sidebar_current: "plugins-usage"
---

# Plugin Usage

Installing a plugin is easy, and shouldn't take more than a few seconds.

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

<div class="alert alert-warn">
	<p>
		<strong>Warning!</strong> 3rd party plugins can introduce instabilities
		into Vagrant due to the nature of them being written by non-core users.
	</p>
</div>

## Installation

Plugins are installed using `vagrant plugin install`:

```
$ vagrant plugin install vagrant-example-plugin
...
```

Once a plugin is installed, it will automatically be loaded by Vagrant.
Plugins which cannot be loaded shouldn't 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 documentation
to see exactly how to use it. Plugins which add commands should be instantly
available via `vagrant`, provisioners should be available via
`config.vm.provision`, etc.

**Note:** In the future, the `vagrant plugin` command will include a
subcommand that will document the components that each plugin installs.

## Uninstallation

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

```
$ vagrant plugin uninstall vagrant-example-plugin
...
```

## Listing Plugins

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

Version data entries

5 entries across 5 versions & 2 rubygems

Version	Path
tamtam-vagrant-reload-1.1.3	vendor/cache/vagrant-0ac2a8738841/website/docs/source/v2/plugins/usage.html.md
tamtam-vagrant-reload-1.1.2	vendor/cache/vagrant-0ac2a8738841/website/docs/source/v2/plugins/usage.html.md
tamtam-vagrant-reload-1.1.1	vendor/cache/vagrant-0ac2a8738841/website/docs/source/v2/plugins/usage.html.md
tamtam-vagrant-reload-1.1	vendor/cache/vagrant-0ac2a8738841/website/docs/source/v2/plugins/usage.html.md
tnargav-1.3.3	website/docs/source/v2/plugins/usage.html.md