theme-juice 0.8.3 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -10,91 +10,55 @@
10
10
  \fBtj create\fR [\-\-flag=\fIarg\fR] [\-\-flag]
11
11
  .
12
12
  .SH "DESCRIPTION"
13
- Creates a new project\. It will lead the user through a series of prompts to set up required project information, such as name, location, theme, database info, etc\. Using the specified information, it will run the installation process and set up a local development environment, if it hasn\'t already been set up\. It will sync your local project location with the project location within the VM\.
13
+ Creates a new project\. It will lead you through a series of prompts to set up required project information, such as name, location, theme, database info, etc\. Using the specified information, it will run the installation process and set up a local development environment, if one hasn\'t already been set up\. It will sync your local project location with the project location within the VM\.
14
14
  .
15
15
  .SH "GLOBAL OPTIONS"
16
16
  .
17
17
  .TP
18
- \fB\-n\fR, \fB\-\-name\fR=\fIstring\fR:
19
- .
20
- .br
18
+ \fB\-n\fR, \fB\-\-name\fR=\fIstring\fR
21
19
  Name of the project
22
-
23
20
  .
24
21
  .TP
25
- \fB\-l\fR, \fB\-\-location\fR=\fIpath\fR:
26
- .
27
- .br
22
+ \fB\-l\fR, \fB\-\-location\fR=\fIpath\fR
28
23
  Location of the local project
29
-
30
24
  .
31
25
  .TP
32
- \fB\-t\fR, \fB\-\-theme\fR=\fIrepository\fR:
33
- .
34
- .br
26
+ \fB\-t\fR, \fB\-\-theme\fR=\fIrepository\fR
35
27
  Starter theme to install
36
-
37
28
  .
38
29
  .TP
39
- \fB\-u\fR, \fB\-\-url\fR=\fIurl\fR:
40
- .
41
- .br
30
+ \fB\-u\fR, \fB\-\-url\fR=\fIurl\fR
42
31
  Development URL for the project
43
-
44
32
  .
45
33
  .TP
46
- \fB\-r\fR, \fB\-\-repository\fR=\fIrepository\fR:
47
- .
48
- .br
34
+ \fB\-r\fR, \fB\-\-repository\fR=\fIrepository\fR
49
35
  Initialize a new Git remote repository
50
-
51
36
  .
52
37
  .TP
53
- \fB\-i\fR, \fB\-\-import\-db\fR=\fIpath\fR:
54
- .
55
- .br
38
+ \fB\-i\fR, \fB\-\-import\-db\fR=\fIpath\fR
56
39
  Import an existing database
57
-
58
40
  .
59
41
  .TP
60
- \fB\-\-bare\fR, \fB\-\-no\-theme\fR:
61
- .
62
- .br
42
+ \fB\-\-bare\fR, \fB\-\-no\-theme\fR
63
43
  Create a project without a starter theme
64
-
65
44
  .
66
45
  .TP
67
- \fB\-\-skip\-repo\fR:
68
- .
69
- .br
46
+ \fB\-\-skip\-repo\fR
70
47
  Skip repository prompts and use default settings
71
-
72
48
  .
73
49
  .TP
74
- \fB\-\-skip\-db\fR:
75
- .
76
- .br
50
+ \fB\-\-skip\-db\fR
77
51
  Skip database prompts and use default settings
78
-
79
52
  .
80
53
  .TP
81
- \fB\-\-use\-defaults\fR:
82
- .
83
- .br
54
+ \fB\-\-use\-defaults\fR
84
55
  Skip all prompts and use default settings
85
-
86
56
  .
87
57
  .TP
88
- \fB\-\-no\-wp\fR:
89
- .
90
- .br
58
+ \fB\-\-no\-wp\fR
91
59
  Project is not a WordPress install
92
-
93
60
  .
94
61
  .TP
95
- \fB\-\-no\-db\fR:
96
- .
97
- .br
62
+ \fB\-\-no\-db\fR
98
63
  Project does not need a database
99
64
 
100
-
@@ -9,63 +9,51 @@ SYNOPSIS
9
9
  tj create [--flag=arg] [--flag]
10
10
 
11
11
  DESCRIPTION
12
- Creates a new project. It will lead the user through a series of
13
- prompts to set up required project information, such as name, location,
14
- theme, database info, etc. Using the specified information, it will run
15
- the installation process and set up a local development environment, if
16
- it hasn't already been set up. It will sync your local project location
12
+ Creates a new project. It will lead you through a series of prompts to
13
+ set up required project information, such as name, location, theme,
14
+ database info, etc. Using the specified information, it will run the
15
+ installation process and set up a local development environment, if one
16
+ hasn't already been set up. It will sync your local project location
17
17
  with the project location within the VM.
18
18
 
19
19
  GLOBAL OPTIONS
20
- -n, --name=string:
20
+ -n, --name=string
21
21
  Name of the project
22
22
 
23
-
24
- -l, --location=path:
23
+ -l, --location=path
25
24
  Location of the local project
26
25
 
27
-
28
- -t, --theme=repository:
26
+ -t, --theme=repository
29
27
  Starter theme to install
30
28
 
31
-
32
- -u, --url=url:
29
+ -u, --url=url
33
30
  Development URL for the project
34
31
 
35
-
36
- -r, --repository=repository:
32
+ -r, --repository=repository
37
33
  Initialize a new Git remote repository
38
34
 
39
-
40
- -i, --import-db=path:
35
+ -i, --import-db=path
41
36
  Import an existing database
42
37
 
43
-
44
- --bare, --no-theme:
38
+ --bare, --no-theme
45
39
  Create a project without a starter theme
46
40
 
47
-
48
- --skip-repo:
41
+ --skip-repo
49
42
  Skip repository prompts and use default settings
50
43
 
51
-
52
- --skip-db:
44
+ --skip-db
53
45
  Skip database prompts and use default settings
54
46
 
55
-
56
- --use-defaults:
47
+ --use-defaults
57
48
  Skip all prompts and use default settings
58
49
 
59
-
60
- --no-wp:
50
+ --no-wp
61
51
  Project is not a WordPress install
62
52
 
63
-
64
- --no-db:
53
+ --no-db
65
54
  Project does not need a database
66
55
 
67
56
 
68
57
 
69
58
 
70
-
71
59
  June 2015 TJ-CREATE(1)
@@ -10,7 +10,7 @@
10
10
  \fBtj delete\fR [\-\-flag=\fIarg\fR] [\-\-flag]
11
11
  .
12
12
  .SH "DESCRIPTION"
13
- Remove a project from your development environment\. This will only remove files that were generated by \fBtj\fR i\.e\. the database setup, development url, and shared directories\.
13
+ Remove a project from your development environment\. This will only remove files that were generated by \fBtj\fR i\.e\. the database setup, DNS setup, and the project\'s shared directories\.
14
14
  .
15
15
  .P
16
16
  It will not touch your local folders that were synced to the VM\.
@@ -18,30 +18,18 @@ It will not touch your local folders that were synced to the VM\.
18
18
  .SH "GLOBAL OPTIONS"
19
19
  .
20
20
  .TP
21
- \fB\-n\fR, \fB\-\-name\fR=\fIstring\fR:
22
- .
23
- .br
21
+ \fB\-n\fR, \fB\-\-name\fR=\fIstring\fR
24
22
  Name of the project
25
-
26
23
  .
27
24
  .TP
28
- \fB\-u\fR, \fB\-\-url\fR=\fIurl\fR:
29
- .
30
- .br
25
+ \fB\-u\fR, \fB\-\-url\fR=\fIurl\fR
31
26
  Development URL for the project
32
-
33
27
  .
34
28
  .TP
35
- \fB\-\-drop\-db\fR, \fB\-\-db\-drop\fR:
36
- .
37
- .br
29
+ \fB\-\-drop\-db\fR, \fB\-\-db\-drop\fR
38
30
  Drop the project\'s database
39
-
40
31
  .
41
32
  .TP
42
- \fB\-\-restart\-vm\fR, \fB\-\-vm\-restart\fR:
43
- .
44
- .br
33
+ \fB\-\-restart\-vm\fR, \fB\-\-vm\-restart\fR
45
34
  Restart the VM after deletion
46
35
 
47
-
@@ -10,29 +10,25 @@ SYNOPSIS
10
10
 
11
11
  DESCRIPTION
12
12
  Remove a project from your development environment. This will only
13
- remove files that were generated by tj i.e. the database setup, devel-
14
- opment url, and shared directories.
13
+ remove files that were generated by tj i.e. the database setup, DNS
14
+ setup, and the project's shared directories.
15
15
 
16
16
  It will not touch your local folders that were synced to the VM.
17
17
 
18
18
  GLOBAL OPTIONS
19
- -n, --name=string:
19
+ -n, --name=string
20
20
  Name of the project
21
21
 
22
-
23
- -u, --url=url:
22
+ -u, --url=url
24
23
  Development URL for the project
25
24
 
26
-
27
- --drop-db, --db-drop:
25
+ --drop-db, --db-drop
28
26
  Drop the project's database
29
27
 
30
-
31
- --restart-vm, --vm-restart:
28
+ --restart-vm, --vm-restart
32
29
  Restart the VM after deletion
33
30
 
34
31
 
35
32
 
36
33
 
37
-
38
34
  June 2015 TJ-DELETE(1)
@@ -0,0 +1,13 @@
1
+ .\" generated with Ronn/v0.7.3
2
+ .\" http://github.com/rtomayko/ronn/tree/0.7.3
3
+ .
4
+ .TH "TJ\-DEPLOY" "1" "June 2015" "" "Theme Juice Manual"
5
+ .
6
+ .SH "NAME"
7
+ \fBtj\-deploy\fR \- Deploy a project
8
+ .
9
+ .SH "SYNOPSIS"
10
+ \fBtj deploy\fR [\-\-flag=\fIarg\fR] [\-\-flag]
11
+ .
12
+ .SH "DESCRIPTION"
13
+ Coming soon
@@ -0,0 +1,16 @@
1
+ TJ-DEPLOY(1) Theme Juice Manual TJ-DEPLOY(1)
2
+
3
+
4
+
5
+ NAME
6
+ tj-deploy - Deploy a project
7
+
8
+ SYNOPSIS
9
+ tj deploy [--flag=arg] [--flag]
10
+
11
+ DESCRIPTION
12
+ Coming soon
13
+
14
+
15
+
16
+ June 2015 TJ-DEPLOY(1)
@@ -15,72 +15,42 @@ Sets up an existing local project within the development environment\. You will
15
15
  .SH "GLOBAL OPTIONS"
16
16
  .
17
17
  .TP
18
- \fB\-n\fR, \fB\-\-name\fR=\fIname\fR:
19
- .
20
- .br
18
+ \fB\-n\fR, \fB\-\-name\fR=\fIname\fR
21
19
  Name of the project
22
-
23
20
  .
24
21
  .TP
25
- \fB\-l\fR, \fB\-\-location\fR=\fIpath\fR:
26
- .
27
- .br
22
+ \fB\-l\fR, \fB\-\-location\fR=\fIpath\fR
28
23
  Location of the local project
29
-
30
24
  .
31
25
  .TP
32
- \fB\-u\fR, \fB\-\-url\fR=\fIurl\fR:
33
- .
34
- .br
26
+ \fB\-u\fR, \fB\-\-url\fR=\fIurl\fR
35
27
  Development URL for the project
36
-
37
28
  .
38
29
  .TP
39
- \fB\-r\fR, \fB\-\-repository\fR=\fIrepository\fR:
40
- .
41
- .br
30
+ \fB\-r\fR, \fB\-\-repository\fR=\fIrepository\fR
42
31
  Initialize a new Git remote repository
43
-
44
32
  .
45
33
  .TP
46
- \fB\-i\fR, \fB\-\-import\-db\fR=\fIpath\fR:
47
- .
48
- .br
34
+ \fB\-i\fR, \fB\-\-import\-db\fR=\fIpath\fR
49
35
  Import an existing database
50
-
51
36
  .
52
37
  .TP
53
- \fB\-\-skip\-repo\fR:
54
- .
55
- .br
38
+ \fB\-\-skip\-repo\fR
56
39
  Skip repository prompts and use default settings
57
-
58
40
  .
59
41
  .TP
60
- \fB\-\-skip\-db\fR:
61
- .
62
- .br
42
+ \fB\-\-skip\-db\fR
63
43
  Skip database prompts and use default settings
64
-
65
44
  .
66
45
  .TP
67
- \fB\-\-use\-defaults\fR:
68
- .
69
- .br
46
+ \fB\-\-use\-defaults\fR
70
47
  Skip all prompts and use default settings
71
-
72
48
  .
73
49
  .TP
74
- \fB\-\-no\-wp\fR:
75
- .
76
- .br
50
+ \fB\-\-no\-wp\fR
77
51
  Project is not a WordPress install
78
-
79
52
  .
80
53
  .TP
81
- \fB\-\-no\-db\fR:
82
- .
83
- .br
54
+ \fB\-\-no\-db\fR
84
55
  Project does not need a database
85
56
 
86
-
@@ -14,47 +14,37 @@ DESCRIPTION
14
14
  This command is essentially an alias for tj create --bare.
15
15
 
16
16
  GLOBAL OPTIONS
17
- -n, --name=name:
17
+ -n, --name=name
18
18
  Name of the project
19
19
 
20
-
21
- -l, --location=path:
20
+ -l, --location=path
22
21
  Location of the local project
23
22
 
24
-
25
- -u, --url=url:
23
+ -u, --url=url
26
24
  Development URL for the project
27
25
 
28
-
29
- -r, --repository=repository:
26
+ -r, --repository=repository
30
27
  Initialize a new Git remote repository
31
28
 
32
-
33
- -i, --import-db=path:
29
+ -i, --import-db=path
34
30
  Import an existing database
35
31
 
36
-
37
- --skip-repo:
32
+ --skip-repo
38
33
  Skip repository prompts and use default settings
39
34
 
40
-
41
- --skip-db:
35
+ --skip-db
42
36
  Skip database prompts and use default settings
43
37
 
44
-
45
- --use-defaults:
38
+ --use-defaults
46
39
  Skip all prompts and use default settings
47
40
 
48
-
49
- --no-wp:
41
+ --no-wp
50
42
  Project is not a WordPress install
51
43
 
52
-
53
- --no-db:
44
+ --no-db
54
45
  Project does not need a database
55
46
 
56
47
 
57
48
 
58
49
 
59
-
60
50
  June 2015 TJ-SETUP(1)
@@ -10,120 +10,203 @@ SYNOPSIS
10
10
 
11
11
  DESCRIPTION
12
12
  Theme Juice is a WordPress development command line utility that allows
13
- you to scaffold out entire Vagrant development environments in seconds
14
- (using VVV https://github.com/Varying-Vagrant-Vagrants/VVV as the VM),
15
- manage dependencies and build tools, and even handle deployments.
13
+ you to scaffold out an entire Vagrant development environment in sec-
14
+ onds (using an Apache fork of VVV https://github.com/Vary-
15
+ ing-Vagrant-Vagrants/VVV called VVV-Apache https://github.com/eric-
16
+ mann/vvv-apache.git as the VM). It also helps you manage dependencies
17
+ and build tools, and can even handle your deployments.
16
18
 
17
19
  GLOBAL OPTIONS
18
- --vm-box=repository:
19
- Force Vagrant box to use for VM
20
+ --vm-box=repository
21
+ Force Vagrant box for use as VM
20
22
 
21
-
22
- --vm-path=path:
23
+ --vm-path=path
23
24
  Force path to VM
24
25
 
25
-
26
- --vm-ip=ip:
26
+ --vm-ip=ip
27
27
  Force IP address of VM
28
28
 
29
-
30
- --vm-prefix=string:
29
+ --vm-prefix=string
31
30
  Force directory prefix for project in VM
32
31
 
32
+ --yolo Say yes to anything and everything
33
33
 
34
- --yolo:
35
- Say yes to anything and everything
36
-
37
-
38
- --boring:
34
+ --boring
39
35
  Prints all output without any fancy formatting
40
36
 
41
-
42
- --no-unicode:
37
+ --no-unicode
43
38
  Prints all output without unicode characters
44
39
 
45
-
46
- --no-colors, --no-color:
40
+ --no-colors, --no-color
47
41
  Prints all output without color
48
42
 
43
+ --no-animations
44
+ Prints all output without animations
49
45
 
50
- --no-animations:
51
- Prints all output without animations (coming soon)
52
-
53
-
54
- --no-landrush:
46
+ --no-landrush
55
47
  Disable the landrush gem for managing DNS
56
48
 
49
+ --no-port-forward, --no-port-forwarding
50
+ Disable automatic port forwarding
57
51
 
58
- --verbose:
52
+ --verbose
59
53
  Prints out additional logging information
60
54
 
61
-
62
- --dryrun, --dry-run:
55
+ --dryrun, --dry-run
63
56
  Run a command without actually doing anything
64
57
 
58
+ --nginx, --no-apache
59
+ Create conf files for nginx instead of apache
65
60
 
66
61
  PRIMARY COMMANDS
67
62
  Run tj help [command] to view an individual command's man page.
68
63
 
69
- create, new, mk:
64
+ create, new, mk
70
65
  Create a new project
71
66
 
72
-
73
- setup, up, init:
67
+ setup, up, init
74
68
  Setup an existing project
75
69
 
76
-
77
- delete, rm, remove, trash:
70
+ delete, rm, remove, trash
78
71
  Delete a project
79
72
 
73
+ deploy, server, remote
74
+ Deploy a project
80
75
 
81
76
  SECONDARY COMMANDS
82
- version, --version, -v:
77
+ version, --version, -v
83
78
  Print the current version
84
79
 
85
-
86
- list, ls, projects, apps, sites:
80
+ list, ls, projects, apps, sites
87
81
  List all projects
88
82
 
89
-
90
- vm, vagrant, vvv=[command[,command]...]:
91
- Manage development environment. Commands are proxied to your
92
- Vagrant installation so that they can be run from any directory.
93
-
83
+ vm, vagrant, vvv=[command[,command]...]
84
+ Manage development environment via vagrant. Commands are proxied
85
+ to your Vagrant installation so that they can be run from any
86
+ directory.
94
87
 
95
88
  CONFIG COMMANDS
96
89
  These run the corresponding command from your project's config file.
97
- They accept any number of commands, since the behavior and handling of
90
+ They accept any number of arguments, since the behavior and handling of
98
91
  input is defined within the config file itself.
99
92
 
100
- install, build=[command[,command]...]:
93
+ install, build=[arg[,arg]...]
101
94
  Run installation for project
102
95
 
103
-
104
- watch, dev=[command[,command]...]:
96
+ watch, dev=[arg[,arg]...]
105
97
  Manage and run development build tools
106
98
 
107
-
108
- vendor, deps=[command[,command]...]:
99
+ vendor, deps=[arg[,arg]...]
109
100
  Manage PHP vendor dependencies
110
101
 
111
-
112
- dist, pkg, package, zip=[command[,command]...]:
102
+ dist, pkg, package, zip=[arg[,arg]...]
113
103
  Package project for distribution
114
104
 
105
+ wp, wordpress=[arg[,arg]...]
106
+ Manage WordPress installation
107
+
108
+ backup, bk=[arg[,arg]...]
109
+ Backup project
110
+
111
+ test, tests, spec, specs=[arg[,arg]...]
112
+ Manage and run project tests
113
+
114
+ CONFIG FILE
115
+ A YAML configuration file (Juicefile) can be used to store com-
116
+ monly-used build scripts. Each command block sequence can be mapped to
117
+ an individual project's build tool, allowing a streamlined set of com-
118
+ mands to be used across multiple projects that utilize different tools.
119
+
120
+ commands
121
+ Collection of various command block sequences
122
+
123
+ commands.install
124
+ Run theme installation
115
125
 
116
- wp, wordpress=[command[,command]...]:
126
+ commands.watch
127
+ Manage development build tools
128
+
129
+ commands.vendor
130
+ Manage vendor dependencies
131
+
132
+ commands.wp
117
133
  Manage WordPress installation
118
134
 
135
+ commands.dist
136
+ Package project for distribution
119
137
 
120
- backup, bk=[command[,command]...]:
138
+ commands.backup
121
139
  Backup project
122
140
 
123
-
124
- test, tests, spec, specs=[command[,command]...]:
141
+ commands.test
125
142
  Manage and run project tests
126
143
 
144
+ deployment
145
+ Coming soon
146
+
147
+ Placeholder arguments can be used within any command block sequence to
148
+ allow splat or indexed arguments to be passed to the corresponding com-
149
+ mand when executed.
150
+
151
+ %args%, %arguments%
152
+ Splat argument placeholder e.g. cmd %args%
153
+
154
+ %argN%, %argumentN%
155
+ Where n is the argument index e.g. cmd %arg1% | cmd %arg2%
156
+
157
+ When naming your configuration file, use the recommended Juicefile, or
158
+ .tj.yaml naming convention. The raw filename regex matcher is below if
159
+ you want to be a little different.
160
+
161
+ /^(((\.)?(tj)|((J|j)uicefile))(.y(a)?ml)?$)/
162
+
163
+ ENVIRONMENT
164
+ All of the global options have a corresponding ENV variable that can be
165
+ set to permanently use the specified value each time tj is run. This is
166
+ useful if you're using an alternate Vagrant box, or if you need to dis-
167
+ able certain features due to limited support e.g. on Windows.
168
+
169
+ TJ_VM_BOX=repository
170
+ Force Vagrant box for use as VM
171
+
172
+ TJ_PATH=path
173
+ Force path to VM
174
+
175
+ TJ_IP=ip
176
+ Force IP address of VM
177
+
178
+ TJ_PREFIX=string
179
+ Force directory prefix for project in VM
180
+
181
+ TJ_YOLO=bool
182
+ Say yes to anything and everything
183
+
184
+ TJ_BORING=bool
185
+ Prints all output without any fancy formatting
186
+
187
+ TJ_NO_UNICODE=bool
188
+ Prints all output without unicode characters
189
+
190
+ TJ_NO_COLORS=bool
191
+ Prints all output without color
192
+
193
+ TJ_NO_ANIMATIONS=bool
194
+ Prints all output without animations (coming soon)
195
+
196
+ TJ_NO_LANDRUSH=bool
197
+ Disable the landrush gem for managing DNS
198
+
199
+ TJ_NO_PORT_FORWARD=bool
200
+ Disable automatic port forwarding
201
+
202
+ TJ_VERBOSE=bool
203
+ Prints out additional logging information
204
+
205
+ TJ_DRYRUN=bool
206
+ Run a command without actually doing anything
207
+
208
+ TJ_NGINX=bool
209
+ Create conf files for nginx instead of apache
127
210
 
128
211
 
129
212