You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently there are three top level commands of `ee`.
33
+
*[ee site](#ee-site)
34
+
*[ee shell](#ee-shell)
35
+
*[ee cli](#ee-cli)
36
+
37
+
Note: :warning: EasyEngine will currently only run with root privileges. You can run `ee help`, `ee help site` and `ee help site create` to get all the details about the various commands and subcommands that you can run.
38
+
39
+
### ee site
40
+
Contains basic site management commands
41
+
42
+
`site` command contains following subcommand
43
+
*[ee site create](#ee-site-create)
44
+
*[ee site delete](#ee-site-delete)
45
+
*[ee site disable](#ee-site-disable)
46
+
*[ee site enable](#ee-site-enable)
47
+
*[ee site info](#ee-site-info)
48
+
*[ee site list](#ee-site-list)
49
+
*[ee site start](#ee-site-start)
50
+
*[ee site stop](#ee-site-stop)
51
+
*[ee site restart](#ee-site-restart)
52
+
*[ee site reload](#ee-site-reload)
53
+
54
+
#### ee site create
34
55
Runs the site creation.
35
56
36
57
```bash
@@ -42,47 +63,117 @@ ee site create example.com --wpsubdom # install wpmu-subdomain without
42
63
ee site create example.com --wpsubdom --wpredis # install wpmu-subdomain + redis caching
43
64
```
44
65
45
-
### delete
66
+
#### ee site delete
46
67
Deletes an existing EasyEngine site.
47
68
48
69
```bash
49
70
ee site delete example.com
50
71
```
51
72
52
-
### disable
73
+
#### ee site disable
53
74
Disables a website. It will stop and remove the docker containers of the website if they are running.
54
75
55
76
```bash
56
77
ee site disable example.com
57
78
```
58
79
59
-
### enable
80
+
#### ee site enable
60
81
Enables a website. It will start the docker containers of the website if they are stopped.
61
82
62
83
```bash
63
84
ee site enable example.com
64
85
```
65
86
66
-
### info
87
+
#### ee site info
67
88
Display all the relevant site information, credentials and useful links.
68
89
69
90
```bash
70
91
ee site info example.com
71
92
```
72
93
73
-
### list
94
+
#### ee site list
74
95
Lists the created websites.
75
96
76
97
```bash
77
98
ee site list
78
99
```
79
100
80
-
EasyEngine will currently only run with root privileges. You can run `ee help`, `ee help site` and `ee help site create` to get all the details about the various commands and subcommands that you can run.
101
+
#### ee site start
102
+
Starts containers associated with site.
103
+
104
+
```bash
105
+
ee site start example.com
106
+
ee site start example.com --nginx
107
+
```
108
+
109
+
#### ee site stop
110
+
Stops containers associated with site.
111
+
112
+
```bash
113
+
ee site stop example.com
114
+
ee site stop example.com --nginx
115
+
```
116
+
117
+
#### ee site restart
118
+
Restarts containers associated with site.
81
119
120
+
```bash
121
+
ee site restart example.com
122
+
ee site restart example.com --nginx
123
+
```
124
+
125
+
#### ee site reload
126
+
Reload services in containers without restarting container(s) associated with site.
82
127
83
-
## Test
128
+
```bash
129
+
ee site reload example.com
130
+
ee site reload example.com --nginx
131
+
```
132
+
133
+
### ee shell
134
+
Gives you a shell where you can manage and interact with your site.
135
+
136
+
```bash
137
+
ee shell example.com
138
+
```
139
+
140
+
### ee cli
141
+
Commands to manage easyengine itself
142
+
143
+
`cli` command has following subcommands:
144
+
*[ee cli info](#ee-cli-info)
145
+
*[ee cli update](#ee-cli-update)
146
+
*[ee cli version](#ee-cli-version)
147
+
*[ee cli has-command](#ee-cli-has-command)
148
+
149
+
#### ee cli info
150
+
Print various details about the EE environment.
151
+
152
+
```bash
153
+
ee cli info
154
+
```
155
+
#### ee cli update
156
+
Updates EasyEngine to the latest release.
157
+
158
+
```bash
159
+
ee cli update
160
+
```
161
+
#### ee cli version
162
+
Print EasyEngine version.
163
+
164
+
```bash
165
+
ee cli version
166
+
```
167
+
#### ee cli has-command
168
+
Detects if a command exists
169
+
170
+
```bash
171
+
ee cli has-command site
172
+
```
173
+
174
+
## Tests
84
175
85
176
EasyEngine is currently using [behat](http://behat.org/) v3.4.x functional tests. The tests for site-command are inside the `features/` directory in the core repository and can be run using
0 commit comments