Emily CLI Documentation

Release-v3.0.6

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@v3.0.6
See earlier versions
$ emily doctor [options]

Check and fix system issues with Emily. Valid requirements for (--fix): vscode | remote-extension | python-extension | pycharm docker | wsl-kernel-update|hyper-v-on-startup| kubectl

$ 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.

Running Emily Doctor

Emily doctor will check whether your system is ready to use Emily or not. For example, Emily requires Docker to be installed and setup - if you do not have it on your system, Emily can intall it for you. To run the doctor command, enter emily doctor in the terminal and select from a list of missing requirements.

You can provide a list of requirements that you wish to have fixed using the --fix flag. This flag can also be negated, specifying the arguments that you wish to not fix (--no-fix)

$ emily doctor
$ emily doctor
--fix docker

$ emily doctor
--no-fix kubectl

$ emily doctor
--restart

$ emily doctor
--no-restart


    Options

  • -h,--help

    Display help for command

  • -f,--fix[...requirements](--no-fix)

    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.

  • -o,--optional(--no-optional)

    Whether to include optional requirements. (default: true)

  • -rs,--restart(--no-restart)

    Automatically restart when required by installations.

  • -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.