Install
Tip
Drush only supports one install method. It requires that your Drupal site be built with Composer and Drush be listed as a dependency.
See the Drush 8 or Drush 9 docs for installing prior versions of Drush.
- It is required that Drupal sites be built using Composer, with Drush listed as a dependency. Popular starter templates for that include drupal-project (Drush is included) and recommended-project (Drush must be added). If your Composer project doesn't yet depend on Drush, run
composer require drush/drushto add it. After this step, you may call Drush viavendor/bin/drush. - Optional. To be able to call
drushfrom anywhere, install the Drush Launcher. That is a small program which listens on your $PATH and hands control to a site-local Drush that is in the /vendor directory of your Composer project.
Note
- See Usage for details on using Drush.
- To use a non-default PHP, edit ~/.bashrc so that the desired PHP is in front of your $PATH. If that is not desirable, you can change your PATH for just one request:
PATH=/path/to/php:$PATHdrush status ...` - To use a custom php.ini for Drush requests, see this comment.
- See our guide on porting commandfiles from Drush 8 to later versions. Also note that alias and config files use a new .yml format in Drush 10+.
Drupal Compatibility¶
| Drush Version | PHP Version | End Of Life | Drupal versions | 7 | 8 | 9 | 10 |
|---|---|---|---|---|---|---|
| Drush 11 | 7.4+ | TBD | ✅ | ✅ | ||
| Drush 10 | 7.1+ (not 8) | Jan 2022 | ✓ | ✓ | ||
| Drush 9 | 5.6+ | May 2020 | ✓ | |||
| Drush 8 | 5.4.5+ | Nov 2023 | ✅ | ⚠️ | ||
| Drush 7 | 5.3.0+ | Jul 2017 | ✓ | |||
| Drush 6 | 5.3.0+ | Dec 2015 | ✓ | |||
| Drush 5 | 5.2.0+ | May 2015 | ✓ | |||
| Legend | |
|---|---|
| ✅ | Supported and recommended |
| ⚠️ | Supported but not recommended |
| ✓ | Compatible but no longer supported |
Last update:
November 21, 2022
Authors: