Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 50 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,53 @@ chmod +x /usr/local/bin/ee

## Usage

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.
## Basic Commands

### create
Runs the site creation.

```bash
ee site create example.com --wp # install wordpress without any page caching
ee site create example.com --wpredis # install wordpress + redis caching
ee site create example.com --wpsubir # install wpmu-subdirectory without any page caching
ee site create example.com --wpsubir --wpredis # install wpmu-subdirectory + redis caching
ee site create example.com --wpsubdom # install wpmu-subdomain without any page caching
ee site create example.com --wpsubdom --wpredis # install wpmu-subdomain + redis caching
```

### delete
Deletes an existing EasyEngine site.

```bash
ee site delete example.com
```

### disable
Disables a website. It will stop and remove the docker containers of the website if they are running.

```bash
ee site disable example.com
```

### enable
Enables a website. It will start the docker containers of the website if they are stopped.

```bash
ee site enable example.com
```

### info
Display all the relevant site information, credentials and useful links.

```bash
ee site info example.com
```

### list
Lists the created websites.

```bash
ee site list
```

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.