Quick start

Linux

Windows

Install

Install Requirements

Environment files

Guides

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.

whoami

status

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

telemetry

build

The directory in which to create the project.

The Emily template to use [ml-api | api | default | ml-grpc | dnn-api].

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

Source mount paths used if the project is imported.

Import the folder without opening project.

Change host address to listen for requests on.

Change host port to listen for requests on.

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

list

Emily project ID, project name or project path

mount

Target directory in container. Source is mounted to /workspace/<target or source> unless an absolute path is provided.

Emily project ID, project name or project path.

Unmount a directory volume from Emily project container.

unmount

Container mount targets you wish to unmount.

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.

deploy

Deploy Emily project to a Kubernetes cluster.
      
In order to use this command, you must have
    1) a Docker hub account with a repository where the project image will be hosted,
    2) a running Kubernetes cluster where the Kubernetes service can be deployed, and
    3) connected kubectl to your Kubernetes cluster.

kubernetes

server

servers

remove

Updates your Emily CLI to the newest version.

update

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

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 emily list.
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.

Print the log of the last command execution.

Stop the running docker container of your project.

stop

uninstall

Name of the environment you want to configure.

environment-name

View and modify the configuration of a project.
To view the configuration of a project, run emily config <project>.
To view the configuration of a project environment, run emily config <project> <environment name>.
To change the configuration of a project environment, run emily config <project> <environment> <option> <value>
where <option> is one of the options listed below, and <value> might be optional depending on the chosen <option>.

config

The number of worker processes to run in parallel.

Run on server with GPU and NVIDIA CUDA support.

Server directory to transfer files to (default: /home/<SERVER USER>/<PROJECT NAME>).

Bash script to run on the server after transferring files.

Emily CLI Documentation

Running Emily

Options