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

Table of Contents generated with DocToc

Drupal Console

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

The Drupal Console is a CLI tool to generate boilerplate code, interact and debug Drupal 8.

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 \

Fix download the latest version

Drupal 8 include some outdated libraries of Symfony 2.7.x, as result you get an old release of Drupal Console.

To fix that, execute the following command and you will get the latest release of Drupal Console.

composer update drupal/console --with-dependencies

Download using DrupalComposer

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

Install Drupal Console Launcher

# Run this in your terminal to get the latest version:
curl -L -o drupal.phar

# Or if you don't have curl:
php -r "readfile('');" > drupal.phar

# Accessing from anywhere on your system:
mv drupal.phar /usr/local/bin/drupal

# Apply executable permissions on the downloaded file:
chmod +x /usr/local/bin/drupal

# Copy configuration files.
drupal init --override

# Check and validate system requirements
drupal check

Run Drupal Console

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

Using default Drupal + DrupalConsole


Using DrupalComposer Change directory web, docroot or any other.


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.