Work with Drush

Drush is a command-line shell and scripting interface for Drupal, a veritable Swiss Army knife designed to make life easier for those who spend their working hours hacking away at the command prompt. Drush commands can, for example, be used to clear the Drupal cache, run module and database updates, revert features, perform database imports and dumps, and a whole lot more. You can reference the full set of Drush commands at If you have never used Drush before, you can learn more about it on the Drush GitHub Repository

You can use the CLI to set up Drush aliases, to easily run Drush commands on specific remote environments.

note Platform's CLI requires Drush 6 or greater.

Include Drush in your project

You can easily add Drush to your project using the dependencies property in

        "drush/drush": "^8.0"

Install Drush locally

Install drush with Composer:

$ composer global require drush/drush

At the end of the installation, you should be able to run:

$ drush

And see a list of available commands.

Use drush aliases

Create Drush aliases

Drush aliases make it easy to manage your development websites. Here's an example of a Drush alias file.

The CLI generates Drush aliases for you automatically, when you run platform get [project_id]. To see the aliases that are created, run platform drush-aliases and you should get output similar to that below:

$ platform drush-aliases
Aliases for My Site (tqmd2kvitnoly):

Use make files

Create a make file can automatically build your site using Drush make files. This allows you to easily test specific versions, apply patches and keep your site up to date. It also keeps your working directory much cleaner, since it only contains your custom code.

Your make file can be called: project.make or drupal-org.make.

You can find an example make file on GitHub.

When building as a profile, you need a make file for Drupal core called: project-core.make:

api = 2
core = 7.x

projects[drupal][type] = core

Generate a make file from an existing site

If you want to generate a make file from your existing site, you can run:

$ drush make-generate project.make

This will output a make file containing all your contributed modules, themes and libraries.

Apply patches

You can apply contributed patches to your modules, themes or libraries within your project.make:

projects[features][version] = "2.2"
projects[features][patch][] = ""

You can also apply self-hosted patches. Simply create a PATCHES folder at the root of your repository and add the patch as follow:

projects[uuid][version] = "1.0-alpha5"
projects[uuid][patch][] = "PATCHES/fix-non-uuid-entity-load.patch"

Work with DEV version

When you are using a module that is in a DEV version, the best practice is to always target a specific commit ID so that you're always building the same "version" of the module:

; CKEditor module: version 7.x-1.15+2-dev
projects[ckeditor][download][revision] = "b29372fb446b547825dc6c30587eaf240717695c"
projects[ckeditor][download][type] = "git"
projects[ckeditor][download][branch] = "7.x-1.x"
projects[ckeditor][type] = "module"