Configuring Emily

Installing Emily Building your first project

Although Emily tries to stay as much out of the way of your local system as possible, Emily needs some fundamental configuration to work properly.

Fortunately, Emily can configure your system automatically by installing the required packages with the emily doctor command.

After installing Emily, run the emily doctor command. Select the configuration items to fix from the selection list with SPACE and confirm the selection by pressing ENTER.

$ emily doctor
Emily: Running emily doctor...
Checking your system please stand by...Emily: All required features fixed!
- Docker ✔


- WSL Kernel update ✔


- Enable Hyper V on startup ✔

Emily: Missing 1 optional feature(s). Some requirements might


require the terminal to be restarted before they are


detected correctly

- Visual Studio Code ✔


- Remote Development Extension ✔


- Python Extension ✔

- PyCharm Professional ×
? Emily: I can fix the issues for you. Continue?(Y/n) · Yes
Emily: Downloading PyCharm Professional 2021.2 ...Emily: Finished installing requirements on your machine.

When all required configurations are fixed, Emily is ready to go.

Required and optional configurations

For all operating systems, Emily requires that Docker (and Docker Compose) is installed. For Docker to work properly on Windows, this further requires the installation and setup of Windows Subsystem for Linux (WSL), as well as Hyper-V being enabled.

Emily can fix all of these automatically - simply choose the items from the selection list with SPACE and confirm the selection by pressing ENTER.

Alternatively, you can fix selected configurations using the --fix flag:

$ emily doctor


--fix docker docker-compose

If no arguments are provided to --fix, all missing configurations will be fixed automatically.

The full list of configuration flags is:

Configuration	Flag	Windows	macOS	Linux	Required
Install Docker	`docker`	✅	✅	✅	✅
Install Docker Compose	`docker-compose`	✅	✅	✅	✅
Install Visual Studio Code	`vscode`	✅	✅	✅
Install Remote Development Extension for VS Code	`remote-extension`	✅	✅	✅
Install Python Extension for VS Code	`python-extension`	✅	✅	✅
Install PyCharm Professional	`pycharm`	✅	✅	✅
Install Kubernetes Command-Line Tool	`kubectl`	✅	✅	✅
Update WSL Kernel	`wsl-kernel-update`	✅			✅
Enable Hyper V on startup	`hyper-v-on-startup`	✅			✅
Install Xcode Developer Tools	`xcode-select`		✅		✅
Ensure non-Snap Docker installation	`docker-snap`			✅	✅
Ensure Docker has root privileges	`docker-permissions`			✅	✅
Install appropriate Nvidia Driver	`nvidia-driver`			✅
Install Nvidia Docker	`nvidia-docker`			✅

If you don't want to fix anything but just need a status report, run emily doctor --no-fix.

Installing Emily Building your first project