| help | Print this help message. See `drush help help` for more options. |
| core-cron | Run all cron hooks. |
| updatedb | Execute the update.php process from the command line |
| core-status | Provides a birds-eye view of the current Drupal installation, if any. |
| php-script | Run php script(s). |
| cache-clear | Clear a specific cache, or all drupal caches. |
| search-status | Show how many items remain to be indexed out of the total. |
| search-index | Index the remaining search items without wiping the index. |
| search-reindex | Force the search index to be rebuilt. |
| core-rsync | Rsync the Drupal tree to/from another server using ssh. Relative paths start from the Drupal root folder if a site alias is used; otherwise they start from the current working directory. |
| php-eval | Evaluate arbitrary php code after bootstrapping Drupal. |
| site-install | Install Drupal along with modules/themes/configuration using the specified install profile. |
| drupal-directory | Return path to a given module/theme directory. See --help for more details. |
| core-cli | Enter a new shell optimized for drush use. |
| field-create | Create fields and instances. Returns urls for field editing. |
| field-update | Return URL for field editing web page. |
| field-delete | Delete a field and its instances. |
| field-clone | Clone a field and all its instances. |
| field-info | View information about fields, field_types, and widgets. |
| pm-enable | Enable one or more modules or themes. |
| pm-disable | Disable one or more modules or themes. |
| pm-info | Show info for one or more projects. |
| pm-uninstall | Uninstall one or more modules. |
| pm-list | Show a list of available modules and themes |
| pm-refresh | Refresh update status information |
| pm-updatecode | Update your project code |
| pm-update | Update your project code and apply any database updates required (update.php) |
| pm-releases | Release information for a project |
| pm-download | Download core Drupal and projects like CCK, Zen, etc. |
| site-alias | Print site alias records for all known site aliases and local sites. |
| sql-conf | Print database connection details using print_r(). |
| 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-sync | Copy source database to target database using rsync. |
| sql-cli | Open a SQL command-line interface using Drupal's credentials. |
| core-topic | Read detailed documentation on a given topic. |
| site-upgrade | Run a major version upgrade for Drupal core and contrib modules. |
| user-information | Print information about the specified user(s). |
| user-block | Block the specified user(s). |
| user-unblock | Unblock the specified user(s). |
| user-add-role | Add a role to the specified user accounts. |
| user-remove-role | Remove a role from the specified user accounts. |
| user-create | Create a user account with the specified name. |
| user-cancel | Cancel a user account with the specified name. |
| user-password | (Re)Set the password for the user account with the specified name. |
| variable-get | Get a list of some or all site variables and values. |
| variable-set | Set a variable. |
| variable-delete | Delete a variable. |
| watchdog-list | Show available message types and severity levels. A prompt will ask for a choice to show watchdog messages. |
| watchdog-show | Show watchdog messages. |
| watchdog-delete | Delete watchdog messages. |
- help
Print this help message. See `drush help help` for more options.
Examples:
drush List all commands.
drush help pm-download Show help for one command.
drush help dl Show help for one command using an
alias.
Options:
--sort Sort commands in alphabetical order.
drush waits for full bootstrap
before printing any commands when
this option is used.
--html Print help for all commands in HTML
format.
--pipe A list of available commands, one
per line.
Topics:
core-readme README.txt
- core-cron
Run all cron hooks.
Aliases: cron
- updatedb
Run update.php just as a web browser would.
Aliases: updb
- core-status
Provides a birds-eye view of the current Drupal installation, if any.
Examples:
drush status version Show all status lines that contain
version information.
drush status --pipe A list key=value items separated by
line breaks.
drush status drush-version --pipe Emit just the drush version with no
label.
Arguments:
item Optional. The status item line(s)
to display. Any matching line is
shown; if only one line matches,
then only the value is displayed.
Otherwise, key=value is output.
Options:
show-passwords Show database password.
Topics:
core-readme README.txt
Aliases: status, st
- php-script
Runs the given php script(s) after a full Drupal bootstrap. A useful alternative
to eval command when your php is lengthy or you can't be bothered to figure out
bash quoting. if you plan to share a script with others, consider making a full
drush command instead since thats more self-documenting.
Examples:
drush php-script scratch Run scratch.php script. See
commands/core directory.
drush php-script example Run script from specified paths
--script-path=/path/to/scripts:/another/
path
drush php-script List all available scripts.
Arguments:
filename Optional. The file you wish to
execute (without extension). If
omitted, list files ending in .php
in the current working directory and
specified script-path. Some might
not be real drush scripts. Beware.
Options:
--script-path Additional paths to search for
scripts. Use POSIX path separator
(':') for multiple paths.
Aliases: scr
- cache-clear
Delete a specific drupal cache, or all caches.
Arguments:
type The particular cache to clear. Omit
this argument to choose from
available caches.
Aliases: cc
- search-status
Show how many items remain to be indexed for search, and the total number of
items.
Options:
--pipe Display in the format
remaining/total for processing by
scripts.
- search-index
Index the remaining search items.
- search-reindex
Force the search index to be rebuilt.
Options:
--immediate Rebuild the index immediately,
instead of waiting for cron.
- core-rsync
Rsync the Drupal tree to/from another server using ssh. Relative paths start
from the Drupal root folder if a site alias is used; otherwise they start from
the current working directory.
Examples:
drush rsync @dev @stage Rsync Drupal root from dev to stage
(one of which must be local).
drush rsync ./ @stage:%files/img Rsync all files in the current
directory to the 'img' directory in
the file storage folder on stage.
Arguments:
source May be rsync path or site alias. See
rsync documentation and
example.aliases.drushrc.php.
destination May be rsync path or site alias. See
rsync documentation and
example.aliases.drushrc.php.
Options:
--mode The unary flags to pass to rsync;
--mode=rultz implies rsync -rultz.
Default is -az.
--RSYNC-FLAG Most rsync flags passed to drush
sync will be passed on to rsync.
See rsync documentation.
--exclude-conf Excludes settings.php from being
rsynced. Default.
--include-conf Allow settings.php to be rsynced
--exclude-files Exclude the files directory.
--exclude-sites Exclude all directories in "sites/"
except for "sites/all".
--exclude-other-sites Exclude all directories in "sites/"
except for "sites/all" and the site
directory for the site being synced.
Note: if the site directory is
different between the source and
destination, use --exclude-sites
followed by "drush rsync @from:%site
@to:%site"
--exclude-paths Coma-separated list of paths to
exclude.
--include-paths Coma-separated list of paths to
include.
Aliases: rsync
- php-eval
Run arbitrary PHP code in the context of Drupal
Examples:
drush php-eval "variable_set('hello', Sets the hello variable using Drupal
'world');" API.
Arguments:
code PHP code
- site-install
Install Drupal using specified install profile.
Examples:
drush site-install expert --locale=uk (Re)install using the expert install
profile. Set default language to
Ukranian.
drush site-install Install using the specified DB
--db-url=mysql://root:pass@localhost:por params.
t/dbname
drush site-install --account-name=joe Re-install with specified uid1
--account-pass=mom credentials.
Arguments:
profile the install profile you wish to run.
defaults to 'default'
Options:
db-url A Drupal 5/6 style database URL.
Only required for initial install -
not re-install.
db-prefix An optional table prefix to use for
initial install.
account-name uid1 name. defaults to admin
account-pass uid1 pass. defaults to admin
account-mail uid1 email. defaults to
admin@example.com
locale A short language code. Sets the
default site language. Language
files must already be present. You
may use download command to get
them.
clean-url Defaults to 1
site-name Defaults to Site-Install
site-mail From: for system mailings. Defaults
to admin@example.com
sites-subdir Name of directory under 'sites'
which should be created if needed.
Defaults to 'default'
Aliases: si
- drupal-directory
Return the filesystem path for projects/themes and other key folders. Used by
`cli` command for handy commands `cdd` and `lsd`. If you want to use this
command directly, you usually want to prefix the command with cd and enclose the
command invocation in backticks. See Examples below.
Examples:
cd `drush dd devel` Navigate into the devel module
directory
cd `drush dd` Navigate to the root of your Drupal
site
cd `drush dd files` Navigate to the files directory.
drush dd @alias:%files Print the path to the files
directory on the site @alias.
edit `drush dd devel`/devel.module Open devel module in your editor
(customize 'edit' for your editor)
Arguments:
target A module/theme name, or special
names like root, files, private, or
an alias : path alias string such as
@alias:%files. Defaults to root.
Aliases: dd
- core-cli
Enter a new shell optimized for drush use. All .bashrc customizations are still
available. See help for more details.
Examples:
help Print available drush commands
cdd Navigate to the root of your Drupal
site
cdd files Navigate to the files directory.
lsd files List all files in the Drupal files
directory.
on @alias status Run the command "status" on the site
indicated by @alias
Aliases: cli
- field-create
Quickly create fields and instances for a given bundle.
Examples:
drush field-create article Define new article fields via
interactive prompts.
open `drush field-create article` Define new article fields and then
open field edit form for refinement.
drush field-create article Create two new fields.
city,text,text_textfield
subtitle,text,text_textfield
Arguments:
bundle Content type (for nodes). Name of
bundle to attach fields to.
Required.
field_spec Comma delimited triple in the form:
field_name,field_type,widget_name.
If widget_name is omitted, the
default widget will be used.
Separate multiple fields by space.
If omitted, a wizard will prompt
you.
Options:
entity_type Type of entity (e.g. node, user,
comment). Defaults to node.
- field-update
Return URL for editing field.
Examples:
field-update comment_body Quickly navigate to a field edit web
page.
Arguments:
field_name Name of field that needs updating.
- field-delete
Delete a field and its instances.
Examples:
field-delete city Delete the city field and any
instances it might have.
field-delete city --bundle=article Delete the city instance on the
article bundle
Arguments:
field_name Name of field to delete.
Options:
bundle Only delete the instance attached to
this bundle. If omitted, admin can
choose to delete one instance or
whole field.
entity_type Disambiguate a particular bundle
from identically named bundles.
Usually not needed.
- field-clone
Clone a field and all of its instances.
Examples:
field-clone tags labels Copy 'tags' field into a new field
'labels' field which has same
instances.
open `field-clone tags labels` Clone field and then open field edit
forms for refinement.
Arguments:
source_field_name Name of field that will be cloned
target_field_name Name of new, cloned field.
- field-info
View information about fields, field_types, widgets, etc.
Examples:
field-info types Show a table which lists all field
types and their available widgets
Arguments:
type Recognized values: fields, types. If
omitted, a choice list appears.
- pm-enable
Enable one or more modules or themes. Enable dependant modules as well.
Arguments:
modules A space delimited list of modules or
themes. You can use the * wildcard
at the end of module and theme names
to to enable all matches.
Aliases: en
- pm-disable
Disable one or more modules or themes. Disable dependant modules as well.
Arguments:
modules A space delimited list of modules or
themes. You can use the * wildcard
at the end of module and theme names
to disable multiple matches.
Aliases: dis
- pm-info
Show detailed info for one or more projects.
Arguments:
projects A space delimited list of projects.
You can use the * wildcard at the
end of module names to get info for
the project and all its sub
projects.
- pm-uninstall
Uninstall one or more modules. Modules must be disabled first.
Arguments:
modules A space delimited list of modules.
- pm-list
Show a list of available modules and themes.
Options:
--type Filter by project type. Choices:
module, theme.
--status Filter by project status. Choices:
enabled,disable and/or 'not
installed'. You can use multiple
comma separated values. (i.e.
--status="disabled,not installed").
--package Filter by project packages. You can
use multiple comma separated values.
(i.e. --package="Core -
required,Other").
--pipe Returns a space delimited list of
the names of the resulting projects.
Aliases: sm
- pm-refresh
Refresh update status information. Run this before running update or updatecode
commands.
Aliases: rf
- pm-updatecode
Display available update information and allow updating of all installed project
code to the specified version (or latest by default). Note: The user is asked to
confirm before the actual update. Use the --yes option to answer yes
automatically.
Examples:
drush pm-updatecode cck Commit changes as the user 'joe'
--svncommitparams=\"--username joe\" (Quotes are required).
drush pm-updatecode cck Checkout should use these
--cvscredentials=\"name:password\" credentials.
drush pm-updatecode cck Overwrite all local changes (Quotes
--cvsparams=\"-C\" are required).
drush pm-updatecode cck Will update the project, and try to
--cvsmethod=update merge changes, rather than
overwriting them. Any conflicts will
need to be resolved manually.
Arguments:
projects Optional. A space delimited list of
installed projects (modules or
themes) to update.
Options:
--pipe Returns a space delimited list of
enabled modules and their respective
version and update information, one
module per line. Order: module name,
current version, recommended
version, update status.
--lock Add a persistent lock to remove the
specified projects from
consideration during updates. Locks
may be removed with the --unlock
parameter, or overridden by
specifically naming the module as a
parameter to pm-update or
pm-updatecode. The lock does not
affect pm-download.
--lock-message A brief message explaining why a
project is being locked; displayed
during pm-updatecode. Optional.
--unlock Remove the persistent lock from the
specified projects so that they may
be updated again.
--backup-dir Specify a directory to backup
packages into, defaults to a backup
directory within your Drupal root.
--version-control=svn Quickly add/remove/commit your
project changes to Subversion.
--svnsync Automatically add new files to the
SVN repository and remove deleted
files. Caution.
--svncommit Automatically commit changes to SVN
repository. You must also using the
--svnsync option.
--svnmessage Override default commit message
which is: Drush automatic commit:
--svnstatusparams Add options to the 'svn status'
command
--svnaddparams Add options to the `svn add` command
--svnremoveparams Add options to the `svn remove`
command
--svnrevertparams Add options to the `svn revert`
command
--svncommitparams Add options to the `svn commit`
command
--version-control=backup Backup all project files before
updates.
--backup-dir Backup destination directory.
Defaults to a "/backup" subdirectory
inside your Drupal root.
--version-control=bzr Quickly add/remove/commit your
project changes to Bazaar.
--bzrsync Automatically add new files to the
Bazaar repository and remove deleted
files. Caution.
--bzrcommit Automatically commit changes to
Bazaar repository. You must also
using the --bzrsync option.
--bzrmessage Override default commit message
which is: Drush automatic commit:
--package-handler=cvs Use CVS to checkout and update
projects.
--cvsparams Add options to the `cvs` program
--cvsmethod Force cvs updates or checkouts
(checkout is default unless the
directory is managed by a supported
version control system).
--cvscredentials A username and password that is sent
for cvs checkout command. Defaults
to anonymous:anonymous
Aliases: upc
- pm-update
Display available update information and allow updating of all installed
projects to the specified version (or latest by default), followed by applying
any database updates required (as with running update.php). Note: The user is
asked to confirm before the actual update. Use the --yes option to answer yes
automatically.
Examples:
drush pm-update cck Commit changes as the user 'joe'
--svncommitparams=\"--username joe\" (Quotes are required).
drush pm-update cck Checkout should use these
--cvscredentials=\"name:password\" credentials.
drush pm-update cck --cvsparams=\"-C\" Overwrite all local changes (Quotes
are required).
drush pm-update cck --cvsmethod=update Will update the project, and try to
merge changes, rather than
overwriting them. Any conflicts will
need to be resolved manually.
Arguments:
projects Optional. A space delimited list of
installed projects (modules or
themes) to update.
Options:
--pipe Returns a space delimited list of
enabled modules and their respective
version and update information, one
module per line. Order: module name,
current version, recommended
version, update status.
--lock Add a persistent lock to remove the
specified projects from
consideration during updates. Locks
may be removed with the --unlock
parameter, or overridden by
specifically naming the module as a
parameter to pm-update or
pm-updatecode. The lock does not
affect pm-download.
--lock-message A brief message explaining why a
project is being locked; displayed
during pm-updatecode. Optional.
--unlock Remove the persistent lock from the
specified projects so that they may
be updated again.
--backup-dir Specify a directory to backup
packages into, defaults to a backup
directory within your Drupal root.
--version-control=svn Quickly add/remove/commit your
project changes to Subversion.
--svnsync Automatically add new files to the
SVN repository and remove deleted
files. Caution.
--svncommit Automatically commit changes to SVN
repository. You must also using the
--svnsync option.
--svnmessage Override default commit message
which is: Drush automatic commit:
--svnstatusparams Add options to the 'svn status'
command
--svnaddparams Add options to the `svn add` command
--svnremoveparams Add options to the `svn remove`
command
--svnrevertparams Add options to the `svn revert`
command
--svncommitparams Add options to the `svn commit`
command
--version-control=backup Backup all project files before
updates.
--backup-dir Backup destination directory.
Defaults to a "/backup" subdirectory
inside your Drupal root.
--version-control=bzr Quickly add/remove/commit your
project changes to Bazaar.
--bzrsync Automatically add new files to the
Bazaar repository and remove deleted
files. Caution.
--bzrcommit Automatically commit changes to
Bazaar repository. You must also
using the --bzrsync option.
--bzrmessage Override default commit message
which is: Drush automatic commit:
--package-handler=cvs Use CVS to checkout and update
projects.
--cvsparams Add options to the `cvs` program
--cvsmethod Force cvs updates or checkouts
(checkout is default unless the
directory is managed by a supported
version control system).
--cvscredentials A username and password that is sent
for cvs checkout command. Defaults
to anonymous:anonymous
Aliases: up
- pm-releases
View all releases for a given project (modules, themes, profiles, translations).
Useful for deciding which version to install/update.
Examples:
drush pm-releases cck zen View releases for cck and Zen
projects.
Arguments:
projects A space separated list of drupal.org
project names.
- pm-download
Quickly download projects (modules, themes, profiles, translations) from
drupal.org. Automatically figures out which module version you want based on its
latest release, or you may specify a particular version. Downloads drupal core
as well. If no destination is provided, defaults to a site specific modules
directory if available, then to sites/all/modules if available, then to the
current working directory.
Examples:
drush dl Download latest version of Drupal
core.
drush dl drupal Download latest stable version of
Drupal core
drush dl drupal-7.x Download latest 7.x development
version of Drupal core
drush dl cck zen es Download latest versions of CCK, Zen
and Spanish translations for my
version of Drupal.
drush dl og-1.3 Download a specfic version of
Organic groups module for my version
of Drupal.
drush dl diff-6.x-2.x Download a specific development
branch of diff module for a specific
Drupal version.
drush pm-download cck Commit changes as the user 'joe'
--svncommitparams=\"--username joe\" (Quotes are required).
drush pm-download cck Checkout should use these
--cvscredentials=\"name:password\" credentials.
drush pm-download cck --cvsparams=\"-C\" Overwrite all local changes (Quotes
are required).
drush pm-download cck --cvsmethod=update Will update the project, and try to
merge changes, rather than
overwriting them. Any conflicts will
need to be resolved manually.
Arguments:
projects A space separated list of project
names, with optional version.
Defaults to 'drupal'
Options:
--destination Path to which the project will be
copied.
--source The base URL which provides project
release history in XML. Defaults to
http://updates.drupal.org/release-hi
story.
--variant Only useful for install profiles.
Possible values: 'core', 'no-core',
'make'.
--drupal-project-rename Alternate name for "drupal"
directory when downloading drupal
project.
--pipe Returns a list of the names of the
modules and themes contained in the
downloaded projects.
--version-control=svn Quickly add/remove/commit your
project changes to Subversion.
--svnsync Automatically add new files to the
SVN repository and remove deleted
files. Caution.
--svncommit Automatically commit changes to SVN
repository. You must also using the
--svnsync option.
--svnmessage Override default commit message
which is: Drush automatic commit:
--svnstatusparams Add options to the 'svn status'
command
--svnaddparams Add options to the `svn add` command
--svnremoveparams Add options to the `svn remove`
command
--svnrevertparams Add options to the `svn revert`
command
--svncommitparams Add options to the `svn commit`
command
--version-control=backup Backup all project files before
updates.
--backup-dir Backup destination directory.
Defaults to a "/backup" subdirectory
inside your Drupal root.
--version-control=bzr Quickly add/remove/commit your
project changes to Bazaar.
--bzrsync Automatically add new files to the
Bazaar repository and remove deleted
files. Caution.
--bzrcommit Automatically commit changes to
Bazaar repository. You must also
using the --bzrsync option.
--bzrmessage Override default commit message
which is: Drush automatic commit:
--package-handler=cvs Use CVS to checkout and update
projects.
--cvsparams Add options to the `cvs` program
--cvsmethod Force cvs updates or checkouts
(checkout is default unless the
directory is managed by a supported
version control system).
--cvscredentials A username and password that is sent
for cvs checkout command. Defaults
to anonymous:anonymous
Aliases: dl
- site-alias
Print an alias record.
Examples:
drush site-alias List all alias records known to
drush.
drush site-alias @dev Print an alias record for the alias
'dev'.
Arguments:
site Site specification alias to print
Options:
--full Print the full alias record for each
site. Default when aliases are
specified on the command line.
--short Print only the site alias name.
Default when not command line
arguments are specified.
--pipe Print the long-form site
specification for each site.
--with-db Include the databases structure in
the full alias record.
--with-db-url Include the short-form db-url in the
full alias record.
--no-db Do not include the database record
in the full alias record (default).
--with-optional Include optional default items.
Aliases: sa
- sql-conf
Show database connection details.
Arguments:
all Show all database connections,
instead of just one.
Options:
--database The DB connection key if using
multiple connections in
settings.php.
- sql-connect
A string which connects to the current database.
Examples:
`drush sql connect` < example.sql Import sql statements from a file
into the current database.
Options:
--database The DB connection key if using
multiple connections in
settings.php.
- sql-dump
Prints the whole database to STDOUT or save to a file.
Examples:
drush sql-dump --result-file=../18.sql Save SQL dump to the directory above
Drupal root.
drush sql-dump --skip-tables-key=common Skip standard tables. @see
example.drushrc.com
Options:
--result-file Save to a file. The file should be
relative to Drupal root.
Recommended.
--skip-tables-key A key in the $skip_tables array.
@see example.drushrc.php. Optional.
--structure-tables-key A key in the $structure_tables
array. @see example.drushrc.php.
Optional.
--tables-key A key in the $tables array.
Optional.
--tables-list A comma-separated list of tables to
transfer. Optional.
--ordered-dump Order by primary key and add line
breaks for efficient diff in
revision control. Also, faster
rsync. Slows down the dump. Mysql
only.
--create-db Wipe existing tables.
--data-only Omit CREATE TABLE statements.
Postgres only.
--database The DB connection key if using
multiple connections in
settings.php.
- sql-query
Usage: drush [options] sql-query ...
is a SQL statement, which can alternatively be passed via STDIN. Any
additional arguments are passed to the mysql command directly.
Examples:
drush sql-query "SELECT * FROM {users} Browse user record. Table prefixes
WHERE uid=1" are honored.
Arguments:
query A SQL query. Mandatory.
Options:
--extra Add custom options to the mysql
command.
--database The DB connection key if using
multiple connections in
settings.php.
Aliases: sqlq
- sql-sync
Usage: drush [options] sql-sync .
and are site-aliases, or names of directories
under \'sites\'. These determine from where and to where you want your database
copied.
Examples:
drush sql-sync @dev @prod Copy the DB defined in sites/dev to
the DB in sites/prod.
Arguments:
from Name of subdirectory within /sites
or a site-alias.
to Name of subdirectory within /sites
or a site-alias.
Options:
--skip-tables-key A key in the $skip_tables array.
@see example.drushrc.php. Optional.
--structure-tables-key A key in the $structure_tables
array. @see example.drushrc.php.
Optional.
--tables-key A key in the $tables array.
Optional.
--tables-list A comma-separated list of tables to
transfer. Optional.
--cache Skip dump if result file exists and
is less than "cache" hours old.
Optional; default is 24 hours.
--no-cache Do not cache the sql-dump file.
--no-dump Do not dump the sql database; always
use an existing dump file.
--source-db-url Database specification for source
system to dump from.
--source-remote-port Override sql database port number in
source-db-url. Optional.
--source-remote-host Remote machine to run sql-dump file
on. Optional; default is local
machine.
--source-dump Path to dump file. Optional; default
is to create a temporary file.
--target-db-url
--target-remote-port
--target-remote-host
--target-dump
--temp Use a temporary file to hold dump
files. Implies --no-cache.
--dump-dir Directory to store sql dump files in
when --source-dump or --target-dump
are not used. Takes precedence over
--temp.
--create-db Create a new database before
importing the database dump on the
target machine.
--db-su Account to use when creating a new
database. Optional.
--db-su-pw Password for the "db-su" account.
Optional.
--sanitize Obscure email addresses and reset
passwords in the user table
post-sync. Optional.
--sanitize-password The password to assign to all
accounts in the sanitization
operation, or "no" to keep passwords
unchanged. Default is "password".
--sanitize-email The username for test email
addresses in the sanitization
operation, or "no" to keep email
addresses unchanged. May contain
replacement patterns %uid, %mail or
%login. Default is
"user+%uid@localhost".
- sql-cli
Quickly enter the mysql command line.
Options:
--database The DB connection key if using
multiple connections in
settings.php.
Aliases: sqlc
- core-topic
Read detailed documentation on a given topic.
Examples:
drush topic Show all available topics.
drush topic core-context Show documentation for the drush
context API
drush core-context Show documentation for the drush
context API
Arguments:
topic name The name of the topic you wish to
view. If omitted, list all topic
descriptions (and names in
parenthesis).
Aliases: topic
- site-upgrade
Execute a major version upgrade for Drupal core and enabled contrib modules.
Command will download next version of Drupal and all available contrib modules
that have releases (if not already downloaded). It prepares a settings.php for
the target site, and copies the prior version's database to the target site.
Finally, updatedb is run. The intent is for developers to keep re-running this
command until they are satisfied with the resulting site.
Examples:
drush site-upgrade @onward Upgrade from the current site to the
site specified by @onward alias.
Arguments:
target The name of a sitealias, which
points to the destination site.
root, uri, and db-url keys are
required. See
examples/aliases.drushrc.php for
more information.
Options:
structure-tables-key A key in the structure-tables array.
@see example.drushrc.php. Defaults
to 'common'.
source-dump Path to dump file. Medium or large
sized sites should set this.
Optional; default is to create a
temporary file.
db-su DB username to use when dropping and
creating the target database.
Optional.
db-su-pw DB password to use when dropping and
creating the target database.
Optional.
Aliases: sup
- user-information
Display information about a user identified by username, uid or email address.
Examples:
drush user-information Display information about any users
2,3,someguy,somegal,billgates@microsoft. with uids, names, or mail addresses
com matching the strings between commas.
Arguments:
users A comma delimited list of uids, user
names, or email addresses.
Options:
--full show extended information about the
user
--short show basic information about the
user (this is the default)
Aliases: uinf
- user-block
Block the specified user(s).
Examples:
drush user-block 5,user3 --uid=2,3 Block the users with name, id, or
--name=someguy,somegal email 5 or user3, uids 2 and 3,
--mail=billgates@microsoft.com names someguy and somegal, and email
address of billgates@microsoft.com
Arguments:
users A comma delimited list of uids, user
names, or email addresses.
Options:
--uid A comma delimited list of uids to
block
--name A comma delimited list of user names
to block
--mail A comma delimited list of user mail
addresses to block
Aliases: ublk
- user-unblock
Unblock the specified user(s).
Examples:
drush user-unblock 5,user3 --uid=2,3 Unblock the users with name, id, or
--name=someguy,somegal email 5 or user3, uids 2 and 3,
--mail=billgates@microsoft.com names someguy and somegal, and email
address of billgates@microsoft.com
Arguments:
users A comma delimited list of uids, user
names, or email addresses.
Options:
--uid A comma delimited list of uids to
unblock
--name A comma delimited list of user names
to unblock
--mail A comma delimited list of user mail
addresses to unblock
Aliases: uublk
- user-add-role
Add a role to the specified user accounts.
Examples:
drush user-add-role "power user" 5,user3 Add the "power user" role to the
--uid=2,3 --name=someguy,somegal accounts with name, id, or email 5
--mail=billgates@microsoft.com or user3, uids 2 and 3, names
someguy and somegal, and email
address of billgates@microsoft.com
Arguments:
role The name of the role to add
users (optional) A comma delimited list of
uids, user names, or email
addresses.
Options:
--uid A comma delimited list of uids
--name A comma delimited list of user names
--mail A comma delimited list of user mail
addresses
Aliases: urol
- user-remove-role
Remove a role from the specified user accounts.
Examples:
drush user-remove-role "power user" Remove the "power user" role from
5,user3 --uid=2,3 --name=someguy,somegal the accounts with name, id, or email
--mail=billgates@microsoft.com 5 or user3, uids 2 and 3, names
someguy and somegal, and email
address of billgates@microsoft.com
Arguments:
role The name of the role to remove
users (optional) A comma delimited list of
uids, user names, or email
addresses.
Options:
--uid A comma delimited list of uids
--name A comma delimited list of user names
--mail A comma delimited list of user mail
addresses
Aliases: urrol
- user-create
Create a user account.
Examples:
drush user-create newuser Create a new user account with the
--mail="person@example.com" name newuser, the email address
--password="letmein" person@example.com, and the password
letmein
Arguments:
name The name of the account to add
Options:
--password The password for the new account
--mail The email address for the new
account
Aliases: ucrt
- user-cancel
Cancel a user account.
Examples:
drush user-cancel username Cancel the user account with the
name username and anonymize all
content created by that user.
Arguments:
name The name of the account to cancel
Aliases: ucan
- user-password
(Re)Set the password for the given user account.
Examples:
drush user-password someuser Set the password for the username
--password="gr3@tP@$s" someuser to gr3@tP@$s.
Arguments:
name The name of the account to modify
Options:
--password (required) The new password for the
account
Aliases: upwd
- variable-get
Lists the variables for your site
Examples:
drush vget List all variables and values.
drush vget user List all variables beginning with
the string "user".
Arguments:
name A string to filter the variables by.
Only variables beginning with the
string will be listed.
Options:
--pipe Use var_export() to emit executable
PHP. Useful for pasting into code.
Aliases: vget
- variable-set
Set a variable
Examples:
drush vset --yes preprocess_css 1 Set the preprocess_css variable to
true. Skip confirmation if variable
already exists.
drush vset --always-set site_offline 1 Take the site offline; Skips
confirmation even if site_offline
variable does not exist.
drush vset pr 1 Choose from a list of variables
beginning with "pr" to set to true.
Arguments:
name The name of a variable or the first
few letters of its name.
value The value to assign to the variable.
Options:
--yes Skip confirmation if only one
variable name matches.
--always-set Always skip confirmation.
Aliases: vset
- variable-delete
Delete a variable.
Examples:
drush vdel user_pictures Delete the user_pictures variable.
drush vdel u Choose from a list of variables
beginning with "u" to delete.
Arguments:
name The name of a variable or the first
few letters of its name.
Options:
--yes Skip confirmation if only one
variable name matches.
Aliases: vdel
- watchdog-list
Show available message types and severity levels. A prompt will ask for a choice
to show watchdog messages.
Aliases: wd-list
- watchdog-show
Show watchdog messages. Arguments and options can be combined to configure which
messages to show.
Examples:
drush watchdog-show Show a listing of most recent 10
messages.
drush watchdog-show 64 Show in detail message with id 64.
drush watchdog-show "cron run succesful" Show a listing of most recent 10
messages containing the string "cron
run succesful".
drush watchdog-show --count=46 Show a listing of most recent 46
messages.
drush watchdog-show --severity=notice Show a listing of most recent 10
messages with a severity of notice.
drush watchdog-show --type=php Show a listing of most recent 10
messages of type php.
drush watchdog-show --tail Show a listing of most recent 10
messages and continue showing
messages as they are registered in
the watchdog.
drush watchdog-show --tail Do a tail of the watchdog with a
--sleep-delay=2 delay of two seconds between each
poll to the database.
Arguments:
wid Optional id of a watchdog message to
show in detail. If not provided, a
listing of most recent 10 messages
will be displayed. Alternatively if
a string is provided, watchdog
messages will be filtered by it.
Options:
--count The number of messages to show.
Defaults to 10.
--severity Restrict to messages of a given
severity level.
--type Restrict to messages of a given
type.
--tail Continuously show new watchdog
messages until interrupted.
--sleep-delay To be used in conjunction with
--tail. This is the number of
seconds to wait between each poll to
the database. Delay is 1 second by
default.
Aliases: wd-show, ws
- watchdog-delete
Delete watchdog messages. Arguments or options must be provided to specify which
messages to delete.
Examples:
drush watchdog-delete all Delete all messages.
drush watchdog-delete 64 Delete messages with id 64.
drush watchdog-delete "cron run Delete messages containing the
succesful" string "cron run succesful".
drush watchdog-delete --severity=notice Delete all messages with a severity
of notice.
drush watchdog-delete --type=cron Delete all messages of type cron.
Arguments:
--severity Delete messages of a given severity
level.
--type Delete messages of a given type.
Aliases: wd-del, wd-delete
Command list generated by drush help --html. Use this technique to publish your organization's command list to your intranet.
