webflo/drush-shim

This package is abandoned and no longer maintained. The author suggests using the drush/drush-launcher package instead.

Provides a drush executable for your global PATH

0.10.0 2022-01-13 17:50 UTC

Requires

• composer/xdebug-handler: ^1.0
• laravel-zero/phar-updater: ^1.1
• webflo/drupal-finder: ^1.0
• webmozart/path-util: ^2.3

Conflicts

• drush/drush: *

GPL-2.0-or-later

• Florian Weber

README

A small wrapper around Drush for your global $PATH.

Why?

In order to avoid dependency issues, it is best to require Drush on a per-project basis via Composer (composer require drush/drush). This makes Drush available to your project by placing it at vendor/bin/drush.

However, it is inconvenient to type vendor/bin/drush in order to execute Drush commands. By installing the drush launcher globally on your local machine, you can simply type drush on the command line, and the launcher will find and execute the project specific version of drush located in your project's vendor directory.

Installation - Phar

1. Download latest stable release via CLI (code below) or browse to https://github.com/drush-ops/drush-launcher/releases/latest.

   OSX:

   curl -OL https://github.com/drush-ops/drush-launcher/releases/latest/download/drush.phar

   Linux:

   wget -O drush.phar https://github.com/drush-ops/drush-launcher/releases/latest/download/drush.phar

2. Make downloaded file executable: chmod +x drush.phar

3. Move drush.phar to a location listed in your $PATH, rename to drush:

   sudo mv drush.phar /usr/local/bin/drush

4. Windows users: create a drush.bat file in the same folder as drush.phar with the following lines. This gets around the problem where Windows does not know that the drush file is associated with php:

   @echo off
   php "%~dp0\drush" %*

Update

The Drush Launcher Phar is able to self update to the latest release.

    drush self-update

Alternatives

Just add /path/to/vendor/bin to the front of your $PATH. This is trivial when you have only one Drupal codebase on your system (e.g. site is in Docker). When your system has multiple codebases, consider using direnv to add to $PATH on a per-codebase basis. An example .envrc file.

Fallback

When a site-local Drush is not found, this launcher usually throws a helpful error. You may avoid the error and instead hand off execution to a global Drush (any version) by exporting an environment variable.

export DRUSH_LAUNCHER_FALLBACK=/path/to/drush

Xdebug compatibility

Drush Launcher, like Composer automatically disables Xdebug by default. This improves performance substantially. You may override this feature by setting an environment variable. DRUSH_ALLOW_XDEBUG=1 drush [command]

License

GPL-2.0+