Setting up your rebuild.info file

Type drush topic rebuild-example to see an example rebuild.info file.

A few things to note:

1. The rebuild.info file is written using the INI syntax and follows the same conventions as a standard Drupal .info file.
2. In general, "1" should be used to denote TRUE and "0" should be used to denote FALSE
3. In most cases, options for different commands like sql-sync and rsync follow the same conventions as their drush counter parts. So when in doubt, type "drush help sql-sync" to find out what valid options you can use in the sql_sync section.

Rebuilding from a remote source

This example is valid for cases where you want to rebuild from a remote source.

The description key lets you add a string that will be displayed to users who rebuild their local environment using the rebuild file. The description is optional.

The version key lets you specify a version of your info file. Useful for debugging with co-workers.

Drush Rebuild lets you rebuild your local environment based on any source defined in your drush alias, so you could rebuild based on @staging, @qa, or @production aliases for example. But more often than not, you want your local development environment to match one remote environment. By defining default_source you can save yourself some typing. You'll be able to run drush rebuild @example.local instead of drush rebuild @example.local --source=@example.prod

The sql_sync section lets you define options for syncing a remote database to your local environment. If you just wanted database syncing without any additional options, you could write:

sql_sync = 1

As of Drush Rebuild version 1.2, rsync is not fully supported. But the option above (files_only) works just fine. This will rsync the files from your remote environment (what is in sites/default/files) to your local environment. Use with caution for large sites.

In the future, all the options supported by drush rsync will be supported by Drush Rebuild.

The variables section is pretty straightforward - use the name of the variable and assign it a value.

In the code above, note that you can use placeholders. This requires a correctly configured Drush alias.

If the value is set to 1, Drush Rebuild will open your browser and log you into the site after the rebuild completes successfully. Set to 0, or don't include this in your rebuild.info file, if you don't want that behavior.

Define modules that you want to enable or disable.

This section is also straightforward. Note that if your pre_process or post_process script returns FALSE, the rebuild will halt.

This is useful when a team is using the same rebuild file. You can define a local overrides file, and exclude it from version control, so that each team member can customize the rebuild process to their liking.

Rebuilding with an install profile

Everything from the above applies except for the sql_sync and rsync sections. In place of that, you will want this:

Note that the placeholder refers to a value defined in the rebuild section of your Drush alias.