Projects

Follow these steps to make the CLI use custom Docker images when running the LEAN engine or the research environment:

1. Open a terminal.
2. Run lean config set engine-image <value>, where <value> is the full name of your Docker image containing the LEAN engine (example: quantconnect/lean:latest).

   $ lean config set engine-image quantconnect/lean:latest
   Successfully updated the value of 'engine-image' to 'quantconnect/lean:latest'
   

3. Run lean config set research-image <value>, where <value> is the full name of your Docker image containing the research environment (example: quantconnect/research:latest).

   $ lean config set research-image quantconnect/research:latest
   Successfully updated the value of 'research-image' to 'quantconnect/research:latest'
   

Follow these steps to revert the CLI to using the default Docker images when running the LEAN engine or the research environment:

1. Open a terminal.
2. Run lean config unset engine-image to configure the CLI to use the default engine image instead of a custom one.

   $ lean config unset engine-image
   Successfully unset 'engine-image'
   

3. Run lean config unset research-image to configure the CLI to use the default research image instead of a custom one.

   $ lean config unset research-image
   Successfully unset 'research-image'
   

Follow these steps to build custom LEAN Docker images using the CLI:

1. Create a new directory that will hold the LEAN repository.
2. Clone the QuantConnect / Lean GitHub repository using git or download and extract the latest master branch archive. Save this repository to a directory called Lean in the directory created in step 1.
3. Make your changes to LEAN.
4. Open a terminal in the directory created in step 1.
5. Run lean build to build the foundation image, compile LEAN, build the engine image, and build the research image.

   $ lean build
   Building 'lean-cli/foundation:latest' from '/home/johndoe/QuantConnect/Lean/DockerfileLeanFoundation'
   Compiling the C# code in '/home/johndoe/QuantConnect/Lean'
   Building 'lean-cli/engine:latest' from '/home/johndoe/QuantConnect/Lean/Dockerfile' using 'lean-cli/foundation:latest' as base image
   Building 'lean-cli/research:latest' from '/home/johndoe/QuantConnect/Lean/DockerfileJupyter' using 'lean-cli/engine:latest' as base image
   Setting default engine image to 'lean-cli/engine:latest'
   Setting default research image to 'lean-cli/research:latest'

   After running this command the CLI uses your newly built images instead of the official ones.

By default the lean build command tags all custom images with latest. You can specify a different tag using the --tag <value> option.

If you haven't changed the foundation Dockerfile, the CLI automatically skips building the custom foundation image and uses the official quantconnect/lean:foundation image instead.