X-Git-Url: https://yaffs.net/gitweb/?a=blobdiff_plain;f=vendor%2Fdrush%2Fdrush%2Fdocs%2Finstall.md;h=08a5151b11178e168b83c672a0a210857885c5b5;hb=1c1cb0980bfa6caf0c24cce671b6bb541dc87583;hp=072e3f2916b794015c502a2c16c6b7e718d36d1e;hpb=a2bd1bf0c2c1f1a17d188f4dc0726a45494cefae;p=yaffs-website diff --git a/vendor/drush/drush/docs/install.md b/vendor/drush/drush/docs/install.md index 072e3f291..08a5151b1 100644 --- a/vendor/drush/drush/docs/install.md +++ b/vendor/drush/drush/docs/install.md @@ -1,43 +1,85 @@ -Install/Upgrade a global Drush ---------------- -```bash -# Download latest stable release using the code below or browse to github.com/drush-ops/drush/releases. -wget http://files.drush.org/drush.phar -# Or use our upcoming release: wget http://files.drush.org/drush-unstable.phar +!!! note -# Test your install. -php drush.phar core-status - -# Rename to `drush` instead of `php drush.phar`. Destination can be anywhere on $PATH. -chmod +x drush.phar -sudo mv drush.phar /usr/local/bin/drush - -# Optional. Enrich the bash startup file with completion and aliases. -drush init -``` + 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. -* MAMP users, and anyone wishing to launch a non-default PHP, needs to [edit ~/.bashrc so that the right PHP is in your $PATH](http://stackoverflow.com/questions/4145667/how-to-override-the-path-of-php-to-use-the-mamp-path/10653443#10653443). -* We have documented [alternative ways to install](http://docs.drush.org/en/master/install-alternative/), including [Windows](http://docs.drush.org/en/master/install-alternative/#windows). -* If you need to pass custom php.ini values, run `php -d foo=bar drush.phar --php-options=foo=bar` -* Your shell now has [useful bash aliases and tab completion for command names, site aliases, options, and arguments](https://raw.githubusercontent.com/drush-ops/drush/master/examples/example.bashrc). -* A [drushrc.php](https://raw.githubusercontent.com/drush-ops/drush/master/examples/example.drushrc.php) has been copied to ~/.drush above. Customize it to save typing and standardize options for commands. -* Upgrade using this same procedure. + See the [Drush 8 docs](http://docs.drush.org/en/8.x) for installing prior versions of Drush. -Install a site-local Drush +Install a site-local Drush and Drush Launcher. ----------------- -In addition to the global Drush, it is recommended that Drupal 8 sites be [built using Composer, with Drush listed as a dependency](https://github.com/drupal-composer/drupal-project). +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`. +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. +1. Optional. Run `drush init`. This edits ~/.bashrc so that Drush's custom prompt and bash integration are active. + +See [Usage](http://docs.drush.org/en/master/usage/) for details on using Drush. -1. When you run `drush`, the global Drush is called first and then hands execution to the site-local Drush. This gives you the convenience of running `drush` without specifying the full path to the executable, without sacrificing the safety provided by a site-local Drush. -2. Optional: Copy the [examples/drush.wrapper](https://github.com/drush-ops/drush/blob/master/examples/drush.wrapper) file to your project root and modify to taste. This is a handy launcher script; add --local here to turn off all global configuration locations, and maintain consistency over configuration/aliases/commandfiles for your team. -3. Note that if you have multiple Drupal sites on your system, it is possible to use a different version of Drush with each one. +- 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 ...` +- Tip: To use a custom php.ini for Drush requests, [see this comment](https://github.com/drush-ops/drush/issues/3294#issuecomment-370201342). + +!!! note + + 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. Drupal Compatibility ----------------- -Drush Version | Drush Branch | PHP | Compatible Drupal versions | Code Status -------------- | --------- | --- | -------------------------- | ----------- -Drush 9 | [master](https://travis-ci.org/drush-ops/drush) | 5.5+ | D7, D8 | -Drush 8 | [8.x](https://travis-ci.org/drush-ops/drush) | 5.4.5+ | D6, D7, D8 | -Drush 7 | [7.x](https://travis-ci.org/drush-ops/drush) | 5.3.0+ | D6, D7 | -Drush 6 | [6.x](https://travis-ci.org/drush-ops/drush) | 5.3.0+ | D6, D7 | Unsupported -Drush 5 | [5.x](https://travis-ci.org/drush-ops/drush) | 5.2.0+ | D6, D7 | Unsupported - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Drush Version Drush Branch PHP Supported Drupal versions Code Style Isolation Tests Functional Tests
Drush 9 master 5.6+ D8.4+ + + + + + +
Drush 8 8.x 5.4.5+ D6, D7, D8.3- + + + - + + +
Drush 7 7.x 5.3.0+ D6, D7 Unsupported
Drush 6 6.x 5.3.0+ D6, D7 Unsupported
Drush 5 5.x 5.2.0+ D6, D7 Unsupported