Skip to content

Commit c61188a

Browse files
Merge pull request #1065 from mbtamuli/update_readme
Add command examples to README
2 parents 1553dde + dd60036 commit c61188a

File tree

1 file changed

+50
-1
lines changed

1 file changed

+50
-1
lines changed

README.md

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,53 @@ chmod +x /usr/local/bin/ee
2828

2929
## Usage
3030

31-
EasyEngine will currently only run with root privileges. You can run `ee help` or `ee help site` to get all the details about the various commands and subcommands that you can run.
31+
## Basic Commands
32+
33+
### create
34+
Runs the site creation.
35+
36+
```bash
37+
ee site create example.com --wp # install wordpress without any page caching
38+
ee site create example.com --wpredis # install wordpress + redis caching
39+
ee site create example.com --wpsubir # install wpmu-subdirectory without any page caching
40+
ee site create example.com --wpsubir --wpredis # install wpmu-subdirectory + redis caching
41+
ee site create example.com --wpsubdom # install wpmu-subdomain without any page caching
42+
ee site create example.com --wpsubdom --wpredis # install wpmu-subdomain + redis caching
43+
```
44+
45+
### delete
46+
Deletes an existing EasyEngine site.
47+
48+
```bash
49+
ee site delete example.com
50+
```
51+
52+
### disable
53+
Disables a website. It will stop and remove the docker containers of the website if they are running.
54+
55+
```bash
56+
ee site disable example.com
57+
```
58+
59+
### enable
60+
Enables a website. It will start the docker containers of the website if they are stopped.
61+
62+
```bash
63+
ee site enable example.com
64+
```
65+
66+
### info
67+
Display all the relevant site information, credentials and useful links.
68+
69+
```bash
70+
ee site info example.com
71+
```
72+
73+
### list
74+
Lists the created websites.
75+
76+
```bash
77+
ee site list
78+
```
79+
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.

0 commit comments

Comments
 (0)