stow/oh-my-zsh/.oh-my-zsh/plugins/drush/README.md

   1 # Drush
   2
   3 This plugin adds aliases and functions for [Drush](https://www.drush.org), a command-line shell
   4 and Unix scripting interface for Drupal. It also adds completion for the `drush` command.
   5
   6 To enable it, add `drush` to the plugins array in zshrc file:
   7
   8 ```zsh
   9 plugins=(... drush)
  10 ```
  11
  12 ## Aliases
  13
  14 | Alias   | Command                                                     | Description                                                          |
  15 | ------- | ----------------------------------------------------------- | -------------------------------------------------------------------- |
  16 | `dr`    | `drush`                                                     | Display drush help                                                   |
  17 | `drca`  | `drush cc all`                                              | _(Deprecated in Drush 8)_ Clear all drupal caches                    |
  18 | `drcb`  | `drush cc block`                                            | _(Deprecated in Drush 8)_ Clear block cache                          |
  19 | `drcex` | `drush config:export -y`                                    | Export Drupal configuration to a directory                           |
  20 | `drcg`  | `drush cc registry`                                         | _(Deprecated in Drush 8)_ Clear registry cache                       |
  21 | `drcim` | `drush config:import -y`                                    | Import config from a config directory                                |
  22 | `drcj`  | `drush cc css-js`                                           | Clear css-js cache                                                   |
  23 | `drcm`  | `drush cc menu`                                             | Clear menu cache                                                     |
  24 | `drcml` | `drush cc module-list`                                      | Clear module-list cache                                              |
  25 | `drcr`  | `drush core-cron`                                           | Run all cron hooks in all active modules for specified site          |
  26 | `drct`  | `drush cc theme-registry`                                   | Clear theme-registry cache                                           |
  27 | `drcv`  | `drush cc views`                                            | Clear views cache _(make sure that the views module is enabled)_     |
  28 | `drdmp` | `drush drush sql-dump --ordered-dump --result-file=dumpsql` | Backup database in a new dump.sql file                               |
  29 | `drf`   | `drush features`                                            | Display features status                                              |
  30 | `drfr`  | `drush features-revert -y`                                  | Revert a feature module on your site                                 |
  31 | `drfra` | `drush features-revert-all`                                 | Revert all enabled feature module on your site                       |
  32 | `drfu`  | `drush features-update -y`                                  | Update a feature module on your site                                 |
  33 | `drif`  | `drush image-flush --all`                                   | Flush all derived images                                             |
  34 | `drpm`  | `drush pm-list --type=module`                               | Show a list of available modules                                     |
  35 | `drst`  | `drush core-status`                                         | Provides a birds-eye view of the current Drupal installation, if any |
  36 | `druli` | `drush user:login`                                          | Display a one time login link for user ID 1, or another user         |
  37 | `drup`  | `drush updatedb`                                            | Apply any database updates required (as with running update.php)     |
  38 | `drups` | `drush updatedb-status`                                     | List any pending database updates                                    |
  39 | `drv`   | `drush version`                                             | Show drush version                                                   |
  40 | `drvd`  | `drush variable-del`                                        | Delete a variable                                                    |
  41 | `drvg`  | `drush variable-get`                                        | Get a list of some or all site variables and values                  |
  42 | `drvs`  | `drush variable-set`                                        | Set a variable                                                       |
  43 | `drws`  | `drush watchdog:show`                                       | Show watchdog messages                                               |
  44 | `drwse` | `drush watchdog:show --extended`                            | Show watchdog messages with extended information                     |
  45 | `drwst` | `drush watchdog:tail`                                       | Tail watchdog messages                                              |
  46
  47 ## Functions
  48
  49 - `dren`: download and enable one or more extensions (modules or themes). Must be
  50   invoked with one or more parameters, e.g.: `dren devel` or `dren devel module_filter views`.
  51
  52 - `drf`: edit drushrc, site alias, and Drupal settings.php files.
  53   Can be invoked with one or without parameters, e.g.: `drf 1`.
  54
  55 - `dris`: disable one or more extensions (modules or themes). Must be invoked with
  56   one or more parameters, e.g.: `dris devel` or `dris devel module_filter views`.
  57
  58 - `drpu`: uninstall one or more modules. Must be invoked with one or more
  59   parameters, e.g.: `drpu devel` or `drpu devel module_filter views`.
  60
  61 - `drnew`: creates a brand new drupal website. Note: as soon as the installation
  62   is complete, `drush` will print a username and a random password into the terminal:
  63
  64   ```text
  65   Installation complete.  User name: admin  User password: cf7t8yqNEm
  66   ```