The document provides a comprehensive overview of the Drupal Console, a command-line interface tool for Drupal 8 that facilitates code generation, debugging, and module creation. It outlines installation instructions, project maintenance, and various commands to interact with and manage Drupal sites, including creating modules, forms, and managing configurations. The document also emphasizes the significance of contributing to the project and improving documentation while detailing future enhancements and development plans.

1. Drupal Console Deep Dive
@drupalconsole | #drupalconsole

2. Jesus Manuel Olivas
Drupal 8 Solutions Engineer
|
I work for FFW
(and you should too)
About me
@jmolivas @drupalconsole
@drupodcast

3. Topics
Drupal Console the what, why and how.
Generate code/files required by a Drupal 8 module.
Interact and Debug Drupal 8.
Learn Drupal 8.
Write an integration.
Automate command execution.
Remote command execution.
Contribute to the project and Roadmap.

4. What is the Drupal Console?
The new CLI for Drupal.
The Drupal Console is a tool to generate
boilerplate code, interact and debug Drupal 8.

5. David Flores ​| @dmouse
Eduardo García | @enzolutions
Jesús Manuel Olivas | @jmolivas
Omar Aguirre | @omers
Who maintain this project?

6. Supporting organizations

7. Why should you care about it?

8. Drupal is more tehcnically advanced

9. How does Drupal Console help?
Generate boilerplate code for Drupal 8.
Interact and debug Drupal 8.
Learn Drupal 8.

10. Where do you nd the project?
Landing Page
Documentation
Support
http://drupalconsole.com/
http://bit.ly/console-book
http://bit.ly/console-support

11. Download Drupal Console

12. Using the installer
# Run this in your terminal to get the latest project version:
curl https://drupalconsole.com/installer -L -o 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 to user home directory:
drupal init --override
# Check and validate system requirements
drupal check

13. Using Composer
$ composer global require drupal/console:@stable
# download path:
# ~/.composer/vendor/drupal/console
# run it using:
$ ~/.composer/vendor/bin/console
Gitbook - Using Composer

14. Using Drupal Composer
$ composer create-project
drupal-composer/drupal-project:8.x-dev
drupal8.dev
--stability dev
--no-interaction
https://github.com/drupal-composer/drupal-project

15. Using a Virtual Machine / Container
DrupalVM
Drupal 8 Sprint Box
Drupal development with Docker
Drude (Drupal Docker Environment)
http://www.drupalvm.com/
https://github.com/thom8/drupal8-vagrant
https://github.com/wadmiraal/docker-drupal
https://github.com/blinkreaction/drude

16. Updating the project
$ drupal self-update
$ php console.phar self-update
$ composer global update drupal/console

17. Copy con guration les
drupal init

18. Validate system requirements
drupal check

19. site:new

20. site:install

21. chain

22. chain
chain --file=~/.console/chain/quick-start.yml

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

24. Execute Drupal Console
# change directory to site path
$ cd /var/www/drupal8.dev
$ drupal
# use --root option
$ drupal --root=/var/www/drupal8.dev

25. Generate the code and les
required by a Drupal 8 module.

26. Creating a module
Create a new directory named 'example' at
'modules/custom' directory.
Create an 'example.info.yml' file at
'modules/custom/example' directory.
Custom and contributed modules must be created
at modules folder in the root directory.

27. generate:module

29. Creating a Custom Page
Create a 'HelloController' Class with a 'hello'
method at 'src/Controller' Directory.
Create a route with path to '/hello/{name}' at
'example.routing.yml' file.
Make sure your HelloController class extends from
ControllerBase core class.

30. generate:controller

34. Creating a Con g Form
Create a 'ExampleForm.php' class at 'src/Form'
Directory.
Create a route with path to
'/admin/config/example/example' at
'example.routing.yml'.
Add example.links.menu.yml file and set
system.admin_config_system as parent.
Make sure you use _form instead of _controller on
route defaults.

35. generate:form:con g

38. example.routing.yml

39. src/Form/ExampleForm.php

40. src/Form/ExampleForm.php

41. src/Form/ExampleForm.php

42. Creating a Block (Plugin)
Create a 'ExampleBlock' class at 'src/Plugin/Block'.
Extend from BlockBase core class.
Add @Block annotation.
Add blockForm, blockSubmit and build methods.
Adding the @Block annotation, make this block
discoverable by the system.

43. generate:plugin:block
$ drupal generate:plugin:block
--module="example"
--class="ExampleBlock"
--label="example_block"
--plugin-id="example_block"
--no-interaction

46. generate:entity:content
$ drupal generate:entity:content
--module="example"
--entity-class="Foo"
--entity-name="foo"
--no-interaction

48. Interact and debug Drupal 8.

49. drupal container:debug

50. container:debug
drupal container:debug | peco

51. drupal router:debug
drupal router:debug | peco | awk '{print $1}' | xargs drupal router:debug

52. drupal router:debug user.login

53. drupal site:mode dev [1/2]

54. Performance
/admin/config/development/performance

55. Views settings
/admin/structure/views/view/content

56. Logging and errors
/admin/config/development/logging

57. drupal site:mode dev [2/2]

58. Twig debug

59. drupal database:log:debug --reverse
--limit=20

60. drupal database:log:debug 828

61. site
site
site:maintenance [ON/OFF]
site:status

62. con g
config
config:debug
config:edit
config:export
config:export:content:type
config:export:single
config:export:view
config:import
config:import:single
config:override

63. user
user
user:login:clear:attempts
user:login:url
user:password:hash
user:password:reset

64. Learn Drupal 8.

65. Use --learning option
$ drupal generate:controller
--module="example"
--class="ExampleController"
--routes="title:hello method:hello path:/hello/{name}"
--test
--no-interaction
--learning

67. Write an integration

68. generate:command
$ drupal generate:command
--module="example"
--class-name="HelloCommand"
--command="example:hello"
--no-interaction

70. Remote command execution

71. Global con guration
~/.console/config.yml
application:
...
remote:
user: root
port: 22
console: /usr/local/bin/drupal
keys:
public: ~/.ssh/id_rsa.pub
private: ~/.ssh/id_rsa
passphrase: ~/.ssh/passphrase.txt

72. Site con guration
~/.console/sites/sample.yml
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

73. site:debug

74. site:debug sample.dev

75. --target || @
$ drupal --target=sample.dev cr all
$ drupal @sample.dev cr all

76. Remote site execution

77. How to contribute?

78. Getting the project
Fork your own copy of the Console repository
Clone your forked repository.
$ git clone git@github.com:[github-user]/DrupalConsole.git
Download dependencies using componser.
$ cd /path/to/DrupalConsole
$ composer install
http://bit.ly/console-fork

79. Before commiting your code
Project code is PSR-2 Coding Style.
Generated code is Drupal Coding Style.
http://www.php-fig.org/psr/psr-2/
https://www.drupal.org/coding-standards

80. Contributors
https://drupalconsole.com/contributors

81. Spread the word and love.
@drupalconsole | #drupalconsole

82. Roadmap

83. Increase code coverage.
Improve documentation and translations.
Improve verbose code-output. (--learning)
Improve automate capabilities. (chain)

84. Milestones
https://github.com/hechoendrupal/DrupalConsole/milestones

85. Current and upcomming implementations
Webpro ler (devel submodule)
Meta tag
Drupal Commerce
Scheduled Updates
Rules
Casper (theme)
Liberty (theme)

86. What if ... I am not a CLI guru

87. GUI for the CLI.
Desktop/Native application using
Electron
ReactJS
ES6

88. Questions & Feedback
Feel free to stalk me or ask any question at:
@jmolivas | @drupalconsole