Drupal Console

The Drupal Console is a suite of tools that you run on a command line interface (CLI) to generate boilerplate code and interact with a Drupal 8 installation.

Change Log

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

Supported Drupal version

The Drupal 8 supported version is Drupal 8.0.0.

Drupal Console documentation

You can read or download the Drupal Console documentation at bit.ly/console-book.

Drupal Console support

You can ask for support at Drupal Console gitter chat room http://bit.ly/console-support.

Installing Drupal Console

# Run this in your terminal to get the latest Console version:
curl https://drupalconsole.com/installer -L -o drupal.phar

# Or if you don't have curl:
php -r "readfile('https://drupalconsole.com/installer');" > 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

# Show all available commands.
drupal list

# Copy configuration files.
drupal init [--override]

# Generate a module.
drupal generate:module

Getting the project to contribute

Fork

Fork your own copy of the Console repository to your account

Clone

Get a copy of your recently cloned version of console in your machine.

$ git clone git@github.com:[your-git-user-here]/DrupalConsole.git

Install dependencies

Now that you have cloned the project, you need to download dependencies via Composer.

$ cd /path/to/DrupalConsole
$ composer install

Enabling Autocomplete

# You can enable autocomplete by executing
drupal init

# Bash: Bash support depends on the http://bash-completion.alioth.debian.org/
# 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/drupal.fish ~/.config/fish/completions/drupal.fish

vielsoft/DrupalConsole