www.aleph1.co.uk Git - yaffs-website/blob - vendor/drush/drush/README.md

   1 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. Developers love the `generate` command, which jump starts your coding project by writing ready-to-customize PHP and YML files. Drush can be extended by [3rd party commandfiles](https://www.drupal.org/project/project_module?f[2]=im_vid_3%3A4654).
   2
   3 [![Latest Stable Version](https://poser.pugx.org/drush/drush/v/stable.png)](https://packagist.org/packages/drush/drush) [![Total Downloads](https://poser.pugx.org/drush/drush/downloads.png)](https://packagist.org/packages/drush/drush) [![Latest Unstable Version](https://poser.pugx.org/drush/drush/v/unstable.png)](https://packagist.org/packages/drush/drush) [![License](https://poser.pugx.org/drush/drush/license.png)](https://packagist.org/packages/drush/drush) [![Documentation Status](https://readthedocs.org/projects/drush/badge/?version=master)](https://readthedocs.org/projects/drush/?badge=master)
   4
   5 | Code style | Isolation Tests | Functional Tests |
   6 | :--------: | :-------------: | :--------------: |
   7 | <img src="https://api.shippable.com/projects/5507addd5ab6cc1352a213b5/badge?branch=master"> | <img src="https://travis-ci.org/drush-ops/drush.svg?branch=master"> | <img src="https://circleci.com/gh/drush-ops/drush.svg?style=shield"> |
   8
   9 Resources
  10 -----------
  11 * [Installing (and Upgrading)](http://docs.drush.org/en/master/install/)
  12 * [General Documentation](http://docs.drush.org)
  13 * [API Documentation](http://www.drush.org/api/master/index.html)
  14 * [Drush Commands](http://drushcommands.com)
  15 * Subscribe [this atom feed](https://github.com/drush-ops/drush/releases.atom) to receive notification of new releases. Also, [Version eye](https://www.versioneye.com/).
  16 * [Drush packages available via Composer](https://packagist.org/search/?type=drupal-drush)
  17 * [A list of modules that include Drush integration](https://www.drupal.org/project/project_module?f[2]=im_vid_3%3A4654&solrsort=ds_project_latest_release+desc)
  18 * Drush comes with a [full test suite](https://github.com/drush-ops/drush/blob/master/tests/README.md) powered by [PHPUnit](https://github.com/sebastianbergmann/phpunit). Each commit gets tested by the awesome [Travis CI continuous integration service](https://travis-ci.org/drush-ops/drush).
  19
  20 Support
  21 -----------
  22 * Post support requests to [Drupal Answers](http://drupal.stackexchange.com/questions/tagged/drush). Tag question with 'drush'.
  23 * Report bugs and request features in the [GitHub Drush Issue Queue](https://github.com/drush-ops/drush/issues).
  24 * Use pull requests (PRs) to contribute to Drush.
  25
  26 Code of Conduct
  27 ---------------
  28 The Drush project expects all participants to abide by the [Drupal Code of Conduct](https://www.drupal.org/dcoc).
  29
  30 FAQ
  31 ------
  32
  33 >  Q: What does "Drush" stand for?<br>
  34 >  A: The Drupal Shell.
  35 >
  36 >  Q: How do I pronounce Drush?<br>
  37 >  A: Some people pronounce the *dru* with a long 'u' like Dr*u*pal. Fidelity points
  38 >     go to them, but they are in the minority. Most pronounce Drush so that it
  39 >     rhymes with hush, rush, flush, etc. This is the preferred pronunciation.
  40 >
  41 >  Q: Does Drush have unit tests?<br>
  42 >  A: Drush has an excellent suite of unit tests. See
  43 > [tests/README.md](https://github.com/drush-ops/drush/blob/master/tests/README.md) for more information.
  44
  45
  46 Credits
  47 -----------
  48
  49 * Originally developed by [Arto Bendiken](http://bendiken.net) for Drupal 4.7.
  50 * Redesigned by [Franz Heinzmann](http://unbiskant.org) in May 2007 for Drupal 5.
  51 * Maintained by [Moshe Weitzman](http://drupal.org/moshe) with much help from
  52   the folks listed at https://github.com/orgs/drush-ops/people.
  53 * Thanks to [JetBrains](https://www.jetbrains.com) for [supporting this project and open source software](https://www.jetbrains.com/buy/opensource/).
  54
  55 ![Drush Logo](drush_logo-black.png)
  56 [![PhpStorm Logo](misc/icon_PhpStorm.png)](https://www.jetbrains.com/phpstorm/)