Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lean CLI: Project Encryption #1514

Closed
3 tasks done
AlexCatarino opened this issue Oct 17, 2023 · 1 comment · Fixed by #1530
Closed
3 tasks done

Lean CLI: Project Encryption #1514

AlexCatarino opened this issue Oct 17, 2023 · 1 comment · Fixed by #1530
Assignees
Labels
feature lean-cli Refers to the Lean CLI Produce missing content

Comments

@AlexCatarino
Copy link
Member

Expected Behavior

See QuantConnect/lean-cli#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

  • I have completely filled out this template
  • I have confirmed that this issue exists on the current master branch
  • I have confirmed that this is not a duplicate issue by searching issues
@DerekMelchin
Copy link
Collaborator

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature lean-cli Refers to the Lean CLI Produce missing content
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants