Projects
Configuration
Introduction
Project-specific configuration is stored in the project directory in the config.json file.
This file is automatically generated when you run lean project-create or lean cloud pull.
Just like the global and Lean configuration files, the project configuration is stored as JSON but without support for comments.
Properties
The following properties are stored in the config.json file:
| Property | Description |
|---|---|
description | This property contains the project's description, which is displayed in backtest reports. It must always be a string. |
parameters | This property is a key/value object containing the project's parameters. Both the keys and the values must be strings. To load parameter values into your algorithm, see Get Parameters. The parameter values are sent to your algorithm when you deploy the algorithm, so it's not possible to change the parameter values while the algorithm runs. |
cloud-id | This property is set automatically after the project has been pulled from or pushed to the cloud. It contains the id of the project's counterpart in the cloud and must not be modified or removed manually. |
local-id | This property is set automatically when the CLI needs to uniquely identify the current project. It contains a unique id that is specific to the project and must not be modified or removed manually. |
libraries | This property is set automatically when you add a project library to the project. It contains a list of dictionaries that hold the name and path of each library. |
organization-id | This property is set automatically after the project has been pulled from or pushed to the cloud. It contains the Id of the organization that the project is saved to in the cloud. |
algorithm-language | This property contains the language of the project. It is automatically set when the project is created and must not be modified or removed manually. |
docker | This property is a key/value object containing the docker instance's "environment" and "ports" command line run arguments. For example, to expose host port 999 to internal port 6006, write "docker": { "ports": { "999": "6006"} }. |
lean-engine | This property is the version number of the LEAN Engine version that the project uses. |
python-venv | This property is an integer that represents the Python environment that the project uses. |
encrypted | This property is automatically set when you encrypt or decrypt a project. It's a boolean that represents if the local project is currently encrypted. |
encryption-key-path | This property is automatically set when the local project is currently encrypted. It's a string that represents the path to the file that contains the encryption key. |
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:
