QuantConnect / Documentation

QuantConnect Wiki Style Documentation Behind QuantConnect
https://www.quantconnect.com/docs/v2/
Apache License 2.0
171 stars 135 forks source link

Lean CLI: Project Encryption #1514

Closed AlexCatarino closed 10 months ago

AlexCatarino commented 11 months ago

Expected Behavior

See https://github.com/QuantConnect/lean-cli/pull/373

New Encryption page under Lean CLI > Projects after Workflows.

It is similar to Workflows since there is the cloud component

lean cloud push --encrypt --key FILE "Project Name"
lean cloud pull --encrypt --key FILE "Project Name"
lean cloud push --decrypt --key FILE "Project Name"
lean cloud pull --decrypt --key FILE "Project Name"

I think that normally users won't push --decrypt, since QuantConnect IDE will display the files.

and a local component

lean encrypt --key FILE "Project Name"
lean decrypt --key FILE "Project Name"

Decrypt before editing the file.

The mixed mode would not be decrypted locally and push with encrypt and pull with decrypt. Option 1 (decrypt on pull)

lean cloud pull --decrypt --key FILE "Project Name"
lean cloud push --encrypt --key FILE "Project Name"

Option 2 (pull encrypted, you may not want to decrypt now)

lean cloud pull "Project Name"
lean decrypt --key FILE "Project Name"
lean cloud push --encrypt --key FILE "Project Name"

Finally, update the API Reference.

Checklist

DerekMelchin commented 10 months ago

Also need to update https://www.quantconnect.com/docs/v2/lean-cli/projects/configuration#02-Properties to include the new encrypted and encryption-key-path properties