1 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
2 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3 **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
5 - [Drupal Console](#drupal-console)
6 - [Required PHP version](#required-php-version)
7 - [Drupal Console documentation](#documentation)
8 - [Download Drupal Console](#download)
9 - [Run Drupal Console](#run)
10 - [Contributors](#contributors)
11 - [Supporting organizations](#supporting-organizations)
13 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
16 =============================================
18 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/hechoendrupal/DrupalConsole)
19 [![Build Status](https://travis-ci.org/hechoendrupal/DrupalConsole.svg?branch=master)](https://travis-ci.org/hechoendrupal/DrupalConsole)
20 [![Latest Stable Version](https://poser.pugx.org/drupal/console/v/stable.svg)](https://packagist.org/packages/drupal/console)
21 [![Latest Unstable Version](https://poser.pugx.org/drupal/console/v/unstable.svg)](https://packagist.org/packages/drupal/console)
22 [![Software License](https://img.shields.io/badge/license-GPL%202.0+-blue.svg)](https://packagist.org/packages/drupal/console)
23 [![SensioLabsInsight](https://insight.sensiolabs.com/projects/d0f089ff-a6e9-4ba4-b353-cb68173c7d90/mini.png)](https://insight.sensiolabs.com/projects/d0f089ff-a6e9-4ba4-b353-cb68173c7d90)
25 The Drupal CLI. A tool to generate boilerplate code, interact with and debug Drupal.
28 Details of the latest version can be found on the Drupal Console project page under https://drupalconsole.com/.
31 All notable changes to this project will be documented in the [releases page](https://github.com/hechoendrupal/DrupalConsole/releases)
34 The most up-to-date documentation can be found at [http://docs.drupalconsole.com/](http://docs.drupalconsole.com/).
36 More information about using this project at the [official documentation](http://docs.drupalconsole.com/en/using/project.html).
38 ## Required PHP Version
39 PHP 5.5.9 or higher is required to use the Drupal Console application.
43 [Install Drupal Console Using Composer](https://docs.drupalconsole.com/en/getting/composer.html)
45 [Install Drupal Console Launcher](https://docs.drupalconsole.com/en/getting/launcher.html)
47 [Installing Drupal Console on Windows](https://docs.drupalconsole.com/en/getting/windows.html)
50 Using the DrupalConsole Launcher
55 We highly recommend you to install the global executable, but if is not installed, then you can run DrupalConsole by:
60 vendor/drupal/console/bin/drupal
65 ## Drupal Console Support
66 You can ask for support at Drupal Console gitter chat room [http://bit.ly/console-support](http://bit.ly/console-support).
68 ## Getting The Project To Contribute
70 For information about how to run this project for development follow instructions at [setup instructions](https://gist.github.com/jmolivas/97bbd07f328217be3564a434c5bd2618).
72 ## Enabling Autocomplete
74 # You can enable autocomplete by executing
77 # Bash: Bash support depends on the http://bash-completion.alioth.debian.org/
78 # project which can be installed with your package manager of choice. Then add
79 # this line to your shell configuration file.
80 source "$HOME/.console/console.rc" 2>/dev/null
82 # Zsh: Add this line to your shell configuration file.
83 source "$HOME/.console/console.rc" 2>/dev/null
85 # Fish: Create a symbolic link
86 ln -s ~/.console/drupal.fish ~/.config/fish/completions/drupal.fish
91 [Full list of contributors](https://drupalconsole.com/contributors)
93 ## Supporting Organizations
95 [![weKnow](https://www.drupal.org/files/weKnow-logo_5.png)](http://weknowinc.com)
97 [![Anexus](https://www.drupal.org/files/anexus-logo.png)](http://www.anexusit.com/)
99 [All supporting organizations](https://drupalconsole.com/supporting-organizations)
101 > Drupal is a registered trademark of Dries Buytaert.