www.aleph1.co.uk Git - yaffs-website/blob - vendor/drush/drush/docs/install.md

   1 !!! note
   2
   3     Drush 9 only supports one install method. It requires that your Drupal 8 site be built with Composer and Drush be listed as a dependency.
   4
   5     See the [Drush 8 docs](http://docs.drush.org/en/8.x) for installing prior versions of Drush.
   6
   7 Install a site-local Drush and Drush Launcher.
   8 -----------------
   9 1. It is recommended that Drupal 8 sites be [built using Composer, with Drush listed as a dependency](https://github.com/drupal-composer/drupal-project). That project already includes Drush in its composer.json. If your Composer project doesn't yet depend on Drush, run `composer require drush/drush` to add it. After this step, you may call Drush via `vendor/bin/drush`.
  10 1. Optional. To be able to call `drush` from anywhere, install the [Drush Launcher](https://github.com/drush-ops/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.
  11 1. Optional. Run `drush init`. This edits ~/.bashrc so that Drush's custom prompt and bash integration are active.
  12
  13 See [Usage](http://docs.drush.org/en/master/usage/) for details on using Drush.
  14
  15 - Tip: To use a non-default PHP, [edit ~/.bashrc so that the desired PHP is in front of your $PATH](http://stackoverflow.com/questions/4145667/how-to-override-the-path-of-php-to-use-the-mamp-path/10653443#10653443). If that is not desirable, you can change your PATH for just one request: `PATH=/path/to/php:$PATH` drush status ...`
  16 - Tip: To use a custom php.ini for Drush requests, [see this comment](https://github.com/drush-ops/drush/issues/3294#issuecomment-370201342).
  17
  18 !!! note
  19
  20     Drush 9 cannot run commandfiles from Drush 8 and below (e.g. example.drush.inc). See our [guide on porting commandfiles](https://weitzman.github.io/blog/port-to-drush9). Also note that alias and config files use a new .yml format in Drush 9.
  21
  22 Drupal Compatibility
  23 -----------------
  24 <table>
  25   <tr>
  26     <th> Drush Version </th>
  27     <th> Drush Branch </th>
  28     <th> PHP </th>
  29     <th> Supported Drupal versions </th>
  30     <th> Code Style </th>
  31     <th> Isolation Tests </th>
  32     <th> Functional Tests </th>
  33   </tr>
  34   <tr>
  35     <td> Drush 9 </td>
  36     <td> <a href="https://travis-ci.org/drush-ops/drush">master</a> </td>
  37     <td> 5.6+ </td>
  38     <td> D8.4+ </td>
  39     <td align="center">
  40       <img src="https://api.shippable.com/projects/5507addd5ab6cc1352a213b5/badge?branch=master" />
  41     </td>
  42     <td align="center">
  43       <img src="https://travis-ci.org/drush-ops/drush.svg?branch=master" />
  44     </td>
  45     <td align="center">
  46       <img src="https://circleci.com/gh/drush-ops/drush.svg?style=shield" />
  47     </td>
  48   </tr>
  49   <tr>
  50     <td> Drush 8 </td>
  51     <td> <a href="https://travis-ci.org/drush-ops/drush">8.x</a> </td>
  52     <td> 5.4.5+ </td>
  53     <td> D6, D7, D8.3- </td>
  54     <td align="center">
  55       <img src="https://circleci.com/gh/drush-ops/drush.svg?style=shield" />
  56     </td>
  57     <td align="center">
  58       -
  59     </td>
  60     <td align="center">
  61       <img src="https://travis-ci.org/drush-ops/drush.svg?branch=8.x" />
  62     </td>
  63   </tr>
  64   <tr>
  65     <td> Drush 7 </td>
  66     <td> <a href="https://travis-ci.org/drush-ops/drush">7.x</a> </td>
  67     <td> 5.3.0+ </td>
  68     <td> D6, D7 </td>
  69     <td colspan="3" align="center"> Unsupported </td>
  70   </tr>
  71   <tr>
  72     <td> Drush 6 </td>
  73     <td> <a href="https://travis-ci.org/drush-ops/drush">6.x</a> </td>
  74     <td> 5.3.0+ </td>
  75     <td> D6, D7 </td>
  76     <td colspan="3" align="center"> Unsupported </td>
  77   </tr>
  78   <tr>
  79     <td> Drush 5 </td>
  80     <td> <a href="https://travis-ci.org/drush-ops/drush">5.x</a> </td>
  81     <td> 5.2.0+ </td>
  82     <td> D6, D7 </td>
  83     <td colspan="3" align="center"> Unsupported </td>
  84   </tr>
  85 </table>