Drupal

Console

Table of Contents
Drupal Console Documentation 0
What is the Drupal Console 1
Why should you care about? 1.1
How does Drupal Console help? 1.2
Where do I find the project? 1.3
Getting the project 2
Using the Installer 2.1
Using Composer 2.2
Download phar file 2.3
Update project 2.4
Using the project 3
How to copy configuration files 3.1
How to download, install and serve Drupal 8 3.2
How to use Drupal Console in a multi-site installation 3.3
How to use Drupal Console in a remote installation 3.4
Creating custom Commands 4
Registering Commands Automatically 4.1
Configuring the Command 4.2
Command Lifecycle 4.3
Getting Services from the Service Container 4.4
Contributing new features 5
Project requirements 5.1
Getting the project 5.2
Running the project 5.3
Keeping your fork up to date 5.4
Creating issues and pull requests 5.5
Contribute to this documentation 5.6
Available commands 6
about 6.1
chain 6.2

2
Drupal Console

help 6.3
settings:init 6.4
list 6.5
server 6.6
cache:rebuild 6.7
chain:debug 6.8
config:debug 6.9
config:diff 6.10
config:edit 6.11
config:export 6.12
config:export:content:type 6.13
config:export:single 6.14
config:export:view 6.15
config:import 6.16
config:import:single 6.17
config:override 6.18
config:settings:debug 6.19
container:debug 6.20
create:nodes 6.21
create:terms 6.22
create:users 6.23
create:vocabularies 6.24
cron:debug 6.25
cron:execute 6.26
cron:release 6.27
database:client 6.28
database:connect 6.29
database:dump 6.30
database:log:clear 6.31
database:log:debug 6.32
database:restore 6.33
database:table:debug 6.34
database:table:drop 6.35
generate:authentication:provider 6.36

3
Drupal Console

generate:command 6.37
generate:controller 6.38
generate:doc:dash 6.39
generate:doc:gitbook 6.40
generate:entity:bundle 6.41
generate:entity:config 6.42
generate:entity:content 6.43
generate:event:subscriber 6.44
generate:form 6.45
generate:form:alter 6.46
generate:form:config 6.47
generate:module 6.48
generate:permissions 6.49
generate:plugin:block 6.50
generate:plugin:condition 6.51
generate:plugin:field 6.52
generate:plugin:fieldformatter 6.53
generate:plugin:fieldtype 6.54
generate:plugin:fieldwidget 6.55
generate:plugin:imageeffect 6.56
generate:plugin:imageformatter 6.57
generate:plugin:rest:resource 6.58
generate:plugin:rulesaction 6.59
generate:plugin:type:annotation 6.60
generate:plugin:type:yaml 6.61
generate:plugin:views:field 6.62
generate:profile 6.63
generate:routesubscriber 6.64
generate:service 6.65
generate:theme 6.66
locale:language:add 6.67
locale:language:delete 6.68
locale:translation:status 6.69

4
Drupal Console

migrate:debug 6.70
migrate:execute 6.71
migrate:setup 6.72
module:debug 6.73
module:download 6.74
module:install 6.75
module:uninstall 6.76
multisite:debug 6.77
rest:debug 6.78
rest:disable 6.79
rest:enable 6.80
router:debug 6.81
router:rebuild 6.82
settings:check 6.83
settings:debug 6.84
settings:set 6.85
site:debug 6.86
site:install 6.87
site:maintenance 6.88
site:mode 6.89
site:new 6.90
site:statistics 6.91
site:status 6.92
state:debug 6.93
state:override 6.94
test:debug 6.95
test:run 6.96
theme:debug 6.97
theme:download 6.98
theme:install 6.99
theme:uninstall 6.100
translation:cleanup 6.101
translation:pending 6.102
translation:stats 6.103

5
Drupal Console

translation:sync 6.104
update:debug 6.105
update:execute 6.106
user:debug 6.107
user:delete 6.108
user:login:clear:attempts 6.109
user:login:url 6.110
user:password:hash 6.111
user:password:reset 6.112
views:debug 6.113
views:disable 6.114
views:enable 6.115
yaml:diff 6.116
yaml:merge 6.117
yaml:split 6.118
yaml:update:key 6.119
yaml:update:value 6.120
FAQ (Frequently Asked Questions) about Drupal Console 7
Installation problems 7.1
Permissions 7.2
Commands not listed 7.3
Interactive Mode 7.4
References 8

6
Drupal Console

Drupal Console Documentation

Note: This project is a work-in-progress.

This book documents the Drupal Console project.

Contribute to the project

You can contribute to improve this project on Github

Contribute to this documentation

You can contribute to improve this documentation on GitHub.

Supporting organizations

Drupal Console Documentation 7

Drupal Console

What is the Drupal Console?

The Drupal Console is a suite of tools run from a command line interface (CLI) to generate
boilerplate code and interact with a Drupal 8 installation. From the ground up, it has been
built to utilize the same modern PHP practices which were introduced in Drupal 8.

The Drupal Console makes use of the Symfony Console and other third party components
which allows you to automatically generate most of the code needed for a Drupal 8 module.
In addition, Drupal Console helps you interact with your Drupal installation.

What is the Drupal Console 8

Drupal Console

Why should you care about it

Drupal 8 is more technically advanced compared to its predecessor and managing the
increasing complexity of Drupal 8 could be a daunting task for anyone. Drupal Console is a
suite of tools to help manage that complexity. Writing a Drupal 8 module now involves a lot
more boilerplate code and there is a lot you need to know and do just to get started building
a new module. These tasks can be repetitive and tedious, and can therefore create
increased potential for errors. Fortunately, a lot of the new code can be automatically
generated, using Drupal Console, without risk of copy/paste errors and with a lot of saved
time.

Benefits of the Drupal Console:

Takes advantage of the Symfony Console and other third-party components to generate
PHP, YML, and other files.
Takes advantage of other modern development practices.
Saves development time, both during migration of existing Drupal modules and when
writing new ones.
Provides easy-to-learn tools that make Drupal 8 development, by extension, also easier
to learn.
Reduces development time for remaining Drupal 8 tasks and for development of new
modules.

Follow along in this documentation as we explore the power of this exciting new set of tools.

Why should you care about? 9

Drupal Console

How does Drupal Console help?

Generating the code and files required by a

Drupal 8 module
Drupal Console provides a number of commands for creating module scaffolding and
boilerplate code. For any command, you will be asked a series of questions about what you
want to generate. Based on that user interaction, it will then generate the required boilerplate
to build the requested component.

Interacting with your Drupal installation.

Drupal Console allows you to interact with your Drupal installation, from rebuilding caches,
to listing routes, services, and modules, and interacting with the configuration management.

Learning Drupal 8
Drupal Console helps you learn Drupal 8. In addition to generating complex code, you can
increase the verbosity of the code comments, to better understand the generated code and
how to build on it, by using the --learning option.

How does Drupal Console help? 10

Drupal Console

Where do I find the project?

Project landing page

http://drupalconsole.com

Github repository
https://github.com/hechoendrupal/DrupalConsole

Documentation
http://hechoendrupal.gitbooks.io/drupal-console

Support chat
https://gitter.im/hechoendrupal/DrupalConsole

More information on Drupal.org project page

https://drupal.org/project/console

Where do I find the project? 11

Drupal Console

Getting the project

There are different ways to get the project on your local machine.

Our recommendation for getting the project on your local machine is by using the installer.

Getting the project 12

Drupal Console

Using the Drupal Console Installer

You can install the Drupal Console locally by running the installer in your project directory,
the installer will take care of downloading the necesary files to run drupal console on you
computer.

Using curl:
$ 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

You can now execute using:

$ php drupal.phar

You can place this file anywhere you wish. If you put it in your PATH, you can access it
globally. On unixy systems you can even make it executable and invoke it without php.

Access 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

You can now execute using:

Using the Installer 13

Drupal Console

$ drupal

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

Using the Installer 14

Drupal Console

Install Drupal Console Using Composer

You can install this project using composer.

Install Drupal Console globally using

composer:
$ composer global require drupal/console:@stable

Add the binary directory to your class path:

$ echo "PATH=$PATH:~/.composer/vendor/bin" >> ~/.bash_profile

You can now execute console using:

$ drupal generate:module

Using Composer 15
Drupal Console

Download phar file

You can download the latest version of Console from the repository releases page at:

https://github.com/hechoendrupal/DrupalConsole

Make sure you download the console.phar file from the most current release.

Download phar file 16

Drupal Console

Update project
Drupal 8 is under heavy development, to keep in sync with the latest changes. The easiest
and recommended way of updating Drupal Console is using the self-update command.

Depending on the installation method:

Installed globally (and renamed to "drupal"):

$ drupal self-update

Installed globally (using composer):

$ composer global update drupal/console:@stable

Installed locally (running from directory where the

console.phar has been downloaded):

$ php console.phar self-update

Update project 17
Drupal Console

Using the project

Drupal Console provides two types of commands, stand alone and container aware
commands.

Stand alone commands: These commands can run outside of a Drupal 8 site root.

Container aware commands: These commands must be run within a Drupal 8 site root.

Executing Drupal Console outside a Drupal site root

You can run Drupal Console form any directory on your system by using the --root option
to define the Drupal root to be use in the command execution.

$ drupal --root=/var/www/drupal8.dev cr all

NOTE: Possible messages when executing Drupal Console outside a Drupal site root and
no --root option provided.

When running the project outside of a Drupal 8 site root, the following message will be
shown.

In order to list all of the available commands, you should run this inside a drupal root
directory.

When running the project within of a Drupal 8 site root, but site is not yet installed, the
following message will be shown.

In order to list all of the available commands you should install drupal first.

Using the project 18

Drupal Console

How to copy configuration files

The first task you should do after installing Drupal Console is to execute the init
command. Executing this command will copy the project configurations files to your
~/.console/ directory. Overriding values on these copied files is how you can change

DrupalConsole behaviour.

$ drupal init [--override]

Which files are copied when executing the init

command.

~/.console/
├── aliases.yml
├── chain
│ ├── quick-start.yml
│ └── sample.yml
├── config.yml
├── console.rc
├── drupal.fish
└── sites
└── sample.yml

How to copy configuration files 19

Drupal Console

How to download, install and serve Drupal

8
The easiest way to try Drupal 8 in your local machine is by executing the chain command
and pass the option --file=~/.console/chain/quick-start.yml as shown on the following
example.

$ drupal chain --file=~/.console/chain/quick-start.yml

NOTE: You must execute drupal init before in order to copy the
~/.console/chain/quick-start.yml on your system.

The chain command helps you to automate command execution, allowing you to define an
external YAML file containing the definition name, option and arguments of several
commands and execute that list based on the sequence defined in the file.

The content of the provided ~/.console/chain/quick-start.yml file is:

commands:
- command: site:new
arguments:
directory: drupal8.dev
version: 8.0.2
- command: site:install
options:
langcode: en
db-type: sqlite
db-file: sites/default/files/.ht.sqlite
site-name: 'Drupal 8 Quick Start'
site-mail: [email protected]
account-name: admin
account-mail: [email protected]
account-pass: admin
generate-inline: true
arguments:
profile: standard
- command: server

The previous configuration will execute several commands, in this case commands that will
download and install Drupal using SQLite, and finally start the PHP's built in server, now you
only need to open your browser and point it to 127.0.0.1:8088.

How to download, install and serve Drupal 8 20

Drupal Console

You can duplicate or make changes on the provided YAML file, to add commands for
download modules module:download , install modules module:install , import
configurations config:import and restore your database database:restore or any other
command provided by DrupalConsole or a custom command by your own module.

How to download, install and serve Drupal 8 21

Drupal Console

How to use Drupal Console in a multi-site

installation
Drupal Console provides support for Drupal multi-site installations. This project provides the
multisite:debug command to debug multi-site installations and the --uri option to interact

with multi-site installations.

How to list all known multi sites

$ drupal multisite:debug

+---------------------+--------------------------------+
| Site | Directory |
+---------------------+--------------------------------+
| drupal8.dev | /var/www/drupal8.dev/default |
| drupal8.multi.dev | /var/www/drupal8.dev/multi.dev |
+---------------------+--------------------------------+

Sites are written using the format: <port>.<domain>.<path>

How to execute a command against a multi-site installation

$ drupal --uri=http://drupal8.multi.dev cr all

How to use Drupal Console in a multi-site installation 22

Drupal Console

How to use Drupal Console in a remote

site installation
Drupal Console allows you to run commands on your local server but actually execute them
on a remote server.

You can take advantage of this feature, using the --target option and passing the remote
site name you want to interact with.

$ drupal --target=sample.dev cr all

Setting up your local computer to use a remote site requires a little configuration.

Edit global configuration

You can provide global configuration to remote connections at the copied file
~/.console/config.yml . This information is grouped within the remote key.

application:
...
remote:
user: root
port: 22
console: /usr/local/bin/drupal
options:
arguments:
keys:
public: ~/.ssh/id_rsa.pub
private: ~/.ssh/id_rsa
passphrase: ~/.ssh/passphrase.txt

Edit specific site configuration

You can provide specific site configuration by duplicating the copied site file at
~/.console/sites/sample.yml with a new same at ~/.console/sites/ .

How to use Drupal Console in a remote installation 23

Drupal Console

local:
root: /var/www/drupal8.dev
host: local
dev:
root: /var/www/html/drupal
host: 140.211.10.62
user: drupal
prod:
root: /var/www/html/docroot
host: live.drupal.org
user: drupal
console: /var/www/html/docroot/console.phar

Debug sites.
You can list all known local and remote sites by executing the site:debug command.

$ drupal site:debug

+--------------------+-----------------+------------------------+
| Site | Host | Root |
+--------------------+-----------------+------------------------+
| sample.local | local | /var/www/drupal8.dev |
| sample.dev | 140.211.10.62 | /var/www/html/drupal |
| sample.prod | live.drupal.org | /var/www/html/docroot |
+--------------------+-----------------+------------------------+

You can show the site configuration details by passing the site name as argument to the
site:debug command.

$ drupal site:debug sample.dev

user: drupal
port: 22
console: /usr/local/bin/drupal
options:
arguments:
keys:
public: ~/.ssh/id_rsa.pub
private: ~/.ssh/id_rsa
passphrase: ~/.ssh/passphrase.txt
root: /var/www/html/drupal
host: 140.211.10.62
remote: true

How to use Drupal Console in a remote installation 24

Drupal Console

NOTE: As you may notice the global configuration and the specific site configuration are
merged when debugging a site. You can override any global configuration by adding those
keys on the site specific configuration.

How to use Drupal Console in a remote installation 25

Drupal Console

Creating Custom Commands

The simple way to create a custom Command Class is to execute the generate:command
command.

Executing the command using the interactive command questions:

$ drupal generate:command

// Welcome to the Drupal Command generator

Enter the module name [devel]:
> example

Enter the Command name. [example:default]:

>

Enter the Command Class. (Must end with the word 'Command'). [DefaultCommand]:
>

Is the command aware of the drupal site installation when executed?. (yes/no) [yes]:
>

Do you confirm generation? (yes/no) [yes]:

>

Generated or updated files

Site path: /var/www/drupal.dev
1 - modules/custom/example/src/Command/DefaultCommand.php

Executing the generate:command passing inline options, make sure you adjust the following
command based on your requirements.

$ drupal generate:command --module=example --class=DefaultCommand --name=example:default --container

This command execution will generate a new Command class containing the boiler-plate
required to register a new command within your Drupal module.

Creating custom Commands 26

Drupal Console

Registering Commands Automatically

To make the console commands available automatically within a Drupal installation, you will
need to:

Create a Command directory inside your module i.e. src/Command and create a PHP file
suffixed with Command.php i.e. MyCustomCommand.php for each command that you want to
provide.

Make sure you class extends one of Command or ContainerAwareCommand classes.

Drupal Console provides two types of commands, stand alone and container aware
commands.

Stand alone commands

These commands are listed and can run outside of a Drupal installation, you defined one by
extending the Command class.

use Drupal\Console\Command\Command;

class MyStandAloneCommand extends Command

{
}

Container aware commands

These commands are listed and must be run against a Drupal, you defined one by extending
the ContainerAwareCommand class.

use Drupal\Console\Command\ContainerAwareCommand;

class MyContainerAwareCommand extends ContainerAwareCommand

{
}

Registering Commands Automatically 27

Drupal Console

Configuring the command.

You must provide a configure method containing the configuration of the command as
name, arguments, options, etc.

/**
* {@inheritdoc}
*/
protected function configure()
{
$this
->setName('user:login:url')
->setDescription($this->trans('commands.user.login.url.description'))
->addArgument(
'uid',
InputArgument::REQUIRED,
$this->trans('commands.user.login.url.options.uid'),
null
);
}

Configuring the Command 28

Drupal Console

Command Lifecycle
Commands have three lifecycle methods:

The initialize method (optional)

This method is executed before the interact and execute methods. Its main purpose is to
initialize variables used in the rest of the command methods.

The interact method (optional)

This method is executed after initialize and before execute methods. Its purpose is to
check if some of the options/arguments are missing and interactively ask the user for those
values. This is the last place where you can ask for missing options/arguments. After this
command, missing options/arguments will result in an error.

The execute method (required)

This method is executed after interact and initialize methods. It contains the logic you
want the command to execute.

Command Lifecycle 29
Drupal Console

Getting Services from the Service

Container
By using ContainerAwareCommand as the base class for the command (instead of the more
basic Command ), you have access to the service container. In other words, you have access
to any configured service using the provided getService method.

protected function execute(InputInterface $input, OutputInterface $output)

{
$uid = $input->getArgument('uid');
$entityManager = $this->getService('entity.manager');
if ($entityManager) {
$user = $entityManager->getStorage('user')->load($uid);
}
}

Getting Services from the Service Container 30

Drupal Console

Contributing new features

If you create a new custom command or something else which would be useful for other
Drupal installations, please consider forking the Drupal Console project on GitHub. Then just
create an issue for a "feature request", put your work in a new Git branch on your fork,
publish your branch and add a pull request on GitHub (including your issue ID in the PR
title). The Drupal Console maintainers are very happy to accept useful contributions and
usually do so quite promptly.

Getting support with becoming a contributor

If you want to contribute to Drupal Console and have any difficulty getting oriented to the
process, you can find Instant Messaging support on Gitter IM.

Standard GitHub Workflow

If you haven't yet contributed to a project on GitHub, or are not sure you remember the
workflow, you might first want to read the documentation about pull requests. You may also
wish to download the GitHub application (Mac | Windows, which simplifies the workflow a bit
and provides a nice GUI for your contributions).

Github-flavored Markdown
This documentation is written in “Github-flavored Markdown”, which is rendered on Github,
directly, as HTML. If you are already familiar with Markdown, GFL only adds a few useful
tweaks, otherwise you may want to read Github’s Markdown Basics primer.

Contributing new features 31

Drupal Console

Project requirements

Download Git
We recommend downloading Git from http://git-scm.com/downloads

Download Composer
Run this in your terminal to get the latest Composer version:

curl -sS https://getcomposer.org/installer | php

Or if you don't have curl:

php -r "readfile('https://getcomposer.org/installer');" | php

This installer script will simply check some php.ini settings, warn you if they are set
incorrectly, and then download the latest composer.phar in the current directory

You can run this terminal command to make Composer easily accessible, from anywhere on
your system:

$ mv composer.phar /usr/local/bin/composer

Download Drupal 8
The Drupal Console project only supports Drupal 8; which you will need to download and
install locally.

Download Drupal

$ drupal site:new drupal8.dev 8.0.0

$ cd drupal8.dev

Install Drupal using MySQL:

Project requirements 32
Drupal Console

$ drupal site:install standard --langcode=en --db-type=mysql --db-host=127.0.0.1

--db-name=drupal --db-user=root --db-pass=root --db-port=3306
--site-name="Drupal 8 Site Install" [email protected]
--account-name=admin [email protected] --account-pass=admin -n

Install Drupal using SQLite:

$ drupal site:install standard --langcode=en --db-type=sqlite

--db-file=sites/default/files/.ht.sqlite --site-name="Drupal 8 Site Install"
[email protected] --account-name=admin [email protected]
--account-pass=admin -n

Start the PHP's built in server

$ drupal server

NOTE: Make sure you use your own user and database credentials when running
site:install and never user root on production. In this example code, we accept all

interactive questions, i.e. answering “yes” when passing the -y argument.

Project requirements 33
Drupal Console

Getting the project

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 [email protected]:[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

Getting the project 34

Drupal Console

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.

Running the project 35

Drupal Console

Keeping your fork up to date

After some time your forked repository and the original one (called upstream) will eventually
get out of sync leaving you with an old, unsupported version.

To sync changes you make in a fork with the original repository, you should:

Configuring a remote fork:

Specify and configure a new remote upstream repository that points to the upstream
repository in Git.

git remote add upstream https://github.com/hechoendrupal/DrupalConsole.git

For detailed information please visit Github's guide Configuring a remote fork

Syncing your fork

Sync your fork to keep it up-to-date with the upstream repository.

git fetch upstream

git merge upstream/master

For detailed information please visit Github's guide Syncing a fork

Keeping your fork up to date 36

Drupal Console

Creating an Issue
If you found an issue or maybe you like to propose a new feature to the project, you need to
access the following link:

https://github.com/hechoendrupal/DrupalConsole/issues/new

Please review the guidelines for contributing to Drupal Console at:

https://github.com/hechoendrupal/DrupalConsole/blob/master/CONTRIBUTING.md

Creating a Pull Request

Remember to create a branch before start developing! It's name should contain the issue id
and a slug to tell what the thing you're working on is about, for example: 1337-lorem-ipsum

If you haven't yet contributed to a project on GitHub, or aren't still sure what the workflow
looks like, read the documentation about pull requests. You may also wish to download the
GitHub application (Mac | Windows, which simplifies the workflow a bit and provides a nice
GUI for your contributions).

Creating issues and pull requests 37

Drupal Console

Contribute to this documentation

This documentation is a work-in-progress and you are welcome to pitch in and help. Simply
fork the Drupal Console Book on GitHub. If you haven't yet contributed to a project on
GitHub, or aren't still sure what the workflow looks like, read the documentation about pull
requests. You may also wish to download the GitHub application (Mac | Windows, which
simplifies the workflow a bit and provides a nice GUI for your contributions).

Contribute to this documentation 38

Drupal Console

Available Drupal Console Commands

Note: Drupal Console commands must be run from the root of a Drupal 8 installation.

Drupal Console Command Details

Display basic information about Drupal Console
about
project
chain Chain command execution

help Displays help for a command

settings:init Copy configuration files to user home directory.

list Lists all available commands

server Runs PHP built-in web server
cache
cache:rebuild Rebuild and clear all site caches.
chain
chain:debug List available chain files.
config
config:debug Show the current configuration.

Ouput configuration items that are different in active

config:diff
configuration compared with a directory.
config:edit Edit the selected configuration.
config:export Export current application configuration.

config:export:content:type Export a specific content type and their fields.

config:export:single Export single configuration as yml file.

Export a view in YAML format inside a provided
config:export:view module to reuse in other website.

config:import Import configuration to current application.

config:import:single Import the selected configuration.

config:override Override config value in active configuration.

config:settings:debug Displays current key:value on settings file.

container

container:debug Displays current services for an application.

Available commands 39
Drupal Console

create
create:nodes Create dummy nodes for your Drupal 8 application.

create:terms Create dummy terms for your Drupal 8 application.

create:users Create dummy users for your Drupal 8 application.

Create dummy vocabularies for your Drupal 8
create:vocabularies
application.
cron
cron:debug List of modules implementing a cron

Execute cron implementations by module or

cron:execute
execute all crons
cron:release Release cron system lock to run cron again

database
database:client Launch a DB client if it's available
database:connect Shows DB connection
database:dump Dump structure and contents of a database
Remove events from DBLog table, filters are
database:log:clear
available
database:log:debug Display current log events for the application
database:restore Restore structure and contents of a database.
database:table:debug Show all tables in a given database.

database:table:drop Drop all tables in a given database.

generate
generate:authentication:provider Generate an Authentication Provider

generate:command Generate commands for the console.

generate:controller Generate & Register a controller

Generate the DrupalConsole.docset package for
generate:doc:dash
Dash

generate:doc:gitbook Generate documentations for Commands

generate:entity:bundle Generate a new content type (node / entity bundle)

generate:entity:config Generate a new config entity

generate:entity:content Generate a new content entity

generate:event:subscriber Generate an event subscriber

generate:form Generate a new "FormBase"

Available commands 40
Drupal Console

generate:form:alter Generate an implementation of hook_form_alter() or

hook_form_FORM_ID_alter
generate:form:config Generate a new "ConfigFormBase"

generate:module Generate a module.

generate:permissions Generate module permissions

generate:plugin:block Generate a plugin block
generate:plugin:condition Generate a plugin condition.
generate:plugin:field Generate field type, widget and formatter plugins.

generate:plugin:fieldformatter Generate field formatter plugin.

generate:plugin:fieldtype Generate field type plugin.

generate:plugin:fieldwidget Generate field widget plugin.

generate:plugin:imageeffect Generate image effect plugin.
generate:plugin:imageformatter Generate image formatter plugin.
generate:plugin:rest:resource Generate plugin rest resource
generate:plugin:rulesaction Generate a plugin rule action
generate:plugin:type:annotation Generate a plugin type with annotation discovery
generate:plugin:type:yaml Generate a plugin type with Yaml discovery
generate:plugin:views:field Generate a custom plugin view field.

generate:profile Generate a profile.

generate:routesubscriber Generate a RouteSubscriber
generate:service Generate service

generate:theme Generate a theme.

locale
locale:language:add Add a language to be supported by your site

locale:language:delete Delete a language to be supported by your site

locale:translation:status List available translation updates

migrate
Display current migration available for the
migrate:debug
application

migrate:execute Execute a migration available for application

Load and create the relevant migrations for a
migrate:setup
provided legacy database

module

Available commands 41
Drupal Console

module:debug Display current modules available for application

module:download Download module or modules in application

module:install Install module or modules in the application

module:uninstall Uninstall module or modules in the application

multisite
multisite:debug List all multisites available in system
rest

rest:debug Display current rest resource for the application

rest:disable Disable a rest resource for the application

rest:enable Enable a rest resource for the application

router
router:debug Displays current routes for the application
router:rebuild Rebuild routes for the application
settings
settings:check System requirement checker
settings:debug List user Drupal Console settings.
settings:init Copy configuration files to user home directory.

Change a specific setting value in DrupalConsole

settings:set
config file
site
site:debug List all known local and remote sites.
site:install Install a Drupal project

site:maintenance Switch site into maintenance mode

site:mode Switch system performance configuration

site:new Create a new Drupal project

site:statistics Show the current statistics of website.

site:status View current Drupal Installation status

state
state:debug Show the current State keys.

state:override Override a State key.

test
test:debug List Test Units available for the application.

Available commands 42
Drupal Console

test:run Run Test unit from tests available for application

theme

theme:debug Displays current themes for the application

theme:download Download theme in application

theme:install Install theme or themes in the application
theme:uninstall Uninstall theme or themes in the application
translation

translation:cleanup Clean up translation files

Determine pending translation string in a language
translation:pending
or a specific file in a language

translation:stats Generate translate stats

translation:sync Sync translation files
update
update:debug Display current updates available for the application
Execute a specific Update N function in a module,
update:execute
or execute all
user
user:debug Displays current users for the application
user:delete Delete users for the application

user:login:clear:attempts Clear failed login attempts for an account.

user:login:url Returns a one-time user login url.
user:password:hash Generate a hash from a plaintext password.

user:password:reset Reset password for a specific user.

views
views:debug Display current views resources for the application

views:disable Disable a View

views:enable Enable a View

yaml
Compare two YAML files in order to find differences
yaml:diff
between them.

Merge two or more YAML files in a new YAML file.

yaml:merge
Latest values are preserved.
yaml:split Split a YAML file using indent as separator criteria

Available commands 43
Drupal Console

yaml:update:key Replace a YAML key in a YAML file.

yaml:update:value Update a value for a specific key in a YAML file.

Available options
Option Details

--help Display this help message

--quiet Do not output any message
Increase the verbosity of messages: 1 for normal output, 2 for more
--verbose
verbose output and 3 for debug
--version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output

--no-
Do not ask any interactive question
interaction
--env The Environment name
--root Define the Drupal root to be used in command execution
--no-debug Switches off debug mode
--learning Generate a verbose code output
--generate- Shows command options and arguments as yaml output to be used in
chain chain command

--generate-
Shows command options and arguments as inline command
inline
--generate-
Shows command options and arguments as markdown
doc

--target Site name you want to interact with (for local or remote sites)
URI of the Drupal site to use (for multi-site environments or when running
--uri
on an alternate port)

--yes Skip confirmation and proceed

--check-fix Attempt to fix any missing configuration.

Available arguments

Available commands 44
Drupal Console

Argument Details

command The command to execute

Available commands 45
Drupal Console

about
The about command Display basic information about Drupal Console project

Usage:

$ drupal about

about 46
Drupal Console

chain
The chain command Chain command execution

Usage:

$ drupal chain [options]

Available options
Option Details
--file User defined file containing commands to get executed.

chain 47
Drupal Console

help
The help command Displays help for a command

Usage:

$ drupal help [arguments] [options]

Available options
Option Details
--xml To output list as XML
--raw To output raw command list

--format The output format (txt, xml, json, or md)

Available arguments
Argument Details
command_name The command name

help 48
Drupal Console

settings:init
The settings:init command Copy configuration files to user home directory.

Usage:

$ drupal settings:init [options]

$ init

Available options
Option Details
--override Override configurations files

settings:init 49
Drupal Console

list
The list command Lists all available commands

Usage:

$ drupal list [arguments] [options]

Available options
Option Details
--xml To output list as XML
--raw To output raw command list

--format The output format (txt, xml, json, or md)

Available arguments
Argument Details
namespace The namespace name

list 50
Drupal Console

server
The server command Runs PHP built-in web server

Usage:

$ drupal server [arguments]

Available arguments
Argument Details
address The address:port values

Examples
Run using default address argument value 127.0.0.1.8088

$ drupal server

Passing address argument to use a different port number

$ drupal server 127.0.0.1:8089

Running default address argument values, using --root option to define the Drupal root

$ drupal --root=/var/www/drupal8.dev server

server 51
Drupal Console

cache:rebuild
The cache:rebuild command Rebuild and clear all site caches.

Usage:

$ drupal cache:rebuild [arguments]

$ cr

Available arguments
Argument Details
cache Only clear a specific cache.

Examples
Rebuild all caches

$ drupal cr all

Rebuild discovery cache

$ drupal cr discovery

cache:rebuild 52
Drupal Console

chain:debug
The chain:debug command List available chain files.

Usage:

$ drupal chain:debug

chain:debug 53
Drupal Console

config:debug
The config:debug command Show the current configuration.

Usage:

$ drupal config:debug [arguments]

$ cde

Available arguments
Argument Details
config-name Configuration name.

config:debug 54
Drupal Console

config:diff
The config:diff command Ouput configuration items that are different in active configuration
compared with a directory.

Usage:

$ drupal config:diff [arguments] [options]

Available options
Option Details
--reverse See the changes in reverse (i.e diff a directory to the active configuration).

Available arguments
Argument Details
The directory to diff against. If omitted, choose from Drupal config
directory
directories.

config:diff 55
Drupal Console

config:edit
The config:edit command Edit the selected configuration.

Usage:

$ drupal config:edit [arguments]

$ cdit

Available arguments
Argument Details
config-name Configuration name.
editor Editor.

config:edit 56
Drupal Console

config:export
The config:export command Export current application configuration.

Usage:

$ drupal config:export [options]

$ ce

Available options
Option Details
--directory Define the export directory to save the configuration output.
--tar If set, the configuration will be exported to an archive file.

config:export 57
Drupal Console

config:export:content:type
The config:export:content:type command Export a specific content type and their fields.

Usage:

$ drupal config:export:content:type [arguments] [options]

$ cect

Available options
Option Details
--module The Module name.
--optional- Export content type as an optional YAML configuration in your
config module

Available arguments
Argument Details
content-type Content Type to be exported

config:export:content:type 58
Drupal Console

config:export:single
The config:export:single command Export single configuration as yml file.

Usage:

$ drupal config:export:single [arguments] [options]

$ ces

Available options
Option Details
--directory Define the export directory to save the configuration output.
--include-dependencies Export dependencies of the configuration as well.

Available arguments
Argument Details
config-name Configuration name.

config:export:single 59
Drupal Console

config:export:view
The config:export:view command Export a view in YAML format inside a provided module
to reuse in other website.

Usage:

$ drupal config:export:view [arguments] [options]

$ cev

Available options
Option Details
--module The Module name.
Export view as an optional YAML configuration in your
--optional-config
module
--include-module-
Include module dependencies in module info YAML file
dependencies

Available arguments
Argument Details

view-id View ID

config:export:view 60
Drupal Console

config:import
The config:import command Import configuration to current application.

Usage:

$ drupal config:import [options]

$ ci

Available options
Option Details
--file Path to an archive file of configuration to import.
--directory Path to a directory of configuration to import.

--remove-files Remove files after synchronization.

config:import 61
Drupal Console

config:import:single
The config:import:single command Import the selected configuration.

Usage:

$ drupal config:import:single [arguments]

$ cis

Available arguments
Argument Details
config-name Configuration name.
input-file Path to the import files.

config:import:single 62
Drupal Console

config:override
The config:override command Override config value in active configuration.

Usage:

$ drupal config:override [arguments]

Available arguments
Argument Details
config-name Configuration name.
key Key

value Value

Examples
Set the Contact module flood limit to 10.

$ drupal config:override contact.settings flood.limit 10

config:override 63
Drupal Console

config:settings:debug
The config:settings:debug command Displays current key:value on settings file.

Usage:

$ drupal config:settings:debug

config:settings:debug 64
Drupal Console

container:debug
The container:debug command Displays current services for an application.

Usage:

$ drupal container:debug
$ cod

container:debug 65
Drupal Console

create:nodes
The create:nodes command Create dummy nodes for your Drupal 8 application.

Usage:

$ drupal create:nodes [arguments] [options]

Available options
Option Details
--limit commands.create.nodes.arguments.limit
--title-words commands.create.nodes.arguments.title-words

--time-range commands.create.nodes.arguments.time-range

Available arguments
Argument Details
content-types Content type(s) to be used in node creation

create:nodes 66
Drupal Console

create:terms
The create:terms command Create dummy terms for your Drupal 8 application.

Usage:

$ drupal create:terms [arguments] [options]

Available options
Option Details
--limit How many terms would you like to create
--name-words Maximum number of words in term names

Available arguments
Argument Details
vocabularies Vocabulary(s) to be used in terms creation

create:terms 67
Drupal Console

create:users
The create:users command Create dummy users for your Drupal 8 application.

Usage:

$ drupal create:users [arguments] [options]

Available options
Option Details
--limit How many users would you like to create
--password Password to be set to users created

--time-range How far back in time should the users be dated

Available arguments
Argument Details
roles Role(s) to be used in user creation

create:users 68
Drupal Console

create:vocabularies
The create:vocabularies command Create dummy vocabularies for your Drupal 8
application.

Usage:

$ drupal create:vocabularies [options]

Available options
Option Details
--limit How many vocabularies would you like to create
--name-words Maximum number of words in vocabulary names

create:vocabularies 69
Drupal Console

cron:debug
The cron:debug command List of modules implementing a cron

Usage:

$ drupal cron:debug

cron:debug 70
Drupal Console

cron:execute
The cron:execute command Execute cron implementations by module or execute all crons

Usage:

$ drupal cron:execute [arguments]

$ cre

Available arguments
Argument Details
module The Module name.

cron:execute 71
Drupal Console

cron:release
The cron:release command Release cron system lock to run cron again

Usage:

$ drupal cron:release
$ crr

cron:release 72
Drupal Console

database:client
The database:client command Launch a DB client if it's available

Usage:

$ drupal database:client [arguments]

Available arguments
Argument Details
database Database key from settings.php

database:client 73
Drupal Console

database:connect
The database:connect command Shows DB connection

Usage:

$ drupal database:connect [arguments]

Available arguments
Argument Details
database Database key from settings.php

database:connect 74
Drupal Console

database:dump
The database:dump command Dump structure and contents of a database

Usage:

$ drupal database:dump [arguments] [options]

Available options
Option Details
--file commands.database.dump.option.file

Available arguments
Argument Details
database Database key from settings.php

database:dump 75
Drupal Console

database:log:clear
The database:log:clear command Remove events from DBLog table, filters are available

Usage:

$ drupal database:log:clear [arguments] [options]

Available options
Option Details
--type commands.database.log.clear.options.type
--severity commands.database.log.clear.options.severity

--user-id commands.database.log.clear.options.user-id

Available arguments
Argument Details
event-id commands.database.log.clear.arguments.event-id

database:log:clear 76
Drupal Console

database:log:debug
The database:log:debug command Display current log events for the application

Usage:

$ drupal database:log:debug [arguments] [options]

Available options
Option Details
--type Filter events by a specific type
--severity Filter events by a specific level of severity

--user-id Filter events by a specific user id

--reverse Reverse the order of events
--limit Limit results to a specific number
--offset Starting point of a limit

Available arguments
Argument Details
event-id DBLog event ID

database:log:debug 77
Drupal Console

database:restore
The database:restore command Restore structure and contents of a database.

Usage:

$ drupal database:restore [arguments] [options]

Available options
Option Details
--file The filename for your database backup file

Available arguments
Argument Details
database Database key from settings.php

database:restore 78
Drupal Console

database:table:debug
The database:table:debug command Show all tables in a given database.

Usage:

$ drupal database:table:debug [arguments]

Available arguments
Argument Details
database Database key from settings.php

database:table:debug 79
Drupal Console

database:table:drop
The database:table:drop command Drop all tables in a given database.

Usage:

$ drupal database:table:drop [arguments]

Available arguments
Argument Details
database Database key from settings.php

database:table:drop 80
Drupal Console

generate:authentication:provider
The generate:authentication:provider command Generate an Authentication Provider

Usage:

$ drupal generate:authentication:provider [options]

$ gap

Available options
Option Details
--module The Module name.
--class Authentication Provider class

--provider-id Provider ID

generate:authentication:provider 81
Drupal Console

generate:command
The generate:command command Generate commands for the console.

Usage:

$ drupal generate:command [options]

$ gcm

Available options
Option Details
--module The Module name.
The Class that describes the command. (Must end with the word
--class
'Command').
--name The Command name.

--container-
Is the command aware of the drupal site installation when executed
aware

generate:command 82
Drupal Console

generate:controller
The generate:controller command Generate & Register a controller

Usage:

$ drupal generate:controller [options]

$ gcn

Available options
Option Details
--module The Module name.
--class Controller Class name

--routes The routes, must be an array containing [title, method, path]

--services Load services from the container.
--test Generate a test class

generate:controller 83
Drupal Console

generate:doc:dash
The generate:doc:dash command Generate the DrupalConsole.docset package for Dash

Usage:

$ drupal generate:doc:dash [options]

$ gdd

Available options
Option Details
--path The path to the directory where the docset will be saved.

generate:doc:dash 84
Drupal Console

generate:doc:gitbook
The generate:doc:gitbook command Generate documentations for Commands

Usage:

$ drupal generate:doc:gitbook [options]

$ gdg

Available options
Option Details
--path The path to render the documentation

generate:doc:gitbook 85
Drupal Console

generate:entity:bundle
The generate:entity:bundle command Generate a new content type (node / entity bundle)

Usage:

$ drupal generate:entity:bundle [options]

$ geb

Available options
Option Details
--module The Module name.
--bundle-name The content type's machine name

--bundle-title The content type's human-readable name

generate:entity:bundle 86
Drupal Console

generate:entity:config
The generate:entity:config command Generate a new config entity

Usage:

$ drupal generate:entity:config [options]

$ gecg

Available options
Option Details
--module The Module name.
--entity-class The config entity class

--entity-name The config entity name

--base-path The base-path for the config entity routes
--label The label
--bundle-of Acts as bundle for content entities

generate:entity:config 87
Drupal Console

generate:entity:content
The generate:entity:content command Generate a new content entity

Usage:

$ drupal generate:entity:content [options]

$ gect

Available options
Option Details
--module The Module name.
--entity-class The content entity class

--entity-name The content entity name

--base-path The base-path for the content entity routes
--label The label
--has-bundles Entity has bundles

generate:entity:content 88
Drupal Console

generate:event:subscriber
The generate:event:subscriber command Generate an event subscriber

Usage:

$ drupal generate:event:subscriber [options]

$ ges

Available options
Option Details
--module The Module name.
--name commands.generate.service.options.name

--class Class name

--events Load services from the container.
--services Load services from the container.

generate:event:subscriber 89
Drupal Console

generate:form
The generate:form command Generate a new "FormBase"

Usage:

$ drupal generate:form [options]

Available options
Option Details
--module The Module name.
--class The form class name

--form-id The Form id

--services Load services from the container.
--inputs Create inputs in a form.
--routing Update routing
--menu_link_gen commands.generate.form.options.menu_link_gen
--menu_link_title commands.generate.form.options.menu_link_title
--menu_parent commands.generate.form.options.menu_parent
--menu_link_desc commands.generate.form.options.menu_link_desc

generate:form 90
Drupal Console

generate:form:alter
The generate:form:alter command Generate an implementation of hook_form_alter() or
hook_form_FORM_ID_alter

Usage:

$ drupal generate:form:alter [options]

$ gfa

Available options
Option Details
--module The Module name.
--form-id Form ID to alter
--inputs Create inputs in a form.

generate:form:alter 91
Drupal Console

generate:form:config
The generate:form:config command Generate a new "ConfigFormBase"

Usage:

$ drupal generate:form:config [options]

Available options
Option Details
--module The Module name.
--class The form class name

--form-id The Form id

--services Load services from the container.
--inputs Create inputs in a form.
--routing Update routing
--menu_link_gen commands.generate.form.options.menu_link_gen
--menu_link_title commands.generate.form.options.menu_link_title
--menu_parent commands.generate.form.options.menu_parent
--menu_link_desc commands.generate.form.options.menu_link_desc

generate:form:config 92
Drupal Console

generate:module
The generate:module command Generate a module.

Usage:

$ drupal generate:module [options]

$ gm

Available options
Option Details
--module The Module name
--machine-name The machine name (lowercase and underscore only)

--module-path The path of the module

--description Module description
--core Core version
--package Module package
--module-file Add a .module file
--feature Set module compatible with Features module

--composer Add a composer.json file

--dependencies Module dependencies separated by commas (i.e. context, panels)

generate:module 93
Drupal Console

generate:permissions
The generate:permissions command Generate module permissions

Usage:

$ drupal generate:permissions [options]

$ gp

Available options
Option Details
--module The Module name.
--permissions Create permissions.

generate:permissions 94
Drupal Console

generate:plugin:block
The generate:plugin:block command Generate a plugin block

Usage:

$ drupal generate:plugin:block [options]

$ gpb

Available options
Option Details
--module The Module name.
--class Plugin class name

--label Plugin label

--plugin-id Plugin id
--theme-region Theme region to render Plugin Block
--inputs Create inputs in a form.
--services Load services from the container.

generate:plugin:block 95
Drupal Console

generate:plugin:condition
The generate:plugin:condition command Generate a plugin condition.

Usage:

$ drupal generate:plugin:condition [options]

Available options
Option Details
--module The Module name.
--class Plugin condition class name

--label Plugin condition label

--plugin-id Plugin condition id
--context-definition-id Context definition ID
--context-definition-label Context definition label
--context-definition-required Context definition is required (TRUE/FALSE)

generate:plugin:condition 96
Drupal Console

generate:plugin:field
The generate:plugin:field command Generate field type, widget and formatter plugins.

Usage:

$ drupal generate:plugin:field [options]

Available options
Option Details
--module The Module name.
--type-class Field type plugin class name

--type-label Field type plugin label

--type-plugin-id Field type plugin id
--type-description commands.generate.plugin.field.options.type-type-description
--formatter-class commands.generate.plugin.field.options.class
--formatter-label Field formatter plugin label
--formatter-plugin-id Field formatter plugin id
--widget-class Field formatter plugin class name
--widget-label Field widget plugin label

--widget-plugin-id Field widget plugin id

--field-type Field type the formatter and widget plugin can be used with

--default-widget Default field widget of the field type plugin

--default-formatter Default field formatter of field type plugin

generate:plugin:field 97
Drupal Console

generate:plugin:fieldformatter
The generate:plugin:fieldformatter command Generate field formatter plugin.

Usage:

$ drupal generate:plugin:fieldformatter [options]

Available options
Option Details
--module The Module name.
--class Plugin class name

--label Plugin label

--plugin-id Plugin id
--field-type Field type the plugin can be used with

generate:plugin:fieldformatter 98
Drupal Console

generate:plugin:fieldtype
The generate:plugin:fieldtype command Generate field type plugin.

Usage:

$ drupal generate:plugin:fieldtype [options]

Available options
Option Details
--module The Module name.
--class Plugin class name

--label Plugin label

--plugin-id Plugin id
--description Plugin Description
--default-widget Default field widget of this plugin
--default-formatter Default field formatter of this plugin

generate:plugin:fieldtype 99
Drupal Console

generate:plugin:fieldwidget
The generate:plugin:fieldwidget command Generate field widget plugin.

Usage:

$ drupal generate:plugin:fieldwidget [options]

Available options
Option Details
--module The Module name.
--class Plugin class name

--label Plugin label

--plugin-id Plugin id
--field-type Field type the plugin can be used with

generate:plugin:fieldwidget 100
Drupal Console

generate:plugin:imageeffect
The generate:plugin:imageeffect command Generate image effect plugin.

Usage:

$ drupal generate:plugin:imageeffect [options]

Available options
Option Details
--module The Module name.
--class Plugin class name

--label Plugin label

--plugin-id Plugin id
--description Plugin Description

generate:plugin:imageeffect 101
Drupal Console

generate:plugin:imageformatter
The generate:plugin:imageformatter command Generate image formatter plugin.

Usage:

$ drupal generate:plugin:imageformatter [options]

Available options
Option Details
--module The Module name.
--class Plugin class name

--label Plugin label

--plugin-id Plugin id

generate:plugin:imageformatter 102
Drupal Console

generate:plugin:rest:resource
The generate:plugin:rest:resource command Generate plugin rest resource

Usage:

$ drupal generate:plugin:rest:resource [options]

Available options
Option Details
--module The Module name.
--class Plugin Rest Resource class

--name commands.generate.service.options.name
--plugin-id Plugin Rest Resource id
--plugin-label Plugin Rest Resource Label
--plugin-url Plugin Rest Resource URL
--plugin-states Plugin Rest Resource States

generate:plugin:rest:resource 103
Drupal Console

generate:plugin:rulesaction
The generate:plugin:rulesaction command Generate a plugin rule action

Usage:

$ drupal generate:plugin:rulesaction [options]

Available options
Option Details
--module The Module name.
--class Plugin class name

--label Plugin label

--plugin-id Plugin id
--type Action Type (user or node)
--category Plugin category
--context Plugin context

generate:plugin:rulesaction 104
Drupal Console

generate:plugin:type:annotation
The generate:plugin:type:annotation command Generate a plugin type with annotation
discovery

Usage:

$ drupal generate:plugin:type:annotation [options]

Available options
Option Details
--module The Module name.
--class Plugin type class name
--machine-name commands.generate.plugin.type.annotation.options.plugin-id
--label Plugin type label

generate:plugin:type:annotation 105
Drupal Console

generate:plugin:type:yaml
The generate:plugin:type:yaml command Generate a plugin type with Yaml discovery

Usage:

$ drupal generate:plugin:type:yaml [options]

Available options
Option Details
--module The Module name.
--class Plugin type class name

--plugin-name Plugin type machine name

--plugin-file-name Plugin file name

generate:plugin:type:yaml 106
Drupal Console

generate:plugin:views:field
The generate:plugin:views:field command Generate a custom plugin view field.

Usage:

$ drupal generate:plugin:views:field [options]

Available options
Option Details
--module The Module name.
--class Views plugin field class name

--title Views plugin field title

--description Views plugin field description

generate:plugin:views:field 107
Drupal Console

generate:profile
The generate:profile command Generate a profile.

Usage:

$ drupal generate:profile [options]

Available options
Option Details
--profile The profile name
--machine-name The machine name (lowercase and underscore only)

--description Profile description

--core Core version
--dependencies Module dependencies separated by commas (i.e. context, panels)
--distribution The distribution name

generate:profile 108
Drupal Console

generate:routesubscriber
The generate:routesubscriber command Generate a RouteSubscriber

Usage:

$ drupal generate:routesubscriber [options]

Available options
Option Details
--module The Module name.
--name Service name

--class Class name

generate:routesubscriber 109
Drupal Console

generate:service
The generate:service command Generate service

Usage:

$ drupal generate:service [options]

$ gs

Available options
Option Details
--module The Module name.
--name commands.generate.service.options.name

--class Class name

--interface commands.common.service.options.interface
--services Load services from the container.

generate:service 110
Drupal Console

generate:theme
The generate:theme command Generate a theme.

Usage:

$ drupal generate:theme [options]

$ gt

Available options
Option Details
--theme commands.generate.theme.options.module
--machine-name The machine name (lowercase and underscore only)

--theme-path commands.generate.theme.options.module-path
--description Theme description
--core Core version
--package Theme package
--global-library Global styling library name
--base-theme Base theme (i.e. classy, stable)

--regions Regions
--breakpoints Breakpoints

generate:theme 111
Drupal Console

locale:language:add
The locale:language:add command Add a language to be supported by your site

Usage:

$ drupal locale:language:add [arguments]

Available arguments
Argument Details
language Language for instance es or Spanish

locale:language:add 112
Drupal Console

locale:language:delete
The locale:language:delete command Delete a language to be supported by your site

Usage:

$ drupal locale:language:delete [arguments]

Available arguments
Argument Details
language Language for instance es or Spanish

locale:language:delete 113
Drupal Console

locale:translation:status
The locale:translation:status command List available translation updates

Usage:

$ drupal locale:translation:status [arguments]

Available arguments
Argument Details
language Language for instance es or Spanish

locale:translation:status 114
Drupal Console

migrate:debug
The migrate:debug command Display current migration available for the application

Usage:

$ drupal migrate:debug [arguments]

$ mid

Available arguments
Argument Details
tag Migrate tag

migrate:debug 115
Drupal Console

migrate:execute
The migrate:execute command Execute a migration available for application

Usage:

$ drupal migrate:execute [arguments] [options]

$ mie

Available options
Option Details
--site-url Site Source URL
--db-type commands.migrate.setup.migrations.options.db-type

--db-host Database Host

--db-name Database Name
--db-user Database User
--db-pass Database Pass
--db-prefix Database Prefix
--db-port Database Port

--exclude Migration id(s) to exclude

Available arguments
Argument Details

migration-ids Migration id(s)

migrate:execute 116
Drupal Console

migrate:setup
The migrate:setup command Load and create the relevant migrations for a provided legacy
database

Usage:

$ drupal migrate:setup [options]

Available options
Option Details
--db-type Drupal Database type
--db-host Database Host
--db-name Database Name
--db-user Database User

--db-pass Database Pass

--db-prefix Database Prefix
--db-port Database Port
--files-directory Files Directory

migrate:setup 117
Drupal Console

module:debug
The module:debug command Display current modules available for application

Usage:

$ drupal module:debug [options]

Available options
Option Details
--status Module status [enabled disabled]
--type Module type [core no-core]

module:debug 118
Drupal Console

module:download
The module:download command Download module or modules in application

Usage:

$ drupal module:download [arguments] [options]

$ md

Available options
Option Details
--latest Default to download most recent version

Available arguments
Argument Details
module Module or modules to be enabled should be separated by a space

module:download 119
Drupal Console

module:install
The module:install command Install module or modules in the application

Usage:

$ drupal module:install [arguments] [options]

Available options
Option Details
--latest Default to download most recent version

Available arguments
Argument Details
module Module or modules to be enabled should be separated by a space

module:install 120
Drupal Console

module:uninstall
The module:uninstall command Uninstall module or modules in the application

Usage:

$ drupal module:uninstall [arguments]

Available arguments
Argument Details
module Module or modules to be uninstalled should be separated by a comma

module:uninstall 121
Drupal Console

multisite:debug
The multisite:debug command List all multisites available in system

Usage:

$ drupal multisite:debug

multisite:debug 122
Drupal Console

rest:debug
The rest:debug command Display current rest resource for the application

Usage:

$ drupal rest:debug [arguments] [options]

$ rede

Available options
Option Details
--authorization Rest resource status enabled disabled

Available arguments
Argument Details
resource-id Rest ID

rest:debug 123
Drupal Console

rest:disable
The rest:disable command Disable a rest resource for the application

Usage:

$ drupal rest:disable [arguments]

$ redi

Available arguments
Argument Details
resource-id Rest ID

rest:disable 124
Drupal Console

rest:enable
The rest:enable command Enable a rest resource for the application

Usage:

$ drupal rest:enable [arguments]

$ ree

Available arguments
Argument Details
resource-id Rest ID

rest:enable 125
Drupal Console

router:debug
The router:debug command Displays current routes for the application

Usage:

$ drupal router:debug [arguments]

$ rod

Available arguments
Argument Details
route-name Route names

router:debug 126
Drupal Console

router:rebuild
The router:rebuild command Rebuild routes for the application

Usage:

$ drupal router:rebuild
$ ror

router:rebuild 127
Drupal Console

settings:check
The settings:check command System requirement checker

Usage:

$ drupal settings:check
$ check

settings:check 128
Drupal Console

settings:debug
The settings:debug command List user Drupal Console settings.

Usage:

$ drupal settings:debug

settings:debug 129
Drupal Console

settings:set
The settings:set command Change a specific setting value in DrupalConsole config file

Usage:

$ drupal settings:set [arguments]

Available arguments
Argument Details
setting- Setting name in yaml flatten format to set a value in Drupal Console
name config file
setting-
Setting value to set in Drupal Console config file
value

settings:set 130
Drupal Console

site:debug
The site:debug command List all known local and remote sites.

Usage:

$ drupal site:debug [arguments]

$ sd

Available arguments
Argument Details
target commands.site.debug.options.target

site:debug 131
Drupal Console

site:install
The site:install command Install a Drupal project

Usage:

$ drupal site:install [arguments] [options]

$ si

Available options
Option Details
--langcode Drupal language
--db-type Drupal Database type to be used in install

--db-file Drupal Database file to be used in install

--db-host Database Host
--db-name Database Name
--db-user Database User
--db-pass Database Pass
--db-prefix Database Prefix

--db-port Database Port

--site-name Drupal site name

--site-mail Drupal site mail

--account-name Drupal administrator account name

--account-mail Drupal administrator account mail

--account-pass Drupal administrator account password

Available arguments
Argument Details

profile Drupal Profile to be installed

site:install 132
Drupal Console

site:maintenance
The site:maintenance command Switch site into maintenance mode

Usage:

$ drupal site:maintenance [arguments]

$ sma

Available arguments
Argument Details
mode Site maintenance mode[on/off]

site:maintenance 133
Drupal Console

site:mode
The site:mode command Switch system performance configuration

Usage:

$ drupal site:mode [arguments]

$ smo

Available arguments
Argument Details
environment Environment name [dev, prod]

site:mode 134
Drupal Console

site:new
The site:new command Create a new Drupal project

Usage:

$ drupal site:new [arguments]

$ sn

Available arguments
Argument Details
directory Directory when downloading Drupal
version Drupal version to download

site:new 135
Drupal Console

site:statistics
The site:statistics command Show the current statistics of website.

Usage:

$ drupal site:statistics

site:statistics 136
Drupal Console

site:status
The site:status command View current Drupal Installation status

Usage:

$ drupal site:status [options]

$ ss

Available options
Option Details
--format commands.site.status.options.format

site:status 137
Drupal Console

state:debug
The state:debug command Show the current State keys.

Usage:

$ drupal state:debug [arguments]

Available arguments
Argument Details
key The State key to debug.

state:debug 138
Drupal Console

state:override
The state:override command Override a State key.

Usage:

$ drupal state:override [arguments]

Available arguments
Argument Details
key The State key to override.
value The State value to set.

state:override 139
Drupal Console

test:debug
The test:debug command List Test Units available for the application.

Usage:

$ drupal test:debug [arguments] [options]

$ td

Available options
Option Details
--test-class Test Class

Available arguments
Argument Details
group Group

test:debug 140
Drupal Console

test:run
The test:run command Run Test unit from tests available for application

Usage:

$ drupal test:run [arguments] [options]

$ tr

Available options
Option Details
--url commands.test.run.arguments.url

Available arguments
Argument Details
test-class Test Class
test-methods Test method(s) to be run

test:run 141
Drupal Console

theme:debug
The theme:debug command Displays current themes for the application

Usage:

$ drupal theme:debug [arguments]

$ tde

Available arguments
Argument Details
theme Specific theme to debug

theme:debug 142
Drupal Console

theme:download
The theme:download command Download theme in application

Usage:

$ drupal theme:download [arguments]

$ td

Available arguments
Argument Details
theme commands.theme.download.options.theme
version Theme version i.e 1.x-dev

theme:download 143
Drupal Console

theme:install
The theme:install command Install theme or themes in the application

Usage:

$ drupal theme:install [arguments] [options]

$ ti

Available options
Option Details
--set-default Set theme as default theme

Available arguments
Argument Details
theme commands.theme.install.options.module

theme:install 144
Drupal Console

theme:uninstall
The theme:uninstall command Uninstall theme or themes in the application

Usage:

$ drupal theme:uninstall [arguments]

$ tu

Available arguments
Argument Details
theme commands.theme.uninstall.options.module

theme:uninstall 145
Drupal Console

translation:cleanup
The translation:cleanup command Clean up translation files

Usage:

$ drupal translation:cleanup [arguments]

Available arguments
Argument Details
language Language to clean up files against English

translation:cleanup 146
Drupal Console

translation:pending
The translation:pending command Determine pending translation string in a language or a
specific file in a language

Usage:

$ drupal translation:pending [arguments] [options]

Available options
Option Details
--file Specific file to determine pending translations against English

Available arguments
Argument Details
language Language to determine pending translations against English

translation:pending 147
Drupal Console

translation:stats
The translation:stats command Generate translate stats

Usage:

$ drupal translation:stats [arguments] [options]

Available options
Option Details
--format Define output format table markdown

Available arguments
Argument Details
language Language to generate translation stats against English

translation:stats 148
Drupal Console

translation:sync
The translation:sync command Sync translation files

Usage:

$ drupal translation:sync [arguments] [options]

Available options
Option Details
--file commands.translation.stats.options.file

Available arguments
Argument Details
language Language to syncronize against English source files

translation:sync 149
Drupal Console

update:debug
The update:debug command Display current updates available for the application

Usage:

$ drupal update:debug
$ upd

update:debug 150
Drupal Console

update:execute
The update:execute command Execute a specific Update N function in a module, or
execute all

Usage:

$ drupal update:execute [arguments]

$ upe

Available arguments
Argument Details
module The Module name.
update-n Specific Update N function to be executed

update:execute 151
Drupal Console

user:debug
The user:debug command Displays current users for the application

Usage:

$ drupal user:debug [options]

Available options
Option Details
--roles Roles to filter debug
--limit How many users would you like to be listed in debug

user:debug 152
Drupal Console

user:delete
The user:delete command Delete users for the application

Usage:

$ drupal user:delete [options]

Available options
Option Details
--user-id User id to be deleted
--roles Roles associated to users to be deleted

user:delete 153
Drupal Console

user:login:clear:attempts
The user:login:clear:attempts command Clear failed login attempts for an account.

Usage:

$ drupal user:login:clear:attempts [arguments]

$ uslca

Available arguments
Argument Details
uid User ID.

user:login:clear:attempts 154
Drupal Console

user:login:url
The user:login:url command Returns a one-time user login url.

Usage:

$ drupal user:login:url [arguments]

$ uslu

Available arguments
Argument Details
user-id User ID.

user:login:url 155
Drupal Console

user:password:hash
The user:password:hash command Generate a hash from a plaintext password.

Usage:

$ drupal user:password:hash [arguments]

$ usph

Available arguments
Argument Details
password Password(s) in text format

user:password:hash 156
Drupal Console

user:password:reset
The user:password:reset command Reset password for a specific user.

Usage:

$ drupal user:password:reset [arguments]

$ uspr

Available arguments
Argument Details
user User ID
password Password in text format

user:password:reset 157
Drupal Console

views:debug
The views:debug command Display current views resources for the application

Usage:

$ drupal views:debug [arguments] [options]

$ vde

Available options
Option Details
--tag View tag
--status View status (Enabled Disabled)

Available arguments
Argument Details
view-id View ID

views:debug 158
Drupal Console

views:disable
The views:disable command Disable a View

Usage:

$ drupal views:disable [arguments]

$ vdi

Available arguments
Argument Details
view-id View ID

views:disable 159
Drupal Console

views:enable
The views:enable command Enable a View

Usage:

$ drupal views:enable [arguments]

$ ve

Available arguments
Argument Details
view-id View ID

views:enable 160
Drupal Console

yaml:diff
The yaml:diff command Compare two YAML files in order to find differences between them.

Usage:

$ drupal yaml:diff [arguments] [options]

$ yd

Available options
Option Details
--stats Print statistics about YAML files comparation
--negate Define mode diff or equal comparation, possible values TRUE/FALSE or 0/1

--limit Limit results to a specific number

--offset Starting point of a limit

Available arguments
Argument Details
yaml-left YAML file used as base to compare

yaml-right YAML file used to find missing parts or differences with the base YAML file

yaml:diff 161
Drupal Console

yaml:merge
The yaml:merge command Merge two or more YAML files in a new YAML file. Latest values
are preserved.

Usage:

$ drupal yaml:merge [arguments]

$ ym

Available arguments
Argument Details
yaml-destination Path of new YAML file to store the result of merge.
yaml-files Path of YAML files to merge

yaml:merge 162
Drupal Console

yaml:split
The yaml:split command Split a YAML file using indent as separator criteria

Usage:

$ drupal yaml:split [arguments] [options]

$ ys

Available options
Option Details
--indent-level Split YAML file using a specific indent level
--file-output-prefix commands.yaml.split.options.file-output-prefix

--file-output-suffix commands.yaml.split.options.file-output-suffix
YAML Key from where start split - useful to extract partial
--starting-key
elements
--exclude-parents-
Exclude the "parents" key from the generated file
key

Available arguments
Argument Details

yaml-file commands.yaml.split.value.arguments.yaml-file

yaml:split 163
Drupal Console

yaml:update:key
The yaml:update:key command Replace a YAML key in a YAML file.

Usage:

$ drupal yaml:update:key [arguments]

$ yu

Available arguments
Argument Details
yaml-file Path of YAML file to update
yaml-key YAML key to update

yaml-new-key commands.yaml.update.value.arguments.yaml-new-key

yaml:update:key 164
Drupal Console

yaml:update:value
The yaml:update:value command Update a value for a specific key in a YAML file.

Usage:

$ drupal yaml:update:value [arguments]

$ yuv

Available arguments
Argument Details
yaml-file Path of YAML file to update
yaml-key YAML key to update

yaml-value YAML value to update

yaml:update:value 165
Drupal Console

Installation problems
When you run DrupalConsole from your Drupal 8 root directory, you can get different error
messages, we will try to compile the reported issues and how to have them fixed.

Error message:

[PDOException] SQLSTATE[HY000] [2002] No such file or directory

You will need to edit your 'host' in your 'settings.php' file.

Navigate to sites/default/settings.php . In your settings.php file, change the host to

read:

'host' => '127.0.0.1'

or if your 'settings.php' file already reads:

'host' => '127.0.0.1'

change it to read:

'host' => 'localhost'.

After you make the change, be sure to save the file and then run DrupalConsole again.

Error message:

[PDOException]
SQLSTATE[HY000] [2002] Can't connect to local MySQL server through socket '/tmp/mysql.sock'

Creating a symlink pointing to /tmp/mysql.sock :

ln -s /path/to/your/mysql/data/mysql.sock /tmp/mysql.sock

Installation problems 166

Drupal Console

Error message:

Fatal error: require(): Failed opening required 'drupal.php'

This can be caused by the ioncube loader extension, which can be used to encode and
decode PHP files. This extension prevents normal working of any phar files with
require/include calls. You must disable the extension.

Warning message:

The configuration date.timezone was missing and overwritten with America/Tijuana.

Your timezone is not set in php.ini; you must correct this by editing the appropriate php.ini for
the command line (there's a separate php.ini for the CLI).

Run php --ini and look for "Loaded Configuration File". For example, in Ubuntu:

Loaded Configuration File: /etc/php5/cli/php.ini

Edit that file and look for

;date.timezone =

Uncomment this line and assign the desired timezone as seen on

http://php.net/manual/en/timezones.php.

Installation problems 167

Drupal Console

Commands not listed

This document is a work-in-progress. At any time, it is possible that the Drupal Console
project is ahead of the documentation. While we endeavor to keep this book up-to-date, it is
always possible that some commands have been created for the Drupal Console, but are
not yet described in this document. For a full list of supported commands, use the list
command, e.g. $ drupal list

If you see a command that is not yet described here, you are also welcome to contribute to
this documentation, using the --help output for the command as a simple starting point.

Commands not listed 168

Drupal Console

References

Drupal Console code repository

https://github.com/hechoendrupal/DrupalConsole

Documentation repository
https://github.com/hechoendrupal/drupal-console-book

Resources
Symfony Components
Drupal 8
PHP the right way
KNP University
Build a module
DrupalizeMe
Git
Composer
Box

References 169