Skip to content

Commit 9ac73b2

Browse files
committed
Merge branch 'kirtangajjar-update-readme-b2' into develop-v4
2 parents d6dd827 + 23d992d commit 9ac73b2

File tree

1 file changed

+101
-10
lines changed

1 file changed

+101
-10
lines changed

README.md

Lines changed: 101 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,29 @@ chmod +x /usr/local/bin/ee
2929
## Usage
3030

3131
## Basic Commands
32-
33-
### create
32+
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
3455
Runs the site creation.
3556

3657
```bash
@@ -42,47 +63,117 @@ ee site create example.com --wpsubdom # install wpmu-subdomain without
4263
ee site create example.com --wpsubdom --wpredis # install wpmu-subdomain + redis caching
4364
```
4465

45-
### delete
66+
#### ee site delete
4667
Deletes an existing EasyEngine site.
4768

4869
```bash
4970
ee site delete example.com
5071
```
5172

52-
### disable
73+
#### ee site disable
5374
Disables a website. It will stop and remove the docker containers of the website if they are running.
5475

5576
```bash
5677
ee site disable example.com
5778
```
5879

59-
### enable
80+
#### ee site enable
6081
Enables a website. It will start the docker containers of the website if they are stopped.
6182

6283
```bash
6384
ee site enable example.com
6485
```
6586

66-
### info
87+
#### ee site info
6788
Display all the relevant site information, credentials and useful links.
6889

6990
```bash
7091
ee site info example.com
7192
```
7293

73-
### list
94+
#### ee site list
7495
Lists the created websites.
7596

7697
```bash
7798
ee site list
7899
```
79100

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.
81119

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.
82127

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
84175

85176
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
86177
```
87178
vendor/bin/behat
88-
```
179+
```

0 commit comments

Comments
 (0)