Quick start

Installing on Linux

Installing on Windows

Installing on macOS

Installing Emily

Install requirements

Emily CLI tool 

	For documentation see https://emily.ambolt.io/docs 
	

emily

Prompt for update if newer version found.

Print detailed information while running commands.

build

The directory in which to create the project.

The host address to listen for requests on.

Automatically start Docker container and open in editor.

The editor to use [vscode | pycharm | notebook | lab].

Enable GPU capabilities within the container.

Detached mode: Run container in the background. Requires manual shutdown.

Emily project ID, project name, or project path.

project

Open a directory or an existing Emily project by its name or ID.

open

Import the folder without opening project.

Mount mappings to use when importing a project where the local deployment specification contains existing mount mappings. Mount mappings are specified in the format <SOURCE>:<DESTINATION>, e.g. ./data/train:/workspace/data/train.

The editor to use [pycharm | vscode | notebook | lab].

environment

Partially update your environment variables.
All options will take the current environment
as their default value unless explicitly specified.

update

Remove existing environments from a project.

remove

configuration

The project to manage configurations for.

servers

Manage deployment specifications for your projects.

deployment

The project to manage deployment specifications for.

Add a deployment specification to your project.

deploy

Temporarily override the environment used in the deployment specification

Temporarily override the configuration used in the deployment specification

(Kubernetes (non-Azure) deployments only) The password for the Docker user specified in the deployment specification.

The access token to use for authentication

The email address for the Emily user related to the access token if provided (only required when --access-token is passed)

Tag for the project image when pushing to the container registry.

list

Emily project ID, project name or project path.

Mount a directory from the host into an Emily container.

mount

Project deployment to create a mount mapping for.

Unmount a directory volume from Emily project container.

unmount

Target directories in container to unmount.

Stop the running docker container of your project.

stop

Emily project IDs, project names, or project paths.

projects

Drop (but keep files for) one or more Emily projects, pruning Docker for the projects's
containers, networks, and images, and removing them from [38;2;110;193;228m[1memily list[22m[39m.
Dropped projects can still be opened through Emily.
Project files will remain untouched unless the --delete-files flag is passed.

drop

Delete the project files (cannot be undone).

Stop the container if it is currently running.

login

logout

doctor

Whether (or not with --no-fix) to fix any missing requirements.
                                              If a list of requirement flags are provided, only those requirements will be fixed.

Whether to include optional requirements.

Automatically restart when required by installations.

Updates your Emily CLI to the newest version.

Version of the binary (must be provided with --binary).

whoami

status

Control whether or not to send anonymous usage data to the Emily team [on | off].

Emily Guides