DESCRIPTION
Drush is a command line shell and Unix scripting interface for Drupal. If you are unfamiliar with shell scripting, reviewing the documentation for your shell (e.g. man bash) or reading an online tutorial (e.g. search for "bash tutorial") will help you get the most out of Drush., (*1)
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., (*2)
DRUSH VERSIONS
Each version of Drush supports multiple Drupal versions. Drush 6 is recommended version., (*3)
| Drush Version |
Branch |
PHP |
Compatible Drupal versions |
Code Status |
| Drush 7 |
master |
5.3.0+ |
D6, D7, D8 |
 |
| Drush 6 |
6.x |
5.3.0+ |
D6, D7 |
 |
| Drush 5 |
5.x |
5.2.0+ |
D6, D7 |
 |
| Drush 4 |
4.x |
5.2.0+ |
D5, D6, D7 |
Unsupported |
| Drush 3 |
3.x |
5.2.0+ |
D5, D6 |
Unsupported |
Drush comes with a full test suite powered by PHPUnit. Each commit gets tested by the awesome Travis.ci continuous integration service., (*4)
USAGE
Drush can be run in your shell by typing "drush" from within any Drupal root directory., (*5)
$ drush [options] <command> [argument1] [argument2]
Use the 'help' command to get a list of available options and commands:, (*6)
$ drush help
For even more documentation, use the 'topic' command:, (*7)
$ drush topic
Installation instructions can be found below. For a full list of Drush commands
and documentation by version, visit http://www.drush.org., (*8)
SUPPORT
Please take a moment to review the rest of the information in this file before
pursuing one of the support options below., (*9)
MISC
REQUIREMENTS
- Drush commands that work with git require git 1.7 or greater.
- Drush works best on a Unix-like OS (Linux, OS X)
- Most Drush commands run on Windows. See INSTALLING DRUSH ON WINDOWS, below.
INSTALL - COMPOSER
Composer is the preferred way to install Drush, but if you have any issues with
using Compser, consider trying MANUAL INSTALLATION. It is not too hard., (*10)
-
Install Composer globally., (*11)
-
Add Composer's global bin directory to the system PATH (recommended):, (*12)
sed -i '1i export PATH="$HOME/.composer/vendor/bin:$PATH"' $HOME/.bashrc
source $HOME/.bashrc
-
To install Drush, (*13)
-
Version 6.x (stable):, (*14)
composer global require drush/drush:6.*, (*15)
-
Version 7.x (dev) which is required for Drupal 8:, (*16)
composer global require drush/drush:dev-master, (*17)
-
To update to a newer version (what you get depends on your specification in ~/.composer/composer.json):, (*18)
composer global update, (*19)
-
Alternate commands to install some other variant of Drush:, (*20)
# Install a specific version of Drush, e.g. Drush 6.1.0
composer global require drush/drush:6.1.0
# Master branch as a git clone. Great for contributing back to Drush project.
composer global require drush/drush:dev-master --prefer-source
-
To install for all users on the server:, (*21)
curl -sS https://getcomposer.org/installer | php
mv composer.phar /usr/local/bin/composer
ln -s /usr/local/bin/composer /usr/bin/composer
git clone https://github.com/drush-ops/drush.git /usr/local/src/drush
cd /usr/local/src/drush
git checkout 7.0.0-alpha5 #or whatever version you want.
ln -s /usr/local/src/drush/drush /usr/bin/drush
composer install
drush --version
Fuller explanation of the require command., (*22)
See the POST-INSTALL section for configuration tips., (*23)
INSTALL - MANUAL
- Place the uncompressed drush.tar.gz, drush.zip, or cloned git repository in a directory that is outside of your web root.
-
Make the 'drush' command executable:, (*24)
$ chmod u+x /path/to/drush/drush, (*25)
-
Configure your system to recognize where Drush resides. There are 3 options:, (*26)
-
Create a symbolic link to the Drush executable in a directory that is already in your PATH, e.g.:, (*27)
$ ln -s /path/to/drush/drush /usr/bin/drush, (*28)
-
Explicitly add the Drush executable to the PATH variable which is defined in the the shell configuration file called .profile, .bash_profile, .bash_aliases, or .bashrc that is located in your home folder, i.e.:, (*29)
export PATH="$PATH:/path/to/drush:/usr/local/bin", (*30)
Your system will search path options from left to right until it finds a result., (*31)
-
Add an alias for drush (this method can also be handy if you want to use 2 versions of Drush, for example Drush 5 or 6 (stable) for Drupal 7 development, and Drush 7 (master) for Drupal 8 development).
To add an alias to your Drush 7 executable, add this to you shell configuration file (see list in previous option):
$ alias drush-master=/path/to/drush/drush, (*32)
For options 2 and 3 above, in order to apply your changes to your current session, either log out and then log back in again, or re-load your bash configuration file, i.e.:, (*33)
$ source .bashrc, (*34)
NOTE: If you do not follow this step, you will need to inconveniently run Drush commands using the full path to the executable "/path/to/drush/drush" or by navigating to /path/to/drush and running "./drush". The -r or -l options will be required (see USAGE, below)., (*35)
-
Test that Drush is found by your system:, (*36)
$ which drush, (*37)
See the POST-INSTALL section for configuration tips., (*38)
POST-INSTALL
-
See example.bashrc for instructions on how to add some
useful shell aliases that provides even tighter integration between
drush and bash. You may source this file directly into your shell by adding to
your .bashrc (or equivalent): source /path/to/drush/examples/example.bashrc, (*39)
-
If you didn't source it the step above, see top of
drush.complete.sh file for instructions adding bash completion for drush
command to your shell. Once configured, completion works for site aliases,
command names, shell aliases, global options, and command-specific options., (*40)
-
Optional. If drush.complete.sh is being sourced (ideally in
bash_completion.d), you can use the supplied __drush_ps1() sh function to
add your current drush site (set with drush use @sitename) to your PS1
prompt like so:
bash
if [ "\$(type -t __git_ps1)" ] && [ "\$(type -t __drush_ps1)" ]; then
PS1='\u@\h \w$(__git_ps1 " (%s)")$(__drush_ps1 "[%s]")\$ '
fi
Putting this in a .bashrc/.bash_profile/.profile would produce this prompt:, (*41)
msonnabaum@hostname ~/repos/drush (master)[@sitename]$, (*42)
-
Help the Drush development team by sending anonymized usage statistics. To automatically send usage data, please add the following to a .drushrc.php file:, (*43)
php
$options['drush_usage_log'] = TRUE;
$options['drush_usage_send'] = TRUE;, (*44)
Stats are usually logged locally and sent whenever log file exceeds 50Kb.
Alternatively, one may disable automatic sending and instead use
usage-show and usage-send commands to more carefully send data., (*45)
ADDITIONAL CONFIGURATIONS FOR MAMP:
Users of MAMP will need to manually specify in their PATH which version of php
and MySQL to use in the command line interface. This is independent of the php
version selected in the MAMP application settings. Under OS X, edit (or create
if it does not already exist) a file called .bash_profile in your home folder., (*46)
To use php 5.3.x, add this line to .bash_profile:, (*47)
export PATH="/Applications/MAMP/Library/bin:/Applications/MAMP/bin/php5.3/bin:$PATH"
If you want to use php 5.4.x, add this line instead:, (*48)
export PATH="/Applications/MAMP/Library/bin:/Applications/MAMP/bin/php5.4/bin:$PATH"
If you have MAMP v.1.84 or lower, this configuration will work for both version
of PHP:, (*49)
export PATH="/Applications/MAMP/Library/bin:/Applications/MAMP/bin/php5/bin:$PATH"
If you have done this and are still getting a "no such file or directory" error
from PDO::__construct, try this:, (*50)
sudo mkdir /var/mysql
sudo ln -s /Applications/MAMP/tmp/mysql/mysql.sock /var/mysql/mysql.sock
Additionally, you may need to adjust your php.ini settings before you can use
drush successfully. See CONFIGURING PHP.INI below for more details on how to
proceed., (*51)
ADDITIONAL CONFIGURATIONS FOR OTHER AMP STACKS:
Users of other Apache distributions such as XAMPP, or Acquia's Dev Desktop will
want to ensure that its php can be found by the command line by adding it to
the PATH variable, using the method in 3.b above. Depending on the version and
distribution of your AMP stack, PHP might reside at:, (*52)
| Path |
Application |
| /Applications/acquia-drupal/php/bin |
Acquia Dev Desktop (Mac) |
| /Applications/xampp/xamppfiles/bin |
XAMP (Mac) |
| /opt/lampp/bin |
XAMPP (Windows) |
Additionally, you may need to adjust your php.ini settings before you can use
drush successfully. See CONFIGURING PHP.INI below for more details on how to
proceed., (*53)
RUNNING A SPECIFIC PHP FOR DRUSH
If you want to run Drush with a specific version of php, rather than the
php defined by your shell, you can add an environment variable to your
the shell configuration file called .profile, .bash_profile, .bash_aliases,
or .bashrc that is located in your home folder:, (*54)
export DRUSH_PHP='/path/to/php'
CONFIGURING PHP.INI
Usually, php is configured to use separate php.ini files for the web server and
the command line. Make sure that Drush's php.ini is given as much memory to
work with as the web server is; otherwise, Drupal might run out of memory when
Drush bootstraps it., (*55)
To see which php.ini file Drush is using, run:, (*56)
$ drush status
To see which php.ini file the webserver is using, use the phpinfo() function in
a .php web page. See http://drupal.org/node/207036., (*57)
If Drush is using the same php.ini file as the web server, you can create a
php.ini file exclusively for Drush by copying your web server's php.ini file to
the folder $HOME/.drush or the folder /etc/drush. Then you may edit this file
and change the settings described above without affecting the php enviornment
of your web server., (*58)
Alternately, if you only want to override a few values, copy example.drush.ini
from the /examples folder into $HOME/.drush or the folder /etc/drush and edit
to suit. See comments in example.drush.ini for more details., (*59)
You may also use environment variables to control the php settings that Drush
will use. There are three options:, (*60)
export PHP_INI='/path/to/php.ini'
export DRUSH_INI='/path/to/drush.ini'
export PHP_OPTIONS='-d memory_limit="128M"'
In the case of PHP_INI and DRUSH_INI, these environment variables specify the
full path to a php.ini or drush.ini file, should you wish to use one that is
not in one of the standard locations described above. The PHP_OPTIONS
environment variable can be used to specify individual options that should
be passed to php on the command line when Drush is executed., (*61)
Drush requires a fairly unrestricted php environment to run in. In particular,
you should insure that safe_mode, open_basedir, disable_functions and
disable_classes are empty. If you are using php 5.3.x, you may also need to
add the following definitions to your php.ini file:, (*62)
magic_quotes_gpc = Off
magic_quotes_runtime = Off
magic_quotes_sybase = Off
CONFIGURING DRUSH FOR PHP 5.5
If you are running on Linux, you may find that you need
the php5-json package. On Ubuntu, you can install it via:, (*63)
apt-get install php5-json, (*64)
INSTALLING DRUSH ON WINDOWS:
Windows support has improved, but is still lagging. For full functionality,
consider using on Linux/Unix/OSX using Virtualbox or other virtual machine., (*65)
There is a Windows msi installer for drush available at http://www.drush.org/drush_windows_installer., (*66)
Please see that page for more information on running Drush on Windows., (*67)
Whenever the documentation or the help text refers to 'drush [option]
' or something similar, 'drush' may need to be replaced by
'drush.bat'., (*68)
Additional Drush Windows installation documentation can be found at
http://drupal.org/node/594744., (*69)
Most Drush commands will run in a Windows CMD shell or PowerShell, but the
Git Bash shell provided by the 'Git for Windows' installation is the preferred
shell in which to run Drush commands. For more information on "Git for Windows'
visit http://msysgit.github.com/., (*70)
When creating aliases for Windows remote machines, pay particular attention to
information presented in the example.aliases.drushrc.php file, especially when
setting values for 'remote-host' and 'os', as these are very important when
running Drush rsync and Drush sql-sync commands., (*71)
OPTIONS
For multisite installations, use the -l option to target a particular site. If
you are outside the Drupal web root, you might need to use the -r, -l or other
command line options just for Drush to work. If you do not specify a URI with
-l and Drush falls back to the default site configuration, Drupal's
$GLOBALS['base_url'] will be set to http://default. This may cause some
functionality to not work as expected., (*72)
$ drush -l http://example.com pm-update
If you wish to be able to select your Drupal site implicitly from the
current working directory without using the -l option, but you need your
base_url to be set correctly, you may force it by setting the uri in
a drushrc.php file located in the same directory as your settings.php file., (*73)
sites/default/drushrc.php:, (*74)
$options['uri'] = "http://example.com";
Related Options:
-r <path>, --root=<path> Drupal root directory to use
(defaults to current directory or anywhere in a
Drupal directory tree)
-l <uri> , --uri=<uri> URI of the Drupal site to use
-v, --verbose Display verbose output., (*75)
Very intensive scripts can exhaust your available PHP memory. One remedy is to
just restart automatically using bash. For example:, (*76)
while true; do drush search-index; sleep 5; done
DRUSH CONFIGURATION FILES
Inside the examples directory you will find some example files to help you get
started with your Drush configuration file (example.drushrc.php), site alias
definitions (example.aliases.drushrc.php) and Drush commands
(sandwich.drush.inc). You will also see an example 'policy' file which can be
customized to block certain commands or arguments as required by your
organization's needs., (*77)
DRUSHRC.PHP
If you get tired of typing options all the time you can contain them in a
drushrc.php file. Multiple Drush configuration files can provide the
flexibility of providing specific options in different site directories of a
multi-site installation. See example.drushrc.php for examples and installation
details., (*78)
SITE ALIASES
Drush lets you run commands on a remote server, or even on a set of remote
servers. Once defined, aliases can be references with the @ nomenclature, i.e., (*79)
# Synchronize staging files to production
$ drush rsync @staging:%files/ @live:%files
# Syncronize database from production to dev, excluding the cache table
$ drush sql-sync --structure-tables-key=custom --no-cache @live @dev
See http://drupal.org/node/670460 and example.aliases.drushrc.php for more
information., (*80)
COMMANDS
Drush can be extended to run your own commands. Writing a Drush command is no harder than writing simple Drupal modules, since they both follow the same structure., (*81)
See sandwich.drush.inc for a quick tutorial on Drush command files. Otherwise, the core commands in Drush are good models for your own commands., (*82)
You can put your Drush command file in a number of places:, (*83)
- In a folder specified with the --include option (see
drush topic
docs-configuration).
- Along with one of your enabled modules. If your command is related to an
existing module, this is the preferred approach.
- In a .drush folder in your HOME folder. Note, that you have to create the
.drush folder yourself.
- In the system-wide Drush commands folder, e.g. /usr/share/drush/commands.
- In Drupal's /drush or sites/all/drush folders. Note, that you have to create the
drush folder yourself.
In any case, it is important that you end the filename with ".drush.inc", so that Drush can find it., (*84)
FAQ
Q: What does "drush" stand for?
A: The Drupal Shell.
Q: How do I pronounce Drush?
A: Some people pronounce the dru with a long u like Drupal. Fidelity points
go to them, but they are in the minority. Most pronounce Drush so that it
rhymes with hush, rush, flush, etc. This is the preferred pronunciation.
Q: Does Drush have unit tests?
A: Drush has an excellent suite of unit tests. See the README.md file in the /tests subdirectory for
more information.
CREDITS
- Originally developed by Arto Bendiken for Drupal 4.7.
- Redesigned by Franz Heinzmann in May 2007 for Drupal 5.
- Maintained by Moshe Weitzman with much help from
Owen Barton, greg.1.anderson, jonhattan, Mark Sonnabaum, and Jonathan Hedstrom.
, (*85)
Wallogit.com
