Drush

General

Drush is a command line shell and scripting interface for Drupal, a veritable Swiss Army knife designed to make life easier for those of us who spend some of our working hours hacking away at the command prompt.

• drush.ws - man, etc.
  • drush.ws/resources
• drush-faq
• README

• issues
• drush compatible

Installation

• http://pear.drush.org/

pear channel-discover pear.drush.org
pear install drush/drush

• http://robinmonks.com/2012/02/installing-drush-on-a-shared-dreamhost-account/

• http://drupal.stackexchange.com/questions/10372/drush-open-basedir-error

Commands

I have dr as an alias for drush.

• http://knackforge.com/blog/sabareesh/most-frequently-used-drush-commands

drush help
  alll the commands!
drush help --filter
  choose which help category to echo

drush cc all
  clear cache

drush pml
  list installed and enabled modules

drush dl [project]
  download project
drush dl sasson-7.x-3.x-dev
  download sasson dev release
drush updb
  run upgrade.php

drush en [project] -y
  enable project without confirmation
drush dis [project] -y
  disable project

drush pm-uninstall [project]
  remove project from db

drush sql-cli < example.sql

drush php-eval 'echo drush_get_context("DRUSH_DRUPAL_ROOT");'
drush php-eval 'echo drush_locate_root() . "/" . drupal_get_path('theme', 'sasson');'

drush eval 'echo theme_get_setting('sasson_compiler') . "\n" ;'
  otherwise gives trailing issue?

drush vset --yes site_offline_message "This site is being maintained";

drush vset --yes site_offline 1;

In Drupal 7 to simply put the site into maintenance mode:

drush vset --yes maintenance_mode 1;

drush user-login ryan
  displays a one-time login link for the user ryan. 
open `drush user-login ryan`
  open said link in browser
dr uli

Site aliases

Drush uses site alias files to store context data. (Aegir still uses Drush 4)

drush help site-alias

• example.aliases.drushrc.php

Copy to ~/.drush, rename aliases.drushrc.php or further.

• Drush aliases
• gist: drush aliases template

drush ev 'print_r(array_keys(drush_sitealias_get_record("@server_master")))'
drush ev '$a = drush_sitealias_get_record("@gk.dev"); print_r($a["path-aliases"]);'

• http://api.drush.ws/api/drush/commands!sql!sync.sql.inc/function/drush_sql_sync/4.x
• http://api.drush.ws/api/drush/includes%21sitealias.inc/function/drush_sitealias_get_record/4.x

Deployment

To sort with Aegir#Remote

• drupal.org: Using drush to synchronize and deploy sites

drush help rsync
drush help sql-sync

• http://www.prometsource.com/blog/using-sql-sync-rsync-drush
• vimeo: Synchronising drupal sites from local to remote using drush site aliases
• youtube: Drush Tip: Use sql-sync to Quickly Move a Database

• http://drupalcode.org/project/drush.git/blob/HEAD:/examples/sync_enable.drush.inc
• http://drupalcode.org/project/drush.git/blob/HEAD:/examples/sync_via_http.drush.inc

Make

Drush Make is part of Drush as of Jan 2012.

.make files specify a recipe for modules, themes and libraries to be downloaded by Drush. Make files are used along with an install profile to make a distribution.

• Drush Make readme
• http://drupalcode.org/project/profiler.git/blob/refs/heads/7.x-2.x:/README.txt#l87

• Drush Make theory for happy profile development
• Using drush_make to optimize workflow - Basics of make/profile management from mig5's first article

drush make-generate filename.make
  generate make from a platform/site

• http://bojanz.wordpress.com/2013/05/29/distribution-drush-make/

• https://drupal.org/project/drush_remake
  • http://drupalcode.org/project/drush_remake.git/blob/HEAD:/README

Examples

• example.make

• https://github.com/mig5/builds
• github search

• http://drushmake.me/ - automatic generation demo

• introduce an options array in the root level of the makefile

Projects

projects[drupal][version]  = "7.16"
projects[drupal][patch][]  = "http://drupal.org/files/1356276-base-profile-d7-39-do-not-test.patch"

projects[sasson][type] = theme
projects[sasson][version] = 3.x-dev
projects[sasson][download][type] = git
projects[sasson][download][url] = http://git.drupal.org/project/sasson.git

projects[virtualmerchant][type] = "module"
projects[virtualmerchant][download][type] = "file"
projects[virtualmerchant][download][url] = "https://drupal.org/files/uc_virtualmerchant.zip"

local files;

• Include a "directory" download method to "download" from local directories
• http://drupal.org/files/0001-Issue-1837808-by-fgm-Include-a-directory-download-me.patch

Libraries

.make files can specify external libraries to be downloaded using the Libraries API module.

; CKEditor
libraries[ckeditor][download][type]= "get"
libraries[ckeditor][download][url] =  "[ckeditor zip url goes here]"
libraries[ckeditor][directory_name] = "ckeditor"
libraries[ckeditor][destination] = "libraries"

Sandbox

• http://drupal.stackexchange.com/questions/31492/is-it-possible-to-download-sandbox-projects-with-drush

core = 7.x
api = 2
; Sandbox module
projects[range_field][type] = module
projects[range_field][download][type] = git
projects[range_field][download][branch] = "7.x-1.x"
projects[range_field][download][url] = http://git.drupal.org/sandbox/Taran2L/1848632.git
projects[range_field][download][revision] = a1cc04da3c1dd957e6808b7e6a381c5970904863

Git

You can get things from git, specify branches, etc.

Also;

• http://drupal.org/node/1206340 - options array

Site build

See Profiles

Two make files; mysite.build and mysite.make.

mysite.build is brief:

core = 7.x
api = 2
projects[drupal][type] = "core"
; Our distribution
projects[mysite][type] = "profile"
projects[mysite][download][type] = "git"
projects[mysite][download][url] = "git@gitserver.com:mysite.git"
projects[mysite][download][branch] = "develop"

mysite.make contains the list of modules, themes, and libraries to download and add to the site.

Extras

• Drupal Audit - This shell script allows a quick "audit" of a website, giving some details about the configuration: drush status, hacked status (using Hacked module), modules & themes status, cache status (using Cacheaudit module), database volumetry indications, phpinfo() ...

• Drush Rebuild is a utility for rebuilding your local development environments, using your existing Drush aliases and an easy-to-read config file.
  • http://drupalcode.org/project/rebuild.git/blob/HEAD:/README.md
  • http://www.designhammer.com/blog/drush-rebuild-utility-rebuilding-drupal-development-environments

drush rebuild @example.local --source=@example.prod
  Rebuild the environment at `@example.local using the source `@example.prod`
drush rebuild @example.local --view-config
  View the config for rebuilding `@example.local`. Does not execute any tasks.
drush rebuild-info @example.local
  Displays statistics on rebuilds for `@example.local`

• Damien Tournoud's sandbox: Portable database dump

• dman's sandbox: Drush sync scripts - This dirty cluster of scripts has followed me around through a dozen servers now, sometimes living in private CVS, sometimes in the old Drupal sandbox.

• Drush zsh completion

• Drush UI - An experiment to stick an ncurses/Dialog interface ontop of Drush. This project is not to be taken seriously and use of it is actually discouraged.

Provision

See Aegir

• Drush Seed - Seed is a heavy-weight script for the mangement of Ubuntu based Drupal development servers. It gives users Drush-based access and management to server-level functionality such as: User accounts and SSH keys, MySQL users and databases, Drupal installs (known in Seed as projects) and aliases, Apache virtual hosts
  • http://fuseinteractive.ca/blog/introducing-seed-drush-based-server-management

• Drush Vagrant provides Drush commands to accomplish common Vagrant tasks, and provides a powerful templating framework ('blueprints'). It also has tools to implement Drush aliases for Vagrant projects and VMs, thus allowing simpler remote control of Vagrant projects.