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

Drush version 8 documentation. Documentation was created with latest source code from GitHub at Sun 13 Dec 2020 03:01:05 AM CET

Execute a drush command. Run `drush help [command]` to view command-specific
help.  Run `drush topic` to read even more documentation.

Global options (see `drush topic core-global-options` for the full list):
 -d, --debug                               Display even more information,       
                                           including internal messages.         
 -h, --help                                This help system.                    
 -n, --no                                  Assume 'no' as answer to all         
                                           prompts.                             
 -r , --root=                  Drupal root directory to use         
                                           (default: current directory).        
 -s, --simulate                            Simulate all relevant actions (don't 
                                           actually change the system).         
 -l ,             URI of the drupal site to use (only  
 --uri=           needed in multisite environments or  
                                           when running on an alternate port).  
 -v, --verbose                             Display extra information about the  
                                           command.                             
 -y, --yes                                 Assume 'yes' as answer to all        
                                           prompts.

Core Drush commands: (core)
 archive-dump (ard,    Backup your code, files, and database into a single      
 archive-backup, arb,  file.                                                    
 archive:dump)                                                                  
 archive-restore       Expand a site archive into a Drupal web site.            
 (arr,                                                                          
 archive:restore)                                                               
 core-cli (php,        Open an interactive shell on a Drupal site.              
 core:cli)                                                                      
 core-config (conf,    Edit drushrc, site alias, and Drupal settings.php files. 
 config, core:config)                                                           
 core-cron (cron,      Run all cron hooks in all active modules for specified   
 core:cron)            site.                                                    
 core-execute (exec,   Execute a shell command. Usually used with a site alias. 
 execute,                                                                       
 core:execute)                                                                  
 core-init (init,      Enrich the bash startup file with completion and         
 core:init)            aliases. Copy .drushrc file to ~/.drush                  
 core-quick-drupal     Download, install, serve and login to Drupal with        
 (qd, cutie,           minimal configuration and dependencies.                  
 core:quick:drupal)                                                             
 core-requirements     Provides information about things that may be wrong in   
 (status-report, rq,   your Drupal installation, if any.                        
 core:requirements)                                                             
 core-rsync (rsync,    Rsync the Drupal tree to/from another server using ssh.  
 core:rsync)                                                                    
 core-status (status,  Provides a birds-eye view of the current Drupal          
 st, core:status)      installation, if any.                                    
 core-topic (topic,    Read detailed documentation on a given topic.            
 core:topic)                                                                    
 do:sanitize           Performs database sanitization.                          
 (do-sanitize)                                                                  
 drupal-directory      Return the filesystem path for modules/themes and other  
 (dd,                  key folders.                                             
 drupal:directory)                                                              
 entity-updates        Apply pending entity schema updates.                     
 (entup,                                                                        
 entity:updates)                                                                
 help                  Print this help message. See `drush help help` for more  
                       options.                                                 
 image-derive (id,     Create an image derivative.                              
 image:derive)                                                                  
 image-flush (if,      Flush all derived images for a given style.              
 image:flush)                                                                   
 new-status                                                                     
 php-eval (eval, ev,   Evaluate arbitrary php code after bootstrapping Drupal   
 php:eval)             (if available).                                          
 php-script (scr,      Run php script(s).                                       
 php:script)                                                                    
 queue-list            Returns a list of all defined queues                     
 queue-run             Run a specific queue by name                             
 (queue:run)                                                                    
 sanitize:comments     Sanitizes comments_field_data table.                     
 (sanitize-comments)                                                            
 sanitize:sessions     Truncates the session table.                             
 (sanitize-sessions)                                                            
 sanitize:table-colum  Replaces all values in given table column with the       
 n                     specified value.                                         
 (sanitize-table-colu                                                           
 mn)                                                                            
 sanitize:user-fields  Sanitize string fields associated with the user.         
 (sanitize-user-field                                                           
 s)                                                                             
 shell-alias (sha,     Print all known shell alias records.                     
 shell:alias)                                                                   
 site-alias (sa,       Print site alias records for all known site aliases and  
 site:alias)           local sites.                                             
 site-install (si,     Install Drupal along with modules/themes/configuration   
 site:install)         using the specified install profile.                     
 site-set (use,        Set a site alias to work on that will persist for the    
 site:set)             current session.                                         
 site-ssh (ssh,        Connect to a Drupal site's server via SSH for an         
 site:ssh)             interactive session or to run a shell command            
 sql-sanitize          Run sanitization operations on the current database.     
 (sqlsan)                                                                       
 twig-compile (twigc,  Compile all Twig template(s).                            
 twig:compile)                                                                  
 updatedb (updb)       Apply any database updates required (as with running     
                       update.php).                                             
 updatedb-status       List any pending database updates.                       
 (updbst,                                                                       
 updatedb:status)                                                               
 variable-delete       Delete a variable.                                       
 (vdel,                                                                         
 variable:delete)                                                               
 variable-get (vget,   Get a list of some or all site variables and values.     
 variable:get)                                                                  
 variable-set (vset,   Set a variable.                                          
 variable:set)                                                                  
 version               Show drush version.                                      
 wrap:table-name       Wraps a table name in brackets if a database prefix is   
 (wrap-table-name)     being used.
Cache commands: (cache)
 cache-clear (cc,    Clear a specific cache, or all drupal caches.     
 cache:clear)                                                          
 cache-get (cg,      Fetch a cached object and display it.             
 cache:get)                                                            
 cache-rebuild (cr,  Rebuild a Drupal 8 site and clear all its caches. 
 rebuild,                                                              
 cache:rebuild)                                                        
 cache-set (cs,      Cache an object expressed in JSON or var_export() 
 cache:set)          format.
Config commands: (config)
 config-delete (cdel,  Delete a configuration object.                           
 config:delete)                                                                 
 config-edit (cedit,   Open a config file in a text editor. Edits are imported  
 config:edit)          into active configuration after closing editor.          
 config-export (cex,   Export configuration to a directory.                     
 config:export)                                                                 
 config-get (cget,     Display a config value, or a whole configuration object. 
 config:get)                                                                    
 config-import (cim,   Import config from a config directory.                   
 config:import)                                                                 
 config-list (cli,     List config names by prefix.                             
 config:list)                                                                   
 config-pull (cpull,   Export and transfer config from one environment to       
 config:pull)          another.                                                 
 config-set (cset,     Set config value directly. Does not perform a config     
 config:set)           import.
Field commands: (field)
 field-clone           Clone a field and all its instances.                     
 (field:clone)                                                                  
 field-create          Create fields and instances. Returns urls for field      
 (field:create)        editing.                                                 
 field-delete          Delete a field and its instances.                        
 (field:delete)                                                                 
 field-info            View information about fields, field_types, and widgets. 
 field-update          Return URL for field editing web page.                   
 (field:update)
Make commands: (make)
 make                  Turns a makefile into a working Drupal codebase.        
 make-convert          Convert a legacy makefile into another format. Defaults 
                       to converting .make => .make.yml.                       
 make-generate         Generate a makefile from the current Drupal site.       
 (generate-makefile)                                                           
 make-lock             Process a makefile and outputs an equivalent makefile   
                       with projects version *resolved*. Respects pinned       
                       versions.                                               
 make-update           Process a makefile and outputs an equivalent makefile   
                       with projects version resolved to latest available.
Project manager commands: (pm)
 pm-disable (dis,     Disable one or more extensions (modules or themes).     
 pm:disable)                                                                  
 pm-download (dl,     Download projects from drupal.org or other sources.     
 pm:download)                                                                 
 pm-enable (en,       Enable one or more extensions (modules or themes).      
 pm:enable)                                                                   
 pm-info (pmi,        Show detailed info for one or more extensions (modules  
 pm:info)             or themes).                                             
 pm-list (pml,        Show a list of available extensions (modules and        
 pm:list)             themes).                                                
 pm-projectinfo       Show a report of available projects and their           
 (pmpi,               extensions.                                             
 pm:projectinfo)                                                              
 pm-refresh (rf,      Refresh update status information.                      
 pm:refresh)                                                                  
 pm-releasenotes      Print release notes for given projects.                 
 (rln,                                                                        
 pm:releasenotes)                                                             
 pm-releases (rl,     Print release information for given projects.           
 pm:releases)                                                                 
 pm-uninstall (pmu,   Uninstall one or more modules and their dependent       
 pm:uninstall)        modules.                                                
 pm-update (up,       Update Drupal core and contrib projects and apply any   
 pm:update)           pending database updates (Same as pm-updatecode +       
                      updatedb).                                              
 pm-updatecode (upc,  Update Drupal core and contrib projects to latest       
 pm:updatecode)       recommended releases.                                   
 pm-updatestatus      Show a report of available minor updates to Drupal core 
 (ups,                and contrib projects.                                   
 pm:updatestatus)
Role commands: (role)
 role-add-perm (rap,  Grant specified permission(s) to a role.                 
 role:add:perm)                                                                
 role-create (rcrt,   Create a new role.                                       
 role:create)                                                                  
 role-delete (rdel,   Delete a role.                                           
 role:delete)                                                                  
 role-list (rls,      Display a list of all roles defined on the system.  If a 
 role:list)           role name is provided as an argument, then all of the    
                      permissions of that role will be listed.  If a           
                      permission name is provided as an option, then all of    
                      the roles that have been granted that permission will be 
                      listed.                                                  
 role-remove-perm     Remove specified permission(s) from a role.              
 (rmp,                                                                         
 role:remove:perm)
Runserver commands: (runserver)
 runserver (rs)        Runs PHP's built-in http server for development.
SQL commands: (sql)
 sql-cli (sqlc,        Open a SQL command-line interface using Drupal's     
 sql:cli)              credentials.                                         
 sql-connect           A string for connecting to the DB.                   
 (sql:connect)                                                              
 sql-create            Create a database.                                   
 (sql:create)                                                               
 sql-drop (sql:drop)   Drop all tables in a given database.                 
 sql-dump (sql:dump)   Exports the Drupal DB as SQL using mysqldump or      
                       equivalent.                                          
 sql-query (sqlq,      Execute a query against a database.                  
 sql:query)                                                                 
 sql-sync              Copies the database contents from a source site to a 
                       target site. Transfers the database dump via rsync.
Search commands: (search)
 search-index          Index the remaining search items without wiping the 
                       index.                                              
 search-reindex        Force the search index to be rebuilt.               
 (search:index)                                                            
 search-status         Show how many items remain to be indexed out of the 
                       total.
State commands: (state)
 state-delete (sdel,  Delete a state value.  
 state:delete)                               
 state-get (sget,     Display a state value. 
 state:get)                                  
 state-set (sset,     Set a state value.     
 state:set)
User commands: (user)
 user-add-role (urol,  Add a role to the specified user accounts.               
 user:add:role)                                                                 
 user-block (ublk,     Block the specified user(s).                             
 user:block)                                                                    
 user-cancel (ucan,    Cancel a user account with the specified name.           
 user:cancel)                                                                   
 user-create (ucrt,    Create a user account with the specified name.           
 user:create)                                                                   
 user-information      Print information about the specified user(s).           
 (uinf,                                                                         
 user:information)                                                              
 user-login (uli,      Display a one time login link for the given user account 
 user:login)           (defaults to uid 1).                                     
 user-password (upwd,  (Re)Set the password for the user account with the       
 user:password)        specified name.                                          
 user-remove-role      Remove a role from the specified user accounts.          
 (urrol,                                                                        
 user:remove:role)                                                              
 user-unblock (uublk,  Unblock the specified user(s).                           
 user:unblock)
Watchdog commands: (watchdog)
 watchdog-delete      Delete watchdog messages.                               
 (wd-del, wd-delete,                                                          
 watchdog:delete)                                                             
 watchdog-list        Show available message types and severity levels. A     
 (wd-list,            prompt will ask for a choice to show watchdog messages. 
 watchdog:list)                                                               
 watchdog-show        Show watchdog messages.                                 
 (wd-show, ws,                                                                
 watchdog:show)