# vagrant-guest-plugin-skeleton-ruby

**Repository Path**: mirrors_hashicorp/vagrant-guest-plugin-skeleton-ruby

## Basic Information

- **Project Name**: vagrant-guest-plugin-skeleton-ruby
- **Description**: Template for building a Vagrant guest plugin in Ruby
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-10-24
- **Last Updated**: 2026-01-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vagrant-guest-plugin-ruby-template

This repo is a template for building a Ruby Vagrant guest plugin. Follow the steps to setup your own guest plugin!

1. Copy this repo. Its a template so follow the Github instructions to [create a repo from a template using the UI](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template), or use the github cli.
```
$ gh repo create vagrant-guest-myspecialguest --template hashicorp/vagrant-guest-plugin-ruby-template --public
```

#### Update the gemspec
2. Update the gemspec. Choose a good, descriptive name for your project. Rename `my-vagrant-guest-plugin-ruby-template.gemspec` to reflect this, and fill out the required information.

3. Rename all the references of `my-vagrant-guest-plugin-ruby-template.gemspec` to your new name.

#### Update the module
4. Rename `vagrant-guest.rb` to match the name of your plugin and update the contents of the file. This includes updating the module name `MyVagrantGuestPlugin`, the name and description fields and the ` guest(:myguestplugin) do` line.

5. Rename all the references of `MyVagrantGuestPlugin` to your new name.

6. Update the guest detection method in `lib/guest/guest.rb`. This method will be run by Vagrant to determine if the guest is running the OS assumed by the plugin.

#### Add capabilities
7. Add any new capabilities the plugin needs to the `guest/cap` module. Be sure to register the capabilities. 

#### Build and install your gem
8. Commit all your changes if you haven't already. 
```
$ git add -A
$ git commit -m "My Vagrant guest plugin"
```

9. Build your plugin
```
$ gem build my-vagrant-guest-plugin-ruby-template.gemspec 
  Successfully built RubyGem
  Name: my-vagrant-guest-plugin
  Version: 0.0.1
  File: my-vagrant-guest-plugin-0.0.1.gem
```

10. (optional) Push your gem to [RubyGems](https://rubygems.org/)
```
$ gem push my-vagrant-guest-plugin-0.0.1.gem
```

11. Install your plugin
```
# Install from the locally built gem
$ vagrant plugin install my-vagrant-guest-plugin-0.0.1.gem

# If you pushed the gem to RubyGems, install from RubyGems
$ vagrant plugin install my-vagrant-guest-plugin
```