How do I install vagrant-host-shell plugin?

Install it via the command `vagrant plugin install vagrant-host-shell`, as per the README, which requires Vagrant to be installed and operational on your host machine.

Can vagrant-host-shell run commands on a Windows host?

Yes, it should work on Windows if Vagrant supports it, but you may need to adjust shell commands for Windows-specific syntax or use PowerShell scripts instead of Bash commands.

How to handle errors when using vagrant-host-shell?

The plugin outputs stderr for visibility, but for robust error handling, wrap commands in scripts that check exit codes or use external tools, as it lacks built-in error recovery mechanisms.

vagrant-host-shell vs. using Ansible for host provisioning?

vagrant-host-shell is simpler and integrated with Vagrant for basic tasks, but Ansible offers more features like idempotency and complex playbooks, making it better for advanced provisioning needs.

How to run multiple commands with vagrant-host-shell?

Chain commands in the inline string using semicolons or reference a host-side script file in the configuration, though the plugin doesn't natively support command arrays or advanced sequencing.

Is vagrant-host-shell secure for production environments?

Primarily designed for development and testing; in production, ensure commands are validated and sanitized, as arbitrary host execution can pose security risks if misconfigured.

vagrant-host-shell

MITRuby

A Vagrant provisioner plugin that executes shell commands on the host machine during VM provisioning.

GitHub

What is vagrant-host-shell?

vagrant-host-shell is a Vagrant plugin that acts as a provisioner to execute shell commands on the host machine during VM provisioning. It solves the problem of automating host-side tasks—like creating files, running scripts, or setting up environments—when a Vagrant virtual machine boots or is reprovisioned.

Target Audience

Developers and DevOps engineers using Vagrant for local development or testing who need to automate host machine setup or tasks in sync with their VM lifecycle.

Value Proposition

It fills a specific gap in Vagrant's provisioning system by allowing host command execution, offering a simple, lightweight alternative to complex workarounds or external scripts.

Overview

simple vagrant provisioner that executes commands on the host

Use Cases

Best For

Automating host file creation or modification when a VM starts
Running host-side setup scripts during Vagrant provisioning

Related Projects

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub

113 stars17 forks0 contributors

Sending notifications or logging from the host during VM boot

Synchronizing host environment variables with VM provisioning

Executing host cleanup tasks after VM shutdown

Integrating host machine tools into Vagrant workflows

Not Ideal For

Projects using container-based virtualization like Docker, where host interaction is managed through different mechanisms and this plugin adds unnecessary complexity
Teams requiring robust error handling and stateful provisioning with dependencies, as vagrant-host-shell offers minimal error management
Environments with strict security policies that prohibit arbitrary host command execution from VM provisioning

Pros & Cons

Pros

Host-Side Automation

Enables running shell commands on the host during VM boot, automating tasks like file creation or environment setup directly from Vagrant workflows, as highlighted in the README example.

Simple Integration

Easily added to Vagrantfiles with a straightforward configuration block using the inline parameter, making it accessible without complex setup.

Lifecycle Synchronization

Triggers commands during `vagrant up` or `vagrant provision`, ensuring host tasks are tied to the VM lifecycle without relying on external scripts.

Output Visibility

Captures and displays stdout and stderr in Vagrant's output, providing clear feedback for debugging, as shown in the README with labeled output examples.

Cons

Limited Functionality

Focused only on shell command execution; lacks advanced features like conditional triggers, dependency management, or integration with other provisioning tools, which the minimal design admits.

Security Risks

Running arbitrary commands on the host from a VM provisioner can introduce vulnerabilities if inputs are not properly sanitized, a trade-off in its automation approach.

Vagrant Ecosystem Lock-in

Tied to Vagrant's ecosystem, making it unsuitable for projects not using Vagrant or moving to alternative virtualization solutions, limiting its portability.

Frequently Asked Questions

Home

Vagrant

vagrant-hostsupdater

Vagrant Hostsupdater is a plugin for Vagrant that automatically adds and removes entries in the host system's `/etc/hosts` file. It simplifies local development by mapping hostnames to the IP addresses of Vagrant virtual machines, eliminating the need for manual hosts file edits. ## Key Features - **Automatic Hosts Management** — Adds entries on `vagrant up`, `resume`, and `reload`, and removes them on `halt`, `destroy`, and `suspend`. - **Alias Support** — Allows defining multiple hostname aliases for a single IP address. - **Multiple Network Adapters** — Supports mapping specific hostnames to different private network IPs using a hash configuration. - **Skip Option** — Enables skipping hosts updates for specific network configurations with a `hostsupdater: "skip"` flag. - **Privilege Escalation Control** — Provides instructions for suppressing sudo/UAC prompts on Linux, macOS, and Windows. - **Cloud Provider Integration** — Includes support for AWS and Google Cloud providers, detecting public IPs from instance tags or names. ## Philosophy It aims to streamline the development workflow by automating a repetitive manual task, ensuring that hostname resolution works seamlessly across Vagrant environments.

Stars1,152

Forks128

Last commit4 years ago

sahara

a plugin for vagrant that allows you manage a sandbox state

Stars731

Forks51

Last commit6 years ago

vagrant-scp

Copy files to a Vagrant VM via SCP.

Stars314

Forks31

Last commit4 years ago

vagrant-cachier

share a common package (apt-get, npm, etc.) cache among similar VM instances