API Reference

lean cloud backtest

Introduction

Backtest a project in the cloud.

$ lean cloud backtest <project> [options]

Description

Runs a backtest for a cloud project. While running the backtest a progress bar shows to keep you up-to-date on the status of the backtest. After running the backtest the resulting statistics and a link to the full results on QuantConnect are logged. You can use the --open option to automatically open the full results in the browser after the backtest has finished.

If you have a local copy of the cloud project you can use the --push option to push local modifications to the cloud before running the backtest.

Arguments

The lean cloud backtest command expects the following arguments:

ArgumentDescription
<project>The name or id of the project to run a backtest for.

Options

The lean cloud backtest command supports the following options:

OptionDescription
--name <value>The name of the backtest (a random one is generated if not specified).
--pushPush local modifications to the cloud before running the backtest.
--openAutomatically open the results in the browser when the backtest is finished.
--verboseEnable debug logging.
--helpDisplay the help text of the lean cloud backtest command and exit.

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

Did you find this page helpful?

Contribute to the documentation: