lean report - Documentation QuantConnect.com
Runs the LEAN Report Creator in a Docker container using the quantconnect/lean Docker image.
By default, this command generates a report of the most recent backtest.
This behavior can be overridden by using --backtest-results <path> and providing the path to the backtest results JSON file.
If --live-results <path> is also given, the generated report will contain both the backtest and the live results.
The --strategy-name, --strategy-version, and --strategy-description options can be used to set the name, version, and description that are shown in the report.
The name and version are shown in the top-right corner of each page, while the description is shown on the top of the first page.
These fields are blank by default.
When the given backtest results are stored in a project directory or one of its subdirectories, the default name is the name of the project directory and the default description is the description in the project's config.json file.
By default, the official LEAN engine image is used.
You can override this using the --image <value> option.
Alternatively, you can set the default engine image for all commands using lean config set engine-image <value>.
The image is pulled before running the report creator if it doesn't exist locally yet or if you pass the --update flag.
To view the content of the default reports, see Reports. To create custom reports, see Generate Reports.