141 lines (106 sloc) 4.88 KB

Table of Contents generated with DocToc

Drupal Console

Gitter Build Status Latest Stable Version Latest Unstable Version Software License SensioLabsInsight

The Drupal CLI. A tool to generate boilerplate code, interact with and debug Drupal.

Latest Version

Details of the latest version can be found on the Drupal Console project page under

Releases Page

All notable changes to this project will be documented in the releases page


The most up-to-date documentation can be found at

More information about using this project at the official documentation.

Required PHP Version

PHP 5.5.9 or higher is required to use the Drupal Console application.

Download as new dependency

# Change directory to Drupal site
cd /path/to/

# Download DrupalConsole
composer require drupal/console:~1.0 \
--prefer-dist \
--optimize-autoloader \

Download using DrupalComposer

composer create-project \
drupal-composer/drupal-project:8.x-dev \ \
--prefer-dist \
--no-progress \

Update DrupalConsole

composer update drupal/console --with-dependencies

Install Drupal Console Launcher

curl -L -o drupal.phar
mv drupal.phar /usr/local/bin/drupal
chmod +x /usr/local/bin/drupal

NOTE: If you don't have curl you can try

php -r "readfile('');" > drupal.phar

Update DrupalConsole Launcher 

drupal self-update

NOTE: drupal is the alias name you used when installed the DrupalConsole Launcher.

Run Drupal Console

Using the DrupalConsole Launcher


We highly recommend you to install the global executable, but if is not installed, then you can run DrupalConsole by:

# or
# or

Drupal Console Support

You can ask for support at Drupal Console gitter chat room

Getting The Project To Contribute

For information about how to run this project for development follow instructions at setup instructions.

Enabling Autocomplete

# You can enable autocomplete by executing
drupal init

# Bash: Bash support depends on the
# project which can be installed with your package manager of choice. Then add
# this line to your shell configuration file.
source "$HOME/.console/console.rc" 2>/dev/null

# Zsh: Add this line to your shell configuration file.
source "$HOME/.console/console.rc" 2>/dev/null

# Fish: Create a symbolic link
ln -s ~/.console/ ~/.config/fish/completions/

Supporting Organizations





Drupal is a registered trademark of Dries Buytaert.