Drupal Module : Drush


Drush is a command line shell and Unix scripting interface for Drupal. Drush core ships with lots of useful commands for interacting with code like modules/themes/profiles. Similarly, it runs update.php, executes sql queries and DB migrations, and misc utilities like run cron or clear cache. Drush can be extended by 3rd party commandfiles.

Drush Commands List
Core drush commands: (core)
archive-dump (ard, Backup your code, files, and database into a single file.
archive-backup, arb)
archive-restore Expand a site archive into a Drupal web site.
(arr)
cache-clear (cc) Clear a specific cache, or all drupal caches.
cache-get (cg) Fetch a cached object and display it.
cache-set (cs) Cache an object expressed in JSON or var_export() format.
core-config (conf, Edit drushrc, site alias, and Drupal settings.php files.
config)
core-cron (cron) Run all cron hooks in all active modules for specified site.
core-execute (exec, Execute a shell command. Usually used with a site alias.
execute)
core-quick-drupal Download, install, serve and login to Drupal with minimal configuration and dependencies.
(qd)
core-requirements Provides information about things that may be wrong in your Drupal installation, if any.
(status-report, rq)
core-rsync (rsync) Rsync the Drupal tree to/from another server using ssh.
core-status (status, Provides a birds-eye view of the current Drupal installation, if any.
st)
core-topic (topic) Read detailed documentation on a given topic.
drupal-directory Return path to a given module/theme directory.
(dd)
help Print this help message. See `drush help help` for more options.
image-flush Flush all derived images for a given style.
php-eval (eval, ev) Evaluate arbitrary php code after bootstrapping Drupal (if available).
php-script (scr) Run php script(s).
queue-list Returns a list of all defined queues
queue-run Run a specific queue by name
search-index Index the remaining search items without wiping the index.
search-reindex Force the search index to be rebuilt.
search-status Show how many items remain to be indexed out of the total.
self-update Check to see if there is a newer Drush release available.
(selfupdate)
shell-alias (sha) Print all known shell alias records.
site-alias (sa) Print site alias records for all known site aliases and local sites.
site-install (si) Install Drupal along with modules/themes/configuration using the specified install profile.
site-reset Reset a persistently set site.
site-set (use) Set a site alias to work on that will persist for the current session.
site-ssh (ssh) Connect to a Drupal site's server via SSH for an interactive session or to run a shell command
test-clean Clean temporary tables and files.
test-run Run tests. Note that you must use the --uri option.
updatedb (updb) Apply any database updates required (as with running update.php).
usage-send (usend) Send anonymous Drush usage information to statistics logging site. Usage statistics contain the Drush command name and the Drush
option names, but no arguments or option values.
usage-show (ushow) Show Drush usage information that has been logged but not sent. Usage statistics contain the Drush command name and the Drush
option names, but no arguments or option values.
variable-delete Delete a variable.
(vdel)
variable-get (vget) Get a list of some or all site variables and values.
variable-set (vset) Set a variable.
version Show drush version.
watchdog-delete Delete watchdog messages.
(wd-del, wd-delete)
watchdog-list Show available message types and severity levels. A prompt will ask for a choice to show watchdog messages.
(wd-list)
watchdog-show Show watchdog messages.
(wd-show, ws)

CTools commands: (ctools)
ctools-export (ctex) Export multiple CTools exportable objects directly to code.
ctools-export-disabl Disable CTools exportables.
e (cted)
ctools-export-enable Enable CTools exportables.
(ctee)
ctools-export-info Show available CTools exportable objects.
(ctei)
ctools-export-revert Revert CTools exportables from changes overridden in the database.
(cter)
ctools-export-view View CTools exportable object code output.
(ctev)

Runserver commands: (runserver)
runserver (rs) Runs a lightweight built in http server for development.

Field commands: (field)
field-clone Clone a field and all its instances.
field-create Create fields and instances. Returns urls for field editing.
field-delete Delete a field and its instances.
field-info View information about fields, field_types, and widgets.
field-update Return URL for field editing web page.

Project manager commands: (pm)
pm-disable (dis) Disable one or more extensions (modules or themes).
pm-download (dl) Download projects from drupal.org or other sources.
pm-enable (en) Enable one or more extensions (modules or themes).
pm-info (pmi) Show detailed info for one or more extensions (modules or themes).
pm-list (pml) Show a list of available extensions (modules and themes).
pm-refresh (rf) Refresh update status information.
pm-releasenotes Print release notes for given projects.
(rln)
pm-releases (rl) Print release information for given projects.
pm-uninstall Uninstall one or more modules.
pm-update (up) Update Drupal core and contrib projects and apply any pending database updates (Same as pm-updatecode + updatedb).
pm-updatecode (upc) Update Drupal core and contrib projects to latest recommended releases.

SQL commands: (sql)
sql-cli (sqlc) Open a SQL command-line interface using Drupal's credentials.
sql-connect A string for connecting to the DB.
sql-create Create a database.
sql-drop Drop all tables in a given database.
sql-dump Exports the Drupal DB as SQL using mysqldump or equivalent.
sql-query (sqlq) Execute a query against the site database.
sql-sync Copy and import source database to target database. Transfers via rsync.

User commands: (user)
user-add-role (urol) Add a role to the specified user accounts.
user-block (ublk) Block the specified user(s).
user-cancel (ucan) Cancel a user account with the specified name.
user-create (ucrt) Create a user account with the specified name.
user-information Print information about the specified user(s).
(uinf)
user-login (uli) Display a one time login link for the given user account (defaults to uid 1).
user-password (upwd) (Re)Set the password for the user account with the specified name.
user-remove-role Remove a role from the specified user accounts.
(urrol)
user-unblock (uublk) Unblock the specified user(s).

All commands in backup_migrate: (backup_migrate)
bam-backup (bb) Backup the site's database with Backup and Migrate.
bam-backups Get a list of previously created backup files.
bam-destinations Get a list of available destinations.
bam-profiles Get a list of available settings profiles.
bam-restore Restore the site's database with Backup and Migrate.
bam-sources Get a list of available sources.

All commands in devel: (devel)
devel-download Downloads the FirePHP library from http://firephp.org/.
devel-reinstall Disable, Uninstall, and Install a list of projects.
(dre)
devel-token (token) List available tokens
fn-hook (fnh, hook) List implementations of a given hook and explore the source of the selected one.
fn-view (fnv) Show the source of specified function or method.

All commands in devel_generate: (devel_generate)
generate-content Create content.
(genc)
generate-menus Create menus and menu items.
(genm)
generate-terms Create terms in specified vocabulary.
(gent)
generate-users Create users.
(genu)
generate-vocabs Create vocabularies.
(genv)

All commands in search_api: (search_api)
search-api-clear Clear one or all search indexes and mark them for re-indexing.
(sapi-c)
search-api-disable Disable one or all enabled search_api indexes.
(sapi-dis)
search-api-enable Enable one or all disabled search_api indexes.
(sapi-en)
search-api-index Index items for one or all enabled search_api indexes.
(sapi-i)
search-api-list List all search indexes.
(sapi-l)
search-api-reindex Force reindexing of one or all search indexes, without clearing existing index data.
(sapi-r)
search-api-set-index Set the search server used by a given index.
-server (sapi-sis)
search-api-status Show the status of one or all search indexes.
(sapi-s)

All commands in views: (views)
views-analyze (va) Get a list of all Views analyze warnings
views-dev (vd) Set the Views settings to more developer-oriented values.
views-disable (vdis) Disable the specified views.
views-enable (ven) Enable the specified views.
views-list (vl) Get a list of all views in the system.
views-revert (vr) Revert overridden views to their default state. Make sure to backup first.

Other commands: (colorbox,ds,libraries,make,registry_rebuild,variable_realm)
colorbox-plugin Download and install the Colorbox plugin.
(colorboxplugin)
ds-build Create a basic template and configuration file for a new Display Suite layout.
libraries-list Lists registered library information.
make Turns a makefile into a working Drupal codebase.
make-generate Generate a makefile from the current Drupal site.
(generate-makefile)
registry-rebuild Rebuild the registry table (for classes) and the system table (for module locations) in a Drupal install.
(rr)
variable-realm-del Delete a variable for a specific realm and key.
variable-realm-get Get a variable for a specific realm and key.
variable-realm-set Set a variable for a specific realm and key.

Maintenance status: Actively maintained
Development status: Under active development
Reported installs: 106 sites currently report using this module. View usage statistics.
Downloads: 1,270,995


Add new comment

Plain text

  • No HTML tags allowed.
  • Web page addresses and e-mail addresses turn into links automatically.
  • Lines and paragraphs break automatically.
Image CAPTCHA