Development Environment Setup

Before you can compile, you need to set up our development environment. You only need to do this once.

When you see $ it means this is a shell command - run the command after the $ but don’t include the $. The shell commands may also be prefixed with a folder name, meaning it needs to be run from a particular location, e.g. foo/ $ ls means to run ls from the foo folder.

Install Git

You need to install Git to retrieve the source code repository for the vi-firmware.


Install GitHub for Windows, which includes a GUI for cloning Git repositories hosted at GitHub as well as a Bash terminal for using Git from the command line.

Mac OS X

Install GitHub for Mac, which includes a GUI for cloning Git repositories hosted at GitHub and also installs the git command line tools.


If you’re using Linux, you hopefully know what you’re doing and can install Git for your distro of choice. A couple of examples:


$ sudo apt-get install git

Arch Linux:

$ [sudo] pacman -S git

Clone the vi-firmware Repository

On Windows or Mac and you installed the GitHub app, open the vi-firmware repository in you browser and click the “Clone in Desktop” button.

If you are using git from the command line, clone it like so:

$ git clone

Native Development

Don’t want to use Vagrant? There are varying levels of support for compiling in your native OS - see the native development environment docs.