Skip to content

Commit

Permalink
Copy relevant info from drupal.org/project/drush
Browse files Browse the repository at this point in the history
  • Loading branch information
weitzman committed Aug 18, 2013
1 parent 874f310 commit 7deb8f6
Showing 1 changed file with 47 additions and 10 deletions.
57 changes: 47 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,63 @@
DESCRIPTION
===========
-----------

Drush is a command line shell and Unix scripting interface for Drupal. If you are unfamiliar with shell scripting, reviewing the documentation for your shell (e.g. man bash) or reading an online tutorial (e.g. search for "bash tutorial") will help you get the most out of Drush.

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.

To contribute to Drush, see [/CONTRIBUTING.md](CONTRIBUTING.md)

Code Status
-----------
Drush comes with a full test suite 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):

* <a href="https://travis-ci.org/drush-ops/drush">8.x-6.x</a>: <img src="https://travis-ci.org/drush-ops/drush.png?branch=8.x-6.x">
* <a href="https://travis-ci.org/drush-ops/drush">7.x-5.x</a>: <img src="https://travis-ci.org/drush-ops/drush.png?branch=7.x-5.x">

Misc
-----------
* [www.drush.org](http://www.drush.org)
* [A list of modules that include Drush integration](http://drupal.org/project/modules?filters=tid%3A4654)
* For more help, please see the [Resources](http://drush.org/resources) and the [Drush FAQ](http://drupal.org/drush-faq). Run the `drush topic` command for even more help.
* If you are using Debian or Ubuntu, you can alternatively use the Debian packages uploaded in your distribution. You may need to use the backports to get the latest version, if you are running a LTS or "stable" release.
* For advice on using Drush with your ISP, see the <a href="http://drush.org/resources#hosting">hosting section of the Resources page</a> on <a href="http://drush.org">drush.org</a>.

REQUIREMENTS
============
-----------

* To use Drush, you'll need a command line PHP version 5.3+.
* Drush commands that work with git require git 1.7 or greater.
* Drush works best on a Unix-like OS (Linux, OS X)
* Most Drush commands run on Windows. See INSTALLING DRUSH ON WINDOWS, below.
* Drush 6 works with Drupal 6 or Drupal 7.

INSTALLATION
============
INSTALL - PEAR
-----------
If you have trouble with PEAR installation, consider trying MANUAL INSTALLATION. It is not too hard.

```bash
pear channel-discover pear.drush.org
pear install drush/drush
```

A common way to install Drush is via our PEAR channel. See instructions at http://drupal.org/project/drush. If you prefer a (slightly) more manual install, see below.
_Tip: Use sudo to overcome permission problems. If the channel-discover fails, try running the following sequence of commands:_

```bash
pear upgrade --force Console_Getopt
pear upgrade --force pear
pear upgrade-all
```

To update, run `pear upgrade drush/drush`

To get alternate drush versions, replace that last line with one of the below that matches your fancy.

```bash
pear install drush/drush-5.0.0
pear install drush/drush-6.0.0RC4
```

INSTALL - MANUAL
-----------
1. Place the uncompressed drush.tar.gz, drush.zip, or cloned git repository in a directory that is outside of your web root.
1. Make the 'drush' command executable:

Expand Down Expand Up @@ -222,7 +259,7 @@ setting values for 'remote-host' and 'os', as these are very important when
running Drush rsync and Drush sql-sync commands.

USAGE
=====
-----------

Once you have completed the installation steps, Drush can be run in your shell
by typing "drush" from within any Drupal root directory.
Expand Down Expand Up @@ -270,7 +307,7 @@ just restart automatically using bash. For example:
DRUSH CONFIGURATION FILES
=========================
-----------
Inside the [examples](examples) directory you will find some example files to help you get
started with your Drush configuration file (example.drushrc.php), site alias
Expand Down Expand Up @@ -327,7 +364,7 @@ In any case, it is important that you end the filename with ".drush.inc", so tha
FAQ
===
------
```
Q: What does "drush" stand for?
Expand All @@ -344,7 +381,7 @@ FAQ
```
CREDITS
=======
-----------
* Originally developed by [Arto Bendiken](http://bendiken.net) for Drupal 4.7.
* Redesigned by [Franz Heinzmann](http://unbiskant.org) in May 2007 for Drupal 5.
Expand Down

0 comments on commit 7deb8f6

Please sign in to comment.