API Reference

lean config set

Introduction

Set a configurable option.

$ lean config set [OPTIONS] KEY VALUE

Description

Updates the value of a configurable option in your global configuration directory. The command aborts with a descriptive error message if the given value is invalid for the given key.

The following keys can be set:

KeyDescription
user-idThe user Id used when making authenticated requests to the QuantConnect API.
api-tokenThe API token used when making authenticated requests to the QuantConnect API.
default-languageThe default language used when creating new projects (must be either python or csharp).
engine-imageThe Docker image used when running the LEAN engine (quantconnect/lean:latest if not set).
research-imageThe Docker image used when running the research environment (quantconnect/research:latest if not set).

Arguments

The lean config set command expects the following arguments:

ArgumentDescription
<key>The key of the option to update.
<value>The new value for the option with the given key.

Options

The lean config set command supports the following options:

OptionDescription
--verboseEnable debug logging
--helpDisplay the help text of the lean config set 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: