How can I use Drush in a project installed with Composer?

Question

I have installed Drupal 8.5 using composer create-project drupal-composer/drupal-project:8.x-dev my_site_name_dir --stability dev --no-interaction.

This command installs many files. I found drush-files in the root and the file vendor/drush. It looks like Drush is available, but I have no idea how I can run drush. Trying command like "drush cr" was not successful. I get the following error.

-bash: drush: command not found.

I don't want to be able to use Drush from everywhere.

How can I use Drush only from my_site_name_dir?

Answer 1

Basically, you need to follow steps on http://docs.drush.org/en/master/install and get Drush installed globally. It's possible to invoke Drush installed within Composer context together with Drupal 8 indicating the exact path something like /path-to-website-home/vendor/bin/drush. However, if you want Drush available anywhere in the system then get Drush Launcher installed.

Here is direct quote from http://docs.drush.org/en/master/install:

Optional. To be able to call drush from 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. If you skip this step, run Drush from Drupal root via ../vendor/bin/drush. In that case Drush's bash integration and custom prompt won't work.

You might also want to read How to get Drush to work with Composer and What is the right way of installing Drupal 8?

Answer 2

I got it by myself. There is no need to install drush globally. The composer command
composer require drush/drush
install all the necessary files for using drush. To make Drush run you need an alias to this file in your .bash_profile (mac users). I only add in the .bash_profile alias drush='vendor/drush/drush/drush'
And Drush works!
And there is also no need to have trouble with different drupal versions, because composer install the version you need.

Answer 3

Just an addition for windows users.

lesley n. answer above works just fine for Windows users as well.

Just edit C:\Users\your_username\.bash_profile and add one line:

alias drush='vendor/bin/drush'

Restart your Git Bash, go to your drupal site home folder and try:

drush version

It should work

I was able to make composer-installed Drupal Console to work with only "drupal" command also with one line addition to C:\Users\your_username\.bash_profile as well:

alias drupal='vendor/bin/drupal'

Restart your Git Bash, go to your drupal site home folder and try:

drupal --version

This should work as well.

These two solutions are much easier for me than installing Drush Launcher and Console Launcher on my Windows platform.

Please, note that due to the relative alias paths this only works when you call drush and drupal commands from inside your project root.

Answer 4

Drush only supports one install method. It requires that your Drupal site be built with Composer and Drush be listed as a dependency.

That 👆 means after you added Drush via composer require drush/drush to your project you then call Drush via vendor/bin/drush cr or vendor/drush/drush/drush cr from inside the project root.

If you are working on many Drupal (7, 8 and 8+) projects or if you are simply preferring to call a global drush command like you are used to you can install the Drush Launcher and then only have to type drush cr again from anywhere inside the project. The Drush Launcher simply picks up the local Drush in each project. Which is especially nice when you have projects requiring different versions of Drush.

See the new docs for more info and for a Drupal Compatibility chart.