yaffs.net Git - yaffs-website/blob - vendor/drush/drush/docs/usage.md

   1 Usage
   2 -----------
   3
   4 Drush can be run in your shell by typing "drush" from within your project root directory or anywhere within Drupal.
   5
   6     $ drush [options] <command> [argument1] [argument2]
   7
   8 Use the 'help' command to get a list of available options and commands:
   9
  10     $ drush help
  11
  12 For even more documentation, use the 'topic' command:
  13
  14     $ drush topic
  15
  16 Using the --uri option and --root options.
  17 -----------
  18
  19 For multi-site installations, use a site alias or the --uri option to target a particular site.
  20
  21     $ drush --uri=http://example.com pm:enable
  22
  23 If you are outside the Composer project and not using a site alias, you need to specify --root and --uri for Drush to locate and bootstrap the right Drupal site.
  24
  25 Site Aliases
  26 ------------
  27
  28 Drush lets you run commands on a remote server. Once defined, aliases can be referenced with the @ nomenclature, i.e.
  29
  30 ```bash
  31 # Run pending updates on staging site.
  32 $ drush @staging updatedb
  33 # Synchronize staging files to production
  34 $ drush rsync @staging:%files/ @live:%files
  35 # Synchronize database from production to local, excluding the cache table
  36 $ drush sql:sync --structure-tables-key=custom @live @self
  37 ```
  38
  39 See [example.site.yml](https://raw.githubusercontent.com/drush-ops/drush/master/examples/example.site.yml) for more information.
  40