NAME
drush - shell scripting interface for Drupal
SYNOPSIS
drush [options] command...
DESCRIPTION
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
command prompt.
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
clear cache.
OPTIONS
-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
environments)
-v level, --verbose=level
Display extra information about the command.
-q, --quiet
Hide all output
-d, --debug
Display even more information, including internal messages.
-y, --yes
Assume 'yes' as answer to all prompts
-s, --simulate
Simulate all relevant actions (don't actually change the system)
-i, --include
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.
-b, --backend
Hide all output and return structured data (internal use only).
-p, --pipe
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.
COMMANDS
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,
etc).
help Print the help message. Use --filter to limit command list to
one command file (e.g. --filter=pm).
cron Run all cron hooks.
updatedb
Execute the update.php process from the command line
status Provides a birds-eye view of the current Drupal installation, if
any.
script Run php script(s).
cache clear
Clear all caches.
watchdog show
Shows recent watchdog log messages. Optionally filter for a
specific type.
watchdog delete
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
Disable one or more modules.
uninstall
Uninstall one or more modules.
statusmodules
Show module enabled/disabled status
refresh
Refresh update status information
updatecode
Update your project code
update Update your project code and apply any database updates required
(update.php)
info Release information for a project
dl Download core Drupal and projects like CCK, Zen, etc.
test mail
Run all tests and mail the results to your team.
test clean
Delete leftover tables and files from prior test runs.
sql conf
Print database connection details.
sql connect
A string for connecting to the DB.
sql dump
Exports the Drupal DB as SQL using mysqldump.
sql query
Execute a query against the site database.
sql load
Copy source database to target database.
sql cli
Open a SQL command-line interface using Drupal's credentials.
FILES
/etc/drush/drushrc.php
/usr/share/doc/drush/examples/example.drushrc.php
SEE ALSO
cvs(1), svn(1), wget(1).
AUTHOR
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
Rossouw.
This manual page was written by Antoine Beaupr <anarcat@koumbit.org>,
for the Debian project (but may be used by others).
June 11, 2009