update readme

QuantConnect · Oct 16, 2023 · be370d9 · be370d9
1 parent 920121b
commit be370d9
Showing 1 changed file with 54 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -91,7 +91,9 @@ A locally-focused workflow (local development, local execution) with the CLI may
 - [`lean create-project`](#lean-create-project)
 - [`lean data download`](#lean-data-download)
 - [`lean data generate`](#lean-data-generate)
+- [`lean decrypt`](#lean-decrypt)
 - [`lean delete-project`](#lean-delete-project)
+- [`lean encrypt`](#lean-encrypt)
 - [`lean init`](#lean-init)
 - [`lean library add`](#lean-library-add)
 - [`lean library remove`](#lean-library-remove)
@@ -145,7 +147,8 @@ Options:
                                   Update the Lean configuration file to retrieve data from the given provider
   --terminal-link-connection-type [DAPI|SAPI]
                                   Terminal Link Connection Type [DAPI, SAPI]
-  --terminal-link-auth-id TEXT    The Auth ID of the TerminalLink server
+  --terminal-link-server-auth-id TEXT
+                                  The Auth ID of the TerminalLink server
   --terminal-link-environment [Production|Beta]
                                   The environment to run in
   --terminal-link-server-host TEXT
@@ -321,7 +324,8 @@ Options:
   --samco-trading-segment [equity|commodity]
                                   EQUITY if you are trading equities on NSE or BSE, COMMODITY if you are trading
                                   commodities on MCX
-  --terminal-link-auth-id TEXT    The Auth ID of the TerminalLink server
+  --terminal-link-server-auth-id TEXT
+                                  The Auth ID of the TerminalLink server
   --terminal-link-environment [Production|Beta]
                                   The environment to run in
   --terminal-link-server-host TEXT
@@ -545,6 +549,9 @@ Usage: lean cloud pull [OPTIONS]
 Options:
   --project TEXT   Name or id of the project to pull (all cloud projects if not specified)
   --pull-bootcamp  Pull Boot Camp projects (disabled by default)
+  --encrypt        Pull your cloud files and encrypt them before saving on your local drive
+  --decrypt        Pull your cloud files and decrypt them before saving on your local drive
+  --key FILE       Path to the encryption key to use
   --verbose        Enable debug logging
   --help           Show this message and exit.
 ```
@@ -566,6 +573,9 @@ Usage: lean cloud push [OPTIONS]
 
 Options:
   --project DIRECTORY  Path to the local project to push (all local projects if not specified)
+  --encrypt            Push your local files and encrypt them before saving on the cloud
+  --decrypt            Push your local files and decrypt them before saving on the cloud
+  --key FILE           Path to the encryption key to use
   --verbose            Enable debug logging
   --help               Show this message and exit.
 ```
@@ -795,6 +805,25 @@ Options:
 
 _See code: [lean/commands/data/generate.py](lean/commands/data/generate.py)_
 
+### `lean decrypt`
+
+Decrypt your local project using the specified decryption key.
+
+```
+Usage: lean decrypt [OPTIONS] PROJECT
+
+  Decrypt your local project using the specified decryption key.
+
+  :param project: The project to decrypt :param key: The path to the decryption key to use
+
+Options:
+  --key FILE  Path to the decryption key to use
+  --verbose   Enable debug logging
+  --help      Show this message and exit.
+```
+
+_See code: [lean/commands/decrypt.py](lean/commands/decrypt.py)_
+
 ### `lean delete-project`
 
 Alias for 'project-delete'
@@ -813,6 +842,25 @@ Options:
 
 _See code: [lean/commands/delete_project.py](lean/commands/delete_project.py)_
 
+### `lean encrypt`
+
+Encrypt your local project using the specified encryption key.
+
+```
+Usage: lean encrypt [OPTIONS] PROJECT
+
+  Encrypt your local project using the specified encryption key.
+
+  :param project: The project to encrypt :param key: The path to the encryption key to use
+
+Options:
+  --key FILE  Path to the encryption key to use
+  --verbose   Enable debug logging
+  --help      Show this message and exit.
+```
+
+_See code: [lean/commands/encrypt.py](lean/commands/encrypt.py)_
+
 ### `lean init`
 
 Scaffold a Lean configuration file and data directory.
@@ -1060,7 +1108,8 @@ Options:
                                   commodities on MCX
   --terminal-link-connection-type [DAPI|SAPI]
                                   Terminal Link Connection Type [DAPI, SAPI]
-  --terminal-link-auth-id TEXT    The Auth ID of the TerminalLink server
+  --terminal-link-server-auth-id TEXT
+                                  The Auth ID of the TerminalLink server
   --terminal-link-environment [Production|Beta]
                                   The environment to run in
   --terminal-link-server-host TEXT
@@ -1515,7 +1564,8 @@ Options:
                                   Update the Lean configuration file to retrieve data from the given provider
   --terminal-link-connection-type [DAPI|SAPI]
                                   Terminal Link Connection Type [DAPI, SAPI]
-  --terminal-link-auth-id TEXT    The Auth ID of the TerminalLink server
+  --terminal-link-server-auth-id TEXT
+                                  The Auth ID of the TerminalLink server
   --terminal-link-environment [Production|Beta]
                                   The environment to run in
   --terminal-link-server-host TEXT