theme-juice 0.17.1 → 0.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +304 -304
- data/lib/theme-juice.rb +3 -0
- data/lib/theme-juice/cli.rb +11 -1
- data/lib/theme-juice/commands/init.rb +24 -0
- data/lib/theme-juice/man/tj +28 -21
- data/lib/theme-juice/man/tj-create +38 -4
- data/lib/theme-juice/man/tj-create.txt +29 -4
- data/lib/theme-juice/man/tj-delete +5 -5
- data/lib/theme-juice/man/tj-delete.txt +2 -2
- data/lib/theme-juice/man/tj-deploy +6 -9
- data/lib/theme-juice/man/tj-deploy.txt +5 -9
- data/lib/theme-juice/man/tj-setup +3 -3
- data/lib/theme-juice/man/tj-setup.txt +1 -1
- data/lib/theme-juice/man/tj.txt +33 -30
- data/lib/theme-juice/task.rb +0 -2
- data/lib/theme-juice/tasks/capistrano/dir.rb +4 -4
- data/lib/theme-juice/tasks/init_confirm.rb +26 -0
- data/lib/theme-juice/tasks/init_success.rb +23 -0
- data/lib/theme-juice/version.rb +1 -1
- metadata +26 -23
data/lib/theme-juice.rb
CHANGED
@@ -20,6 +20,7 @@ require "theme-juice/config"
|
|
20
20
|
require "theme-juice/task"
|
21
21
|
require "theme-juice/tasks/entry"
|
22
22
|
require "theme-juice/tasks/vm_box"
|
23
|
+
require "theme-juice/tasks/init_confirm"
|
23
24
|
require "theme-juice/tasks/create_confirm"
|
24
25
|
require "theme-juice/tasks/delete_confirm"
|
25
26
|
require "theme-juice/tasks/location"
|
@@ -37,6 +38,7 @@ require "theme-juice/tasks/landrush"
|
|
37
38
|
require "theme-juice/tasks/synced_folder"
|
38
39
|
require "theme-juice/tasks/dns"
|
39
40
|
require "theme-juice/tasks/wp_cli"
|
41
|
+
require "theme-juice/tasks/init_success"
|
40
42
|
require "theme-juice/tasks/create_success"
|
41
43
|
require "theme-juice/tasks/delete_success"
|
42
44
|
require "theme-juice/tasks/vm_provision"
|
@@ -49,6 +51,7 @@ require "theme-juice/tasks/settings"
|
|
49
51
|
require "theme-juice/tasks/load"
|
50
52
|
require "theme-juice/tasks/invoke"
|
51
53
|
require "theme-juice/command"
|
54
|
+
require "theme-juice/commands/init"
|
52
55
|
require "theme-juice/commands/create"
|
53
56
|
require "theme-juice/commands/delete"
|
54
57
|
require "theme-juice/commands/deploy"
|
data/lib/theme-juice/cli.rb
CHANGED
@@ -13,6 +13,7 @@ module ThemeJuice
|
|
13
13
|
@project = Project
|
14
14
|
@util = Util.new
|
15
15
|
@list = Tasks::List
|
16
|
+
@init = Commands::Init
|
16
17
|
@create = Commands::Create
|
17
18
|
@delete = Commands::Delete
|
18
19
|
@deploy = Commands::Deploy
|
@@ -44,7 +45,7 @@ module ThemeJuice
|
|
44
45
|
map %w[man doc docs] => :help
|
45
46
|
map %w[--version -v] => :version
|
46
47
|
map %w[mk new] => :create
|
47
|
-
map %w[up
|
48
|
+
map %w[up] => :init
|
48
49
|
map %w[rm remove trash] => :delete
|
49
50
|
map %w[ls projects apps sites] => :list
|
50
51
|
map %w[server remote] => :deploy
|
@@ -91,6 +92,15 @@ module ThemeJuice
|
|
91
92
|
@io.say @version, :color => :green
|
92
93
|
end
|
93
94
|
|
95
|
+
desc "init", "Initialize the VM"
|
96
|
+
def init
|
97
|
+
@io.say "Initializing the VM...", {
|
98
|
+
:color => [:black, :on_green, :bold],
|
99
|
+
:row => true
|
100
|
+
}
|
101
|
+
@init.new(options).execute
|
102
|
+
end
|
103
|
+
|
94
104
|
desc "create", "Create new project"
|
95
105
|
method_option :name, :type => :string, :aliases => "-n", :default => nil, :desc => ""
|
96
106
|
method_option :location, :type => :string, :aliases => "-l", :default => nil, :desc => ""
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
|
3
|
+
module ThemeJuice
|
4
|
+
module Commands
|
5
|
+
class Init < Command
|
6
|
+
|
7
|
+
def initialize(opts = {})
|
8
|
+
super
|
9
|
+
|
10
|
+
runner do |tasks|
|
11
|
+
tasks << Tasks::InitConfirm.new
|
12
|
+
tasks << Tasks::VMBox.new
|
13
|
+
tasks << Tasks::VMPlugins.new
|
14
|
+
tasks << Tasks::VMLocation.new
|
15
|
+
tasks << Tasks::VMCustomfile.new
|
16
|
+
tasks << Tasks::Landrush.new
|
17
|
+
tasks << Tasks::ForwardPorts.new
|
18
|
+
tasks << Tasks::VMProvision.new
|
19
|
+
tasks << Tasks::InitSuccess.new
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
data/lib/theme-juice/man/tj
CHANGED
@@ -1,7 +1,7 @@
|
|
1
|
-
.\" generated with Ronn/v0.7.
|
2
|
-
.\" http://github.com/rtomayko/ronn/tree/0.7.
|
1
|
+
.\" generated with Ronn/v0.7.0
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.0
|
3
3
|
.
|
4
|
-
.TH "TJ" "1" "
|
4
|
+
.TH "TJ" "1" "December 2015" "" "Theme Juice Manual"
|
5
5
|
.
|
6
6
|
.SH "NAME"
|
7
7
|
\fBtj\fR \- WordPress development made easy
|
@@ -9,26 +9,23 @@
|
|
9
9
|
.SH "SYNOPSIS"
|
10
10
|
\fBtj\fR [\fIcommand\fR] [\-\-flag=\fIarg\fR] [\-\-flag]
|
11
11
|
.
|
12
|
-
.SH "DESCRIPTION"
|
13
|
-
Theme Juice (tj(1)) is a command line utility that allows you to generate, manage and deploy new local WordPress development applications in seconds using vagrant(1), utilizing an apache(7) fork of vvv(7) called vvv\-apache(7) as the virtual machine\.
|
14
|
-
.
|
15
12
|
.SH "GLOBAL OPTIONS"
|
16
13
|
.
|
17
14
|
.TP
|
18
15
|
\fB\-\-vm\-box\fR=\fIrepository\fR
|
19
|
-
Force vagrant(1) box for use as VM
|
16
|
+
Force vagrant(1) box for use as VM*
|
20
17
|
.
|
21
18
|
.TP
|
22
19
|
\fB\-\-vm\-path\fR=\fIpath\fR
|
23
|
-
Force path to VM
|
20
|
+
Force path to VM*
|
24
21
|
.
|
25
22
|
.TP
|
26
23
|
\fB\-\-vm\-ip\fR=\fIip\fR
|
27
|
-
Force IP address of VM
|
24
|
+
Force IP address of VM*
|
28
25
|
.
|
29
26
|
.TP
|
30
27
|
\fB\-\-vm\-prefix\fR=\fIstring\fR
|
31
|
-
Force directory prefix for project in VM
|
28
|
+
Force directory prefix for project in VM*
|
32
29
|
.
|
33
30
|
.TP
|
34
31
|
\fB\-\-yolo\fR
|
@@ -48,15 +45,15 @@ Prints all output without color
|
|
48
45
|
.
|
49
46
|
.TP
|
50
47
|
\fB\-\-no\-animations\fR
|
51
|
-
Prints all output without animations
|
48
|
+
Prints all output without animations**
|
52
49
|
.
|
53
50
|
.TP
|
54
51
|
\fB\-\-no\-landrush\fR
|
55
|
-
Disable the landrush(1) gem for managing DNS
|
52
|
+
Disable the landrush(1) gem for managing DNS*
|
56
53
|
.
|
57
54
|
.TP
|
58
55
|
\fB\-\-no\-port\-forward\fR, \fB\-\-no\-port\-forwarding\fR
|
59
|
-
Disable automatic port forwarding
|
56
|
+
Disable automatic port forwarding*
|
60
57
|
.
|
61
58
|
.TP
|
62
59
|
\fB\-\-verbose\fR
|
@@ -76,18 +73,28 @@ Run a command without actually doing anything
|
|
76
73
|
.
|
77
74
|
.TP
|
78
75
|
\fB\-\-nginx\fR, \fB\-\-no\-apache\fR
|
79
|
-
Create \fBconf\fR files for nginx(7) instead of apache(7)
|
76
|
+
Create \fBconf\fR files for nginx(7) instead of apache(7)*
|
77
|
+
.
|
78
|
+
.P
|
79
|
+
\fB*\fR Flag is only applicable on first create(1) before the VM has been created, unless an new (unused) \fBvm\-path\fR is specified\.
|
80
|
+
.
|
81
|
+
.P
|
82
|
+
\fB**\fR Coming soon (possibly)
|
80
83
|
.
|
81
84
|
.SH "PRIMARY COMMANDS"
|
82
85
|
Run \fBtj help\fR [\fIcommand\fR] to view an individual command\'s man page\.
|
83
86
|
.
|
84
87
|
.TP
|
88
|
+
init(1), \fBup\fR
|
89
|
+
Initialize the VM
|
90
|
+
.
|
91
|
+
.TP
|
85
92
|
create(1), \fBnew\fR, \fBmk\fR
|
86
|
-
Create a new project
|
93
|
+
Create a new project (also runs init(1) if VM is uninitialized)
|
87
94
|
.
|
88
95
|
.TP
|
89
|
-
setup(1)
|
90
|
-
Setup an existing project
|
96
|
+
setup(1)
|
97
|
+
Setup an existing project (alias for create(1) \fB\-\-bare\fR)
|
91
98
|
.
|
92
99
|
.TP
|
93
100
|
delete(1), \fBrm\fR, \fBremove\fR, \fBtrash\fR
|
@@ -95,7 +102,7 @@ Delete a project
|
|
95
102
|
.
|
96
103
|
.TP
|
97
104
|
deploy(1), \fBserver\fR, \fBremote\fR
|
98
|
-
Deploy a project
|
105
|
+
Deploy and manage a project
|
99
106
|
.
|
100
107
|
.SH "SECONDARY COMMANDS"
|
101
108
|
.
|
@@ -112,7 +119,7 @@ List all projects
|
|
112
119
|
Manage development environment via vagrant(1)\. Commands are proxied to your Vagrant installation so that they can be run from any directory\.
|
113
120
|
.
|
114
121
|
.SH "CONFIG COMMANDS"
|
115
|
-
These run the corresponding command from your project\'s config file\. They accept any number of arguments, since the behavior and handling of input is defined within the config file itself\. Below are the commands defined within the
|
122
|
+
These run the corresponding command from your project\'s config file\. They accept any number of arguments, since the behavior and handling of input is defined within the config file itself\. Below are the commands defined within the \fITheme Juice starter template\fR\.
|
116
123
|
.
|
117
124
|
.TP
|
118
125
|
\fBinstall\fR=[\fIarg\fR[,\fIarg\fR]\.\.\.]
|
@@ -147,7 +154,7 @@ Backup project
|
|
147
154
|
Manage and run project tests
|
148
155
|
.
|
149
156
|
.SH "CONFIG FILE"
|
150
|
-
A YAML Juicefile(5) configuration can be used to store commonly\-used build scripts, similar to npm(1) scripts\. Each command block sequence can be mapped to an individual project\'s build tool, allowing a streamlined set of commands to be used across multiple projects that utilize different tools\.
|
157
|
+
A YAML Juicefile(5) configuration can be used to store commonly\-used build scripts (and deploy(1) info), similar to npm(1) scripts\. Each command block sequence can be mapped to an individual project\'s build tool, allowing a streamlined set of commands to be used across multiple projects that utilize different tools\. Below are descriptions for the default commands within the \fITheme Juice starter template\'s\fR \fBJuicefile\fR\.
|
151
158
|
.
|
152
159
|
.TP
|
153
160
|
\fBcommands\fR
|
@@ -203,7 +210,7 @@ When naming your configuration file, use the recommended \fBJuicefile\fR, or \fB
|
|
203
210
|
\fB/^(((\e\.)?(tj)|((J|j)uicefile))(\e\.y(a)?ml)?$)/\fR
|
204
211
|
.
|
205
212
|
.SH "ENVIRONMENT"
|
206
|
-
All of the global options have a corresponding \fBENV\fR variable that can be set to permanently use the specified value each time tj(1) is run\. This is useful if you\'re using an alternate vagrant(1) box, or if you need to disable certain features due to limited support e\.
|
213
|
+
All of the global options have a corresponding \fBENV\fR variable that can be set to permanently use the specified value each time tj(1) is run\. This is useful if you\'re using an alternate vagrant(1) box, or if you need to disable certain features due to limited support i\.e\. on Windows\.
|
207
214
|
.
|
208
215
|
.TP
|
209
216
|
\fBTJ_VM_BOX\fR=\fIrepository\fR
|
@@ -1,7 +1,7 @@
|
|
1
|
-
.\" generated with Ronn/v0.7.
|
2
|
-
.\" http://github.com/rtomayko/ronn/tree/0.7.
|
1
|
+
.\" generated with Ronn/v0.7.0
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.0
|
3
3
|
.
|
4
|
-
.TH "TJ\-CREATE" "1" "
|
4
|
+
.TH "TJ\-CREATE" "1" "December 2015" "" "Theme Juice Manual"
|
5
5
|
.
|
6
6
|
.SH "NAME"
|
7
7
|
\fBtj\-create\fR \- Create a new project
|
@@ -10,7 +10,41 @@
|
|
10
10
|
\fBtj create\fR [\-\-flag=\fIarg\fR] [\-\-flag]
|
11
11
|
.
|
12
12
|
.SH "DESCRIPTION"
|
13
|
-
Creates a new project\. It will lead you through a series of prompts to set up required project information, such as name, location, template, database info, etc\. Using the specified information, it will run the installation process
|
13
|
+
Creates a new project\. It will lead you through a series of prompts to set up required project information, such as name, location, template, database info, etc\. Using the specified information, it will run the installation process below\.
|
14
|
+
.
|
15
|
+
.IP "1." 4
|
16
|
+
\fBtj\fR will execute init(1) if the VM is uninitialized
|
17
|
+
.
|
18
|
+
.IP "2." 4
|
19
|
+
\fBtj\fR will clone the selected starter template
|
20
|
+
.
|
21
|
+
.IP "3." 4
|
22
|
+
\fBtj\fR will run the starter template\'s Juicefile(1) \fBinstall\fR command
|
23
|
+
.
|
24
|
+
.IP "4." 4
|
25
|
+
.
|
26
|
+
.IP "\(bu" 4
|
27
|
+
\fBCustomfile\fR containing DNS and synced folder settings
|
28
|
+
.
|
29
|
+
.IP "\(bu" 4
|
30
|
+
\fBinit\-custom\.sql\fR containing database setup
|
31
|
+
.
|
32
|
+
.IP "\(bu" 4
|
33
|
+
\fBproject\.conf\fR containing server settings
|
34
|
+
.
|
35
|
+
.IP "\(bu" 4
|
36
|
+
\fBwp\-cli\.local\.yml\fR containing VM paths
|
37
|
+
.
|
38
|
+
.IP "" 0
|
39
|
+
|
40
|
+
.
|
41
|
+
.IP "5." 4
|
42
|
+
\fBtj\fR will provision the VM to put the new configuration into effect
|
43
|
+
.
|
44
|
+
.IP "" 0
|
45
|
+
.
|
46
|
+
.P
|
47
|
+
If you\'ve never used \fBtj\fR before (meaning, this is your first create(1)), then that last step might take awhile\. After that\'s done, you should be able to access your new project at the specified url\. It\'s that easy!
|
14
48
|
.
|
15
49
|
.SH "GLOBAL OPTIONS"
|
16
50
|
.
|
@@ -12,9 +12,34 @@ DESCRIPTION
|
|
12
12
|
Creates a new project. It will lead you through a series of prompts to
|
13
13
|
set up required project information, such as name, location, template,
|
14
14
|
database info, etc. Using the specified information, it will run the
|
15
|
-
installation process
|
16
|
-
|
17
|
-
|
15
|
+
installation process below.
|
16
|
+
|
17
|
+
1. tj will execute init(1) if the VM is uninitialized
|
18
|
+
|
19
|
+
2. tj will clone the selected starter template
|
20
|
+
|
21
|
+
3. tj will run the starter template's Juicefile(1) install command
|
22
|
+
|
23
|
+
4.
|
24
|
+
|
25
|
+
o Customfile containing DNS and synced folder settings
|
26
|
+
|
27
|
+
o init-custom.sql containing database setup
|
28
|
+
|
29
|
+
o project.conf containing server settings
|
30
|
+
|
31
|
+
o wp-cli.local.yml containing VM paths
|
32
|
+
|
33
|
+
|
34
|
+
|
35
|
+
|
36
|
+
5. tj will provision the VM to put the new configuration into effect
|
37
|
+
|
38
|
+
|
39
|
+
|
40
|
+
If you've never used tj before (meaning, this is your first create(1)),
|
41
|
+
then that last step might take awhile. After that's done, you should be
|
42
|
+
able to access your new project at the specified url. It's that easy!
|
18
43
|
|
19
44
|
GLOBAL OPTIONS
|
20
45
|
-n, --name=string
|
@@ -56,4 +81,4 @@ GLOBAL OPTIONS
|
|
56
81
|
|
57
82
|
|
58
83
|
|
59
|
-
|
84
|
+
December 2015 TJ-CREATE(1)
|
@@ -1,7 +1,7 @@
|
|
1
|
-
.\" generated with Ronn/v0.7.
|
2
|
-
.\" http://github.com/rtomayko/ronn/tree/0.7.
|
1
|
+
.\" generated with Ronn/v0.7.0
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.0
|
3
3
|
.
|
4
|
-
.TH "TJ\-DELETE" "1" "
|
4
|
+
.TH "TJ\-DELETE" "1" "December 2015" "" "Theme Juice Manual"
|
5
5
|
.
|
6
6
|
.SH "NAME"
|
7
7
|
\fBtj\-delete\fR \- Delete a project
|
@@ -10,10 +10,10 @@
|
|
10
10
|
\fBtj delete\fR [\-\-flag=\fIarg\fR] [\-\-flag]
|
11
11
|
.
|
12
12
|
.SH "DESCRIPTION"
|
13
|
-
Removes a project from your development environment\. You will go through a series of prompts to delete a project\. This will only remove files that were generated by tj(1)
|
13
|
+
Removes a project from your development environment\. You will go through a series of prompts to delete a project\. This will only remove files that were generated by tj(1) e\.g\. the database setup, DNS setup, and other project configuration files\.
|
14
14
|
.
|
15
15
|
.P
|
16
|
-
|
16
|
+
\fIIt will not touch your local folders that were synced to the VM\fR\.
|
17
17
|
.
|
18
18
|
.SH "GLOBAL OPTIONS"
|
19
19
|
.
|
@@ -11,7 +11,7 @@ SYNOPSIS
|
|
11
11
|
DESCRIPTION
|
12
12
|
Removes a project from your development environment. You will go
|
13
13
|
through a series of prompts to delete a project. This will only remove
|
14
|
-
files that were generated by tj(1)
|
14
|
+
files that were generated by tj(1) e.g. the database setup, DNS setup,
|
15
15
|
and other project configuration files.
|
16
16
|
|
17
17
|
It will not touch your local folders that were synced to the VM.
|
@@ -32,4 +32,4 @@ GLOBAL OPTIONS
|
|
32
32
|
|
33
33
|
|
34
34
|
|
35
|
-
|
35
|
+
December 2015 TJ-DELETE(1)
|
@@ -1,7 +1,7 @@
|
|
1
|
-
.\" generated with Ronn/v0.7.
|
2
|
-
.\" http://github.com/rtomayko/ronn/tree/0.7.
|
1
|
+
.\" generated with Ronn/v0.7.0
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.0
|
3
3
|
.
|
4
|
-
.TH "TJ\-DEPLOY" "1" "
|
4
|
+
.TH "TJ\-DEPLOY" "1" "December 2015" "" "Theme Juice Manual"
|
5
5
|
.
|
6
6
|
.SH "NAME"
|
7
7
|
\fBtj\-deploy\fR \- Deploy a project
|
@@ -22,15 +22,12 @@ Create a \fBdeploy\fR user on the \fBstage\fR server
|
|
22
22
|
Create SSH keys for the new \fBdeploy\fR user
|
23
23
|
.
|
24
24
|
.IP "3." 4
|
25
|
-
|
25
|
+
Confirm the \fBdeploy\fR user owns the deploy path
|
26
26
|
.
|
27
27
|
.IP "4." 4
|
28
|
-
|
28
|
+
Run \fBtj deploy <stage> setup\fR to setup the required directories
|
29
29
|
.
|
30
30
|
.IP "5." 4
|
31
|
-
Run \fBtj deploy <stage> setup\fR to setup the initial shared and releases directories
|
32
|
-
.
|
33
|
-
.IP "6." 4
|
34
31
|
Deploy!
|
35
32
|
.
|
36
33
|
.IP "" 0
|
@@ -39,7 +36,7 @@ Deploy!
|
|
39
36
|
.
|
40
37
|
.TP
|
41
38
|
\fB\-\-archive\fR, \fB\-\-tar\fR, \fB\-\-gzip\fR, \fB\-\-zip\fR
|
42
|
-
Archive directories when performing file transfers
|
39
|
+
Archive directories with tar(1) when performing file transfers
|
43
40
|
.
|
44
41
|
.SH "PRIMARY COMMANDS"
|
45
42
|
If no command is passed, the default task to be executed is \fBdeploy\fR
|
@@ -19,21 +19,17 @@ SETUP
|
|
19
19
|
|
20
20
|
2. Create SSH keys for the new deploy user
|
21
21
|
|
22
|
-
3.
|
23
|
-
tory
|
22
|
+
3. Confirm the deploy user owns the deploy path
|
24
23
|
|
25
|
-
4.
|
24
|
+
4. Run tj deploy <stage> setup to setup the required directories
|
26
25
|
|
27
|
-
5.
|
28
|
-
releases directories
|
29
|
-
|
30
|
-
6. Deploy!
|
26
|
+
5. Deploy!
|
31
27
|
|
32
28
|
|
33
29
|
|
34
30
|
GLOBAL OPTIONS
|
35
31
|
--archive, --tar, --gzip, --zip
|
36
|
-
Archive directories when performing file transfers
|
32
|
+
Archive directories with tar(1) when performing file transfers
|
37
33
|
|
38
34
|
PRIMARY COMMANDS
|
39
35
|
If no command is passed, the default task to be executed is deploy
|
@@ -181,4 +177,4 @@ CONFIG FILE
|
|
181
177
|
|
182
178
|
|
183
179
|
|
184
|
-
|
180
|
+
December 2015 TJ-DEPLOY(1)
|
@@ -1,7 +1,7 @@
|
|
1
|
-
.\" generated with Ronn/v0.7.
|
2
|
-
.\" http://github.com/rtomayko/ronn/tree/0.7.
|
1
|
+
.\" generated with Ronn/v0.7.0
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.0
|
3
3
|
.
|
4
|
-
.TH "TJ\-SETUP" "1" "
|
4
|
+
.TH "TJ\-SETUP" "1" "December 2015" "" "Theme Juice Manual"
|
5
5
|
.
|
6
6
|
.SH "NAME"
|
7
7
|
\fBtj\-setup\fR \- Setup an existing project
|
data/lib/theme-juice/man/tj.txt
CHANGED
@@ -8,26 +8,20 @@ NAME
|
|
8
8
|
SYNOPSIS
|
9
9
|
tj [command] [--flag=arg] [--flag]
|
10
10
|
|
11
|
-
DESCRIPTION
|
12
|
-
Theme Juice (tj(1)) is a command line utility that allows you to gener-
|
13
|
-
ate, manage and deploy new local WordPress development applications in
|
14
|
-
seconds using vagrant(1), utilizing an apache(7) fork of vvv(7) called
|
15
|
-
vvv-apache(7) as the virtual machine.
|
16
|
-
|
17
11
|
GLOBAL OPTIONS
|
18
12
|
--vm-box=repository
|
19
|
-
Force vagrant(1) box for use as VM
|
13
|
+
Force vagrant(1) box for use as VM*
|
20
14
|
|
21
15
|
--vm-path=path
|
22
|
-
Force path to VM
|
16
|
+
Force path to VM*
|
23
17
|
|
24
18
|
--vm-ip=ip
|
25
|
-
Force IP address of VM
|
19
|
+
Force IP address of VM*
|
26
20
|
|
27
21
|
--vm-prefix=string
|
28
|
-
Force directory prefix for project in VM
|
22
|
+
Force directory prefix for project in VM*
|
29
23
|
|
30
|
-
--yolo Say
|
24
|
+
--yolo Say yes to anything and everything, and maybe even get a few
|
31
25
|
surprises
|
32
26
|
|
33
27
|
--boring
|
@@ -40,13 +34,13 @@ GLOBAL OPTIONS
|
|
40
34
|
Prints all output without color
|
41
35
|
|
42
36
|
--no-animations
|
43
|
-
Prints all output without animations
|
37
|
+
Prints all output without animations**
|
44
38
|
|
45
39
|
--no-landrush
|
46
|
-
Disable the landrush(1) gem for managing DNS
|
40
|
+
Disable the landrush(1) gem for managing DNS*
|
47
41
|
|
48
42
|
--no-port-forward, --no-port-forwarding
|
49
|
-
Disable automatic port forwarding
|
43
|
+
Disable automatic port forwarding*
|
50
44
|
|
51
45
|
--verbose
|
52
46
|
Prints out additional logging information
|
@@ -61,22 +55,30 @@ GLOBAL OPTIONS
|
|
61
55
|
Run a command without actually doing anything
|
62
56
|
|
63
57
|
--nginx, --no-apache
|
64
|
-
Create conf files for nginx(7) instead of apache(7)
|
58
|
+
Create conf files for nginx(7) instead of apache(7)*
|
59
|
+
|
60
|
+
* Flag is only applicable on first create(1) before the VM has been
|
61
|
+
created, unless an new (unused) vm-path is specified.
|
62
|
+
|
63
|
+
** Coming soon (possibly)
|
65
64
|
|
66
65
|
PRIMARY COMMANDS
|
67
66
|
Run tj help [command] to view an individual command's man page.
|
68
67
|
|
68
|
+
init(1), up
|
69
|
+
Initialize the VM
|
70
|
+
|
69
71
|
create(1), new, mk
|
70
|
-
Create a new project
|
72
|
+
Create a new project (also runs init(1) if VM is uninitialized)
|
71
73
|
|
72
|
-
setup(1)
|
73
|
-
Setup an existing project
|
74
|
+
setup(1)
|
75
|
+
Setup an existing project (alias for create(1) --bare)
|
74
76
|
|
75
77
|
delete(1), rm, remove, trash
|
76
78
|
Delete a project
|
77
79
|
|
78
80
|
deploy(1), server, remote
|
79
|
-
Deploy a project
|
81
|
+
Deploy and manage a project
|
80
82
|
|
81
83
|
SECONDARY COMMANDS
|
82
84
|
version, --version, -v
|
@@ -122,10 +124,11 @@ CONFIG COMMANDS
|
|
122
124
|
|
123
125
|
CONFIG FILE
|
124
126
|
A YAML Juicefile(5) configuration can be used to store commonly-used
|
125
|
-
build scripts,
|
126
|
-
can be mapped to an individual
|
127
|
-
|
128
|
-
different tools.
|
127
|
+
build scripts (and deploy(1) info), similar to npm(1) scripts. Each
|
128
|
+
command block sequence can be mapped to an individual project's build
|
129
|
+
tool, allowing a streamlined set of commands to be used across multiple
|
130
|
+
projects that utilize different tools. Below are descriptions for the
|
131
|
+
default commands within the Theme Juice starter template's Juicefile.
|
129
132
|
|
130
133
|
commands
|
131
134
|
Collection of various command block sequences
|
@@ -154,7 +157,7 @@ CONFIG FILE
|
|
154
157
|
commands.test
|
155
158
|
Command used to manage and run project tests
|
156
159
|
|
157
|
-
Placeholder
|
160
|
+
Placeholder arguments can be used within any command block sequence to
|
158
161
|
allow splat or indexed arguments to be passed to the corresponding com-
|
159
162
|
mand when executed.
|
160
163
|
|
@@ -164,8 +167,8 @@ CONFIG FILE
|
|
164
167
|
%argN%, %argumentN%
|
165
168
|
Where n is the argument index e.g. cmd %arg1% | cmd %arg2%
|
166
169
|
|
167
|
-
When
|
168
|
-
.tj.yaml
|
170
|
+
When naming your configuration file, use the recommended Juicefile, or
|
171
|
+
.tj.yaml naming convention. The raw filename regex matcher is below if
|
169
172
|
you want to be a little different.
|
170
173
|
|
171
174
|
/^(((\.)?(tj)|((J|j)uicefile))(\.y(a)?ml)?$)/
|
@@ -173,8 +176,8 @@ CONFIG FILE
|
|
173
176
|
ENVIRONMENT
|
174
177
|
All of the global options have a corresponding ENV variable that can be
|
175
178
|
set to permanently use the specified value each time tj(1) is run. This
|
176
|
-
is
|
177
|
-
to disable certain features due to limited support e.
|
179
|
+
is useful if you're using an alternate vagrant(1) box, or if you need
|
180
|
+
to disable certain features due to limited support i.e. on Windows.
|
178
181
|
|
179
182
|
TJ_VM_BOX=repository
|
180
183
|
Force vagrant(1) box for use as VM
|
@@ -189,7 +192,7 @@ ENVIRONMENT
|
|
189
192
|
Force directory prefix for project in VM
|
190
193
|
|
191
194
|
TJ_YOLO=bool
|
192
|
-
Say
|
195
|
+
Say yes to anything and everything, and maybe even get a few
|
193
196
|
surprises
|
194
197
|
|
195
198
|
TJ_BORING=bool
|
@@ -228,4 +231,4 @@ ENVIRONMENT
|
|
228
231
|
|
229
232
|
|
230
233
|
|
231
|
-
|
234
|
+
December 2015 TJ(1)
|