drupal/console

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

1.0.0-beta3 2016-06-29 06:04 UTC

README

Table of Contents generated with DocToc

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 https://drupalconsole.com/.

Releases Page

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

Documentation

The most up-to-date documentation can be found at http://docs.drupalconsole.com/.

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.

Supported Drupal Version

The Drupal 8 supported version is Drupal 8.0.x.

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

# Copy configuration files.
drupal init --override

# Check and validate system requirements
drupal check

Running Drupal Console

# Download, install and serve Drupal 8:
drupal chain --file=~/.console/chain/quick-start.yml

# Create a new Drupal 8 project:
drupal site:new drupal8.dev --latest

# Lists all available commands:
drupal list

# Update to the latest version.
drupal self-update

Drupal Console Support

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

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

Running the project

After using Composer to download dependencies, you can run the project by executing:

$ bin/drupal

Create a symbolic link

You can run this command to easily access the Drupal Console from anywhere on your system:

$ sudo ln -s /path/to/DrupalConsole/bin/drupal /usr/local/bin/drupal

NOTE: The name drupal is just an alias you can name it anything you like.

More information about how to contribute with this project at the official documentation.

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

Supporting Organizations

FFW

Anexus

Indava

Drupal is a registered trademark of Dries Buytaert.