API Reference

lean cloud pull

Introduction

Pull projects from QuantConnect to the local drive.

$ lean cloud pull [options]

Description

Pulls projects from QuantConnect to your local directory while preserving the directory structure of your projects on QuantConnect. The project's files, description, and parameters are pulled from the cloud. By default, all cloud projects are pulled from the organization that's linked to your current workspace. If you provide a --project option, you only pull a single project from the cloud.

Before pulling a cloud project, the CLI checks if the local directory with the same path already exists. If it does and the local directory is not linked to the cloud project (because of an earlier lean cloud pull or lean cloud push), the CLI skips pulling the cloud project and logs a descriptive warning message.

If you have a local copy of a project when you pull it from the cloud, local files that don't exist in the cloud are not deleted, but the configuration values of your cloud project overwrite the configuration values of the local version. If you have renamed the project in the cloud, when you pull the project from the cloud, the local project is renamed to match the name of the cloud project.

If one of your team members creates a project library, adds it to a project, and then adds you as a collaborator to the project, you can pull the project but not the library. To pull the library as well, your team member must add you as a collaborator on the library project.

Options

The lean cloud pull command supports the following options:

OptionDescription
--project <value>The name or id of the cloud project to pull (all your cloud projects in the organization if not specified).
--pull-bootcampPull Boot Camp projects (disabled by default).
--verboseEnable debug logging.
--helpDisplay the help text of the lean cloud pull command and exit.

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: