bootstrap.sh: disable one shellcheck message about sourcing bootstrap.conf
[drupal-init-tools.git] / drin.rst
1 ======
2  drin
3 ======
4
5 -----------------
6 Drupal init tools
7 -----------------
8
9 :Author: Antonio Ospite <ao2@ao2.it>
10 :Date:   2017-06-20
11 :Copyright: GPLv2+
12 :Manual section: 1
13 :Manual group: General Commands Manual
14
15 SYNOPSIS
16 ========
17
18 *drin* <options> [sub-command]
19
20 DESCRIPTION
21 ===========
22
23 Helper commands to create and install new Drupal projects.
24
25 When setting up a new Drupal project with drupal-composer/drupal-project drush
26 and drupal-console are not available yet and some repetitive tasks can use
27 a nicer command line interface.
28
29 These scripts are especially useful when setting up projects in user web
30 directories[1].
31
32 [1] http://httpd.apache.org/docs/current/howto/public_html.html
33
34
35 OPTIONS
36 =======
37
38 Available options:
39
40   **-h**, **--help**
41     this help
42
43
44 Available sub-commands:
45
46   ``new`` `[-h|--help]` `<destdir>` `[composer options (e.g. --devel)]`
47     Create a new Drupal project in the `destdir` directory.
48
49   ``bootstrap`` `[--devel|-h|--help]"`
50     Bootstrap a Drupal project, using settings from a `bootstrap.conf` file.
51
52   ``clean`` `[-h|--help]`
53     Cleanup the project, removing all the installed files.
54
55   ``create-profile`` `[-h|--help]` `<title>` `<machine_name>`
56     Create an installation profile from the installed project.
57
58
59 EXAMPLES OF USE
60 ===============
61
62 Create and install a new Drupal project:
63
64 ::
65
66   cd ~/public_html
67   drin new drupal_test_site
68   cd drupal_test_site
69   $EDITOR bootstrap.conf
70   drin bootstrap --devel
71
72
73 Create an installation profile from the currently installed project:
74
75 ::
76
77   drin create-profile "Test Profile" test_profile
78
79
80 Clean and rebuild the whole project to verify that installing from scratch works:
81
82 ::
83
84   drin clean
85   drin bootstrap
86
87
88 SEE ALSO
89 ========
90
91 * drupal-composer/drupal-project: https://github.com/drupal-composer/drupal-project
92 * drush: https://github.com/drush-ops/drush
93 * drupal-console: https://github.com/hechoendrupal/drupal-console
94
95 .. _drupal-composer/drupal-project: https://github.com/drupal-composer/drupal-project
96 .. _drush: https://github.com/drush-ops/drush
97 .. _drupal-console: https://github.com/hechoendrupal/drupal-console
98
99 BUGS
100 ====
101
102 None known.