Drush

Category: Drush

Check configurable field information

Lists all configurable fields of an entity bundle.
Check configurable field information
              

                

                  

              

              
/**
* Lists the configurable fields for a bundle.
*/
drush field:info node article;
 

Check Drupal directory with Drush

Returns the file system path for modules, themes, etc.
Check Drupal directory with Drush
              

                

                  

              

              
/**
* Displays the directory path for modules, themes or other items.
*/
drush drupal:directory modules/contrib;
// Alias: dr:dir
// Output: /var/www/html/modules/contrib
 

Check environment information with Drush

Gets a summary of the environment status (Drush and Drupal).
Check environment information with Drush
              

                

                  

              

              
/**
* Displays a summary of the status of the Drupal and Drush environment.
*/
drush core:status;

 

Check status report with Drush

Displays the system requirements status (status report).
Check status report with Drush
              

                

                  

              

              
/**
* Displays the Drupal site requirements report.
*/
drush core:requirements
 

Check translation updates with Drush

Checks for available translation updates.
Check translation updates with Drush
              

                

                  

              

              
/**
* Check for updates in translations.
*/
drush locale:check;

Clear translation update status with Drush

Clears translation update status flags.
Clear translation update status with Drush
              

                

                  

              

              
/**
* Clears the status of translation updates.
*/
drush locale:clear-status;
 

Create an Admin User using Drush

Creates a new user with a specified username and password.
Create an Admin User using Drush
              

                

                  

              

              
/**
* Create a new user with a password.
*/
drush user:create username --mail=user@example.com --password=password;
 

Creates a new field with Drush

Creates a new field (storage and instance).
Creates a new field with Drush
              

                

                  

              

              
/**
* Creates a new field for an entity bundle.
*/
drush field:create node article field_tags taxonomy_term;
 

Dump a whole project

Backs up the code, files and database in a single file.
Dump a whole project
              

                

                  

              

              
/**
* Creates an archive dump that includes code, files and database.
*/
drush archive:dump --destination=/path/to/archive.tar.gz --overwrite --exclude-code-paths=web/sites/default/settings.php
// Alias: N/A
// Output: Archive created at /path/to/archive.tar.gz
 

Export translations with Drush

Export translations to a PO file (gettext).
Export translations with Drush
              

                

                  

              

              
/**
* Export translations to a .po file.
*/
drush locale:export fr --file=translations.fr.po;
 

Generate code with Drush

Generate code base (boilerplate) for modules, plugins, etc.
Generate code with Drush
              

                

                  

              

              
/**
* Generates code base for different elements (modules, plugins, etc.).
*/
drush generate;
 

Get maintenance status

Gets the status of the maintenance mode.
Get maintenance status
              

                

                  

              

              
/**
* Shows whether the maintenance mode is activated or not.
*/
drush maint:get;
Alias: N/A
Output: Maintenance mode is OFF.
 

Import translations with Drush

Import translations from a .po file.
Import translations with Drush
              

                

                  

              

              
/**
* Import translations from a .po file.
*/
drush locale:import fr translations.fr.po;
 

Install and uninstall a module with drush in Drupal

Install/Uninstalls a module from Drupal. When uninstalling, this also removes any associated configuration.
Install and uninstall a module with drush in Drupal
              

                

                  

              

              
/**
* Enable a specific module.
*/
drush en module_name -y;
 
/**
* Uninstall a specific module.
*/
drush pm:uninstall module_name -y;
 

List all Drush commands

Lists all commands available in Drush.
List all Drush commands
              

                

                  

              

              
/**
* Displays a complete list of Drush commands.
*/
drush list;
 

List field entity base information

Lists all base fields of an entity type.
List field entity base information
              

                

                  

              

              
/**
*  Lists the base fields of an entity.
*/
drush field:base-info node;
// Alias: N/A
// Example output:
// ------------------------------- ---------- ------------------ ------------- 
// Field name Required Field type Cardinality 
// ------------------------------- ---------- ------------------ ------------- 
// nid integer 1 
// uuid uuid 1 
// vid integer 1 
// langcode language 1 
// type ✔ entity_reference 1 
// revision_timestamp created 1 
// revision_uid entity_reference 1 
// revision_log string_long 1 
// status boolean 1 
// uid entity_reference 1 
// title ✔ string 1 
// created created 1 
// changed changed 1 
// promote boolean 1 
// sticky boolean 1 
// default_langcode boolean 1 
// revision_default boolean 1 
// revision_translation_affected boolean 1 
// metatag metatag_computed -1 
// path path 1 
// menu_link entity_reference 1 
// content_translation_source language 1 
// content_translation_outdated boolean 1 
// ------------------------------- ---------- ------------------ ------------- 
 

Overwrite a base field with Drush

Creates a new base field overwrite for a bundle.
Overwrite a base field with Drush
              

                

                  

              

              
/**
* Creates an overwrite of a base field for a bundle.
*/
drush field:base-override-create node article field_example;
 

Post-Deploy command

Execute several commands after a code deployment.
Post-Deploy command
              

                

                  

              

              
/**
* Executes post-deployment commands.
*/
drush deploy;
 

Remove a field with Drush

Removes a field from an entity bundle.
Remove a field with Drush
              

                

                  

              

              
/**
* Removes a field from a bundle.
*/
drush field:delete node article field_tags;
 

Remove entities with Drush

Removes content entities.
Remove entities with Drush
              

                

                  

              

              
/**
* Removes content entities from a given bundle.
*/
drush entity:delete node --bundle=article;
 

Set configuration value with Drush

Sets and saves a configuration value directly.
Set configuration value with Drush
              

                

                  

              

              
/**
* Saves a configuration value directly.
*/
drush config:set system.site name "New Site Name";
 

Update translations with Drupal

Updates (imports) available translations.
Update translations with Drupal
              

                

                  

              

              
/**
* Updates the translations installed on the system.
*/
drush locale:update;

View core documentation

Displays detailed documentation on a particular topic.
View core documentation
              

                

                  

              

              
/**
* Displays documentation on a specific Drush topic.
*/
drush core:topic;