Install and configure a new Craft project using Ruby and Rake.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


Instructions for installing and configuring a new Craft project using Ruby and Rake. For more on the thinking behind craft-master, check out the introductory blog post.

Table of Contents

  1. Dependencies
  2. Getting Started
  3. Clone craft-master
  4. Install Dependencies
  5. Install and Configure Craft


  • MySQL (5.1.0+ with the InnoDB storage engine installed)
  • PHP (5.3.0+ with the mcrypt extension installed)
  • Ruby (2.1.0)
  • Bundler (1.5.2+)

Getting Started

Before you dive in, make sure you have a couple of pieces of information handy:

  1. Your project repository's Git clone URL (e.g. During installation, you'll be asked to provide this so that you can git push your work to your own repository.
  2. Choose a virtual host name for your local site (e.g.
  3. Know your database server's accessible address (e.g. or localhost) and the user and password that can access it.

Also, these instructions assume you have a passing familiarity with the command line, MySQL, PHP, and Ruby, and that you're using Mac OS X. This setup will likely work on other systems, but the instructions are geared toward Mac OS X.

Clone craft-master

To get started, issue the following command to clone this repository, substituting your-project-name as appropriate:

git clone your-project-name

Install Dependencies

Install MySQL and PHP with mcrypt extension

Homebrew is the easiest (and best!) way to install MySQL and PHP:

brew tap homebrew/dupes
brew tap homebrew/versions
brew tap homebrew/homebrew-php
brew install mysql php54-mcrypt

This will also install PHP 5.4 as a dependency. Be sure to follow the instructions listed in the Caveats to enable the mcrypt extension.

Install Ruby

Using rbenv or RVM, install Ruby 2.1.0.

If you use rbenv, issue the following command to set your local Ruby version:

rbenv local 2.1.0

If you're using RVM, issue the following command, substituting your-project-name as appropriate:

echo "rvm use 2.1.0@your-project-name --create" > .rvmrc

Install Bundler

gem install bundler

Install gems

Run bundle to install all required gems.

Install and Configure Craft

After starting up your local web and MySQL servers, run rake install and follow the prompts.

You'll be asked for a clone URL to your project's Git repository (e.g. and some basic database-related questions. Most everything else is automated.

Craft will download, install, and create configuration files based on your input.

Set up a Virtual Host

For Craft to work, you'll need to set up a virtual host with a ServerName of and a DocumentRoot pointed at the public folder in your working directory.

For convenience, the installer will output a sample bit of code for you to insert into your server's virtual hosts file (which, depending on your setup, may be located at /etc/apache2/extra/httpd-vhosts.conf).

Finish Craft installation

At this point, you should be able to navigate to and follow the remaining instructions for setting up Craft.

Congratulations, you're done!


Of course, craft-master wouldn't be possible without the hard work of the fine folks at Pixel & Tonic. Thanks!


Use of these tools indicates that you have read and accepted Craft's Terms and Conditions. Definitely give those a read. craft-master is not affiliated with Craft or Pixel & Tonic.

The source code and documentation for craft-master is licensed under the incredibly permissive MIT License.