Before we install vagrant-spk, some advice for how to succeed at the installation process.

  • Learn about Sandstorm, if you haven't already. Try using Sandstorm at our demo server to get a feel for how it operates.
  • Open a "terminal" on your Mac or Linux system or "command prompt" on Windows.
  • Don't use sudo unless we tell you to!

System requirements: vagrant-spk requires a 64-bit computer with at least 1GB of RAM. Your computer probably is fine. We've tested this tutorial on Mac OS, GNU/Linux, and Windows.

Ensure git is installed

Windows users: You should skip this git step. Continue to the next section to ensure Vagrant is installed.

Mac or Linux users: This installation process uses git to download vagrant-spk, so you need git on your computer. We'll first check if git is currently installed.

In the terminal, type the following and press enter.

git --version

You should see a message like:

git version x.y.z

If so, git is properly installed and you can skip this section.

If you saw instead a message like:

git: Command not found.

Then you need to install git via the following instructions.

  • Mac OS: Visit the official git for Mac download page and follow their instructions.
  • Linux: Run: sudo apt-get install git if you use Debian or Ubuntu. On other Linux systems, use your package manager to install git.
  • Windows: We recommend you skip setting up git and proceed to the next section to ensure Vagrant is installed. If you really want git, you can install it via the msysgit installer.

Ensure Vagrant is installed

In this tutorial, we use Vagrant (along with other tools) to create a Linux virtual machine where your app will run, alongside Sandstorm.

To check if it is installed, in the terminal, type the following and press enter.

vagrant version

You should see a message like:

Installed Version: 1.7.2

If so, Vagrant is installed properly, and you can skip the rest of this section.

If instead you see a message like:

vagrant: Command not found.

Then you need to install Vagrant.

Mac, Windows, or Linux users: Visit the official Vagrant website and follow their instructions to install it.

Ensure VirtualBox is installed

In this tutorial, we use VirtualBox to emulate a computer on which we run Linux, controlled via Vagrant.

Windows users: To check if VirtualBox is properly installed on Windows systems, press the Windows key on your keyboard. This should open a program launcher. Type "virtualbox" into the program launcher. If you see a program you can launch whose name resembles "Oracle VirtualBox", then you can can skip to the next section. If not, then you will need to keep reading this section and install VirtualBox.

Mac or Linux users: To check if VirtualBox is installed properly on Mac OS or Linux systems, in the terminal, type the following and press enter:

VirtualBox --help

You should see a lot of output, for example:

Oracle VM VirtualBox Manager x.y.z
(C) 2005-2015 Oracle Corporation
All rights reserved.

If so, skip the rest of this section, as VirtualBox is already properly installed.

If you saw instead:

VirtualBox: Command not found.

Mac, Windows, or Linux users: To install VirtualBox, you can do the following:

  • Visit the VirtualBox downloads page
  • In the top, underneath VirtualBox platform packages, find the package for your operating system. Click the link, download, and install it.
  • Once you are done with that, go to the top of this section and make sure VirtualBox is installed.

No need to install Sandstorm directly

You do not need Sandstorm installed on your computer before you start packaging an app. Sandstorm's vagrant-spk helper tool handles installing it for you. As an implementation detail, vagrant-spk creates an isolated virtual machine for each app you are developing, and each virtual machine will have Sandstorm installed.

Install vagrant-spk

Finally, you can install vagrant-spk itself. This tool uses Vagrant and VirtualBox so that you can run your app within Sandstorm on a Linux virtual machine.

Windows users: Run the vagrant-spk installer EXE. To get it:

  • Visit the vagrant-spk releases list.

  • Download and run the latest EXE file, whose name is typically vagrant-spk-setup-v1.n.exe. You may need administrator privileges to successfully run the installer. This will result in a vagrant-spk executable on your system path.

You can test it by launching a new Command Prompt and typing vagrant-spk, which should result a message starting with usage: .... If so, you have successfully installed vagrant-spk. To upgrade in the future, download and run any newer version of the vagrant-spk setup EXE.

Mac or Linux users: Download vagrant-spk via git.

To do that, in your terminal, run the following commands.

mkdir -p ~/projects
cd ~/projects
git clone
cd vagrant-spk
sudo ln -s $PWD/vagrant-spk /usr/local/bin

If you prefer different paths, that is OK; adjust these steps to your liking.

To upgrade in the future, cd into this directory and run git pull.