drush - shell scripting interface for Drupal
drush [options] command...
drush is a veritable Swiss Army knife designed to make life easier for
those of us who spend some of our working hours hacking away at the
Drush core ships with lots of useful commands for interacting with code
like modules/themes/profiles. Similarly, it runs update.php, executes
sql queries and DB migrations, and misc utilities like run cron or
-r path, --root=path
Drupal root directory to use (default: current directory)
-l uri, --uri=uri
URI of the drupal site to use (only needed in multisite
-v level, --verbose=level
Display extra information about the command.
Hide all output
Display even more information, including internal messages.
Assume 'yes' as answer to all prompts
Simulate all relevant actions (don't actually change the system)
A list of paths to search for drush commands
-c file, --config=file
Specify a config file to use. See example.drushrc.php
-u user, --user=user
Specify a user to login with. May be a name or a number.
Hide all output and return structured data (internal use only).
Emit a compact representation of the command for scripting.
If you get tired of typing options all the time, you can add them to
your drush.php alias or create a drushrc.php file. These provide
additional options for your drush call. They provide great flexibility
for a multi-site installation, for example. See example.drushrc.php.
Drush is all based around "commands" that are usually defined in
various modules. This manual only lists the builtin commands shipped
with the Drush core, but other modules may extend this list. See the
help command to see the up to date list. The list of available comands
may also vary based on the state of the Drupal accessed by drush (if
it's installed, offline, working or not, which modules are installed,
help Print the help message. Use --filter to limit command list to
one command file (e.g. --filter=pm).
cron Run all cron hooks.
Execute the update.php process from the command line
status Provides a birds-eye view of the current Drupal installation, if
script Run php script(s).
Clear all caches.
Shows recent watchdog log messages. Optionally filter for a
Delete all messages or only those of a specified type.
sync Rsync the Drupal tree to/from another server using ssh.
eval Evaluate arbitrary php code after bootstrapping Drupal.
enable Enable one or more modules.
Disable one or more modules.
Uninstall one or more modules.
Show module enabled/disabled status
Refresh update status information
Update your project code
update Update your project code and apply any database updates required
info Release information for a project
dl Download core Drupal and projects like CCK, Zen, etc.
Run all tests and mail the results to your team.
Delete leftover tables and files from prior test runs.
Print database connection details.
A string for connecting to the DB.
Exports the Drupal DB as SQL using mysqldump.
Execute a query against the site database.
Copy source database to target database.
Open a SQL command-line interface using Drupal's credentials.
cvs(1), svn(1), wget(1).
Drush was originally developed by Arto for Drupal 4.7 (this alpha code
can still be found in the DRUPAL-4-7 branch). In May 2007, it was
partly rewritten and redesigned for Drupal 5 by frando. Since 2008, the
module has been maintained by Moshe Weitzman, Owen Barton and Adrian
This manual page was written by Antoine Beaupr <firstname.lastname@example.org>,
for the Debian project (but may be used by others).
June 11, 2009