Emily CLI Documentation

Release-v3.1.0

Emily combines the powers of Python and Docker to build stable and consistent machine learning and datascience python environments. Emily is useful for large cross-team project development as well as for simply running a single jupyter notebook or python script.

Download emily@latest
See earlier versions
buildopenenvironmentconfigurationserversdeploymentdeploylistmountunmountstopdroploginlogoutdoctorupdatewhoamiloguninstallinstall
addremove
composekubernetes
externalnginxgpu
$ emily configuration add compose [options]

Add a basic Docker Compose configuration to your project.

$ emily configuration add compose

? Emily: Choose a project:(Use arrow keys, confirm with ENTER) … > M9VHKD - my-project
AB82JD - movie-recommender · M9VHKD - my-project
? Emily: Please select a configuration:(Use arrow keys, confirm with ENTER) …
dev> staging
+ Add new configuration · staging
? Emily: Please choose a Docker Compose configuration:(Use arrow keys, confirm with ENTER) … > Base
GPU
HTTPS reverse proxy (Nginx)
External network · Base
Emily: Compose configuration "staging" added to project
my-project (M9VHKD)

Created:

- /my/projects/my-project/staging/docker-compose.emily.yml

Docker Compose base configuration

The emily configuration add compose command adds the base Docker Compose configuration to your project. The prompt for Docker Compose configuration type, pass --silent to the command.

The base configuration is the basic docker-compose.emily.yml that Emily automatically creates when building a project.

It specifies the following:

  1. Host/container port mapping
  2. Location of the Dockerfile and build context
  3. Provisions the auto-generated .env file to the project container
  4. Project-specific network
version: "3"

services:
  emily-my-project-m9vhkd:

    image: emily-my-project-m9vhkd
    container_name: emily-my-project-m9vhkd

    build:
      context: ../../
      dockerfile: ./Dockerfile

    env_file:
      - ./.env
    
    ports:
      - ${HOST_PORT}:${CONTAINER_PORT}

    networks:
      - emily-my-project-m9vhkd-network

networks:
  emily-my-project-m9vhkd-network:
    driver: bridge
    name: emily-my-project-m9vhkd-network

    Options

  • -h,--help

    Display help for command

  • -n,--name<name>

    The name of the configuration

  • -i,--image<image>

    Image to use for the base configurations. Only necessary for the "compose" and "kubernetes" subcommands.

  • -g,--gpu

    Whether a GPU is needed for the base configuration Dockerfiles. Only necessary for the "compose" and "kubernetes" subcommands.

  • -p,--project<project>

    The project to manage configurations for.

  • -s,--silent

    Execute Emily silently. (default: false)

  • -u,--update(--no-update)

    Prompt for update if newer version found. (default: true)

  • -vb,--verbose

    Print detailed information while running commands.