Skip to content

Commit

Permalink
Updates Lean CLI API
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexCatarino committed Oct 26, 2023
1 parent b7aeef0 commit 7c302ee
Show file tree
Hide file tree
Showing 192 changed files with 297 additions and 140 deletions.
4 changes: 4 additions & 0 deletions 05 Lean CLI/99 API Reference/01 lean backtest/04 Options.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,7 @@
</tr>
</tbody>
</table>
<!-- Missing options:
--backtest-name
--extra-docker-config
-->
Original file line number Diff line number Diff line change
Expand Up @@ -285,3 +285,9 @@
</tr>
</tbody>
</table>
<!-- Missing options:
--ib-weekly-restart-utc-time
--tradier-data-feed
--terminal-link-emsx-account
--show-secrets
-->

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,8 @@
</tr>
</tbody>
</table>
<!-- Missing options:
--encrypt
--decrypt
--key
-->
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,8 @@
</tr>
</tbody>
</table>
<!-- Missing options:
--encrypt
--decrypt
--key
-->
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,6 @@
</tr>
</tbody>
</table>
<!-- Missing options:
--lean-config
-->
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,15 @@
</tr>
</tbody>
</table>
<!-- Missing options:
--quote-trade-ratio
--random-seed
--ipo-percentage
--rename-percentage
--splits-percentage
--dividends-percentage
--dividend-every-quarter-percentage
--option-price-engine
--volatility-model-resolution
--chain-symbol-count
-->
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<p>Decrypt your local project using the specified decryption key.</p>
<div class="cli section-example-container">
<pre>$ lean decrypt [OPTIONS] PROJECT</pre>
</div>
23 changes: 23 additions & 0 deletions 05 Lean CLI/99 API Reference/24 lean decrypt/03 Options.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<p>The <code>lean decrypt</code> command supports the following options:</p>
<table class="table qc-table">
<thead>
<tr>
<th>Option</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td nowrap><code>--key FILE</code></td>
<td>Path to the decryption key to use</td>
</tr>
<tr>
<td nowrap><code>--verbose</code></td>
<td>Enable debug logging</td>
</tr>
<tr>
<td nowrap><code>--help</code></td>
<td>Show this message and exit.</td>
</tr>
</tbody>
</table>
12 changes: 12 additions & 0 deletions 05 Lean CLI/99 API Reference/24 lean decrypt/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"type": "metadata",
"values": {
"description": "API reference for the command `lean decrypt` in command line console.",
"keywords": "lean cli, api, api reference, command, command line, lean decrypt",
"og:description": "API reference for the command `lean decrypt` in command line console.",
"og:title": "lean decrypt - Documentation QuantConnect.com",
"og:type": "website",
"og:site_name": "{key} - QuantConnect.com",
"og:image": "https://cdn.quantconnect.com/docs/i/lean-cli/api-reference/lean-decrypt.png"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<p>Encrypt your local project using the specified encryption key.</p>
<div class="cli section-example-container">
<pre>$ lean encrypt [OPTIONS] PROJECT</pre>
</div>
23 changes: 23 additions & 0 deletions 05 Lean CLI/99 API Reference/26 lean encrypt/03 Options.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<p>The <code>lean encrypt</code> command supports the following options:</p>
<table class="table qc-table">
<thead>
<tr>
<th>Option</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td nowrap><code>--key FILE</code></td>
<td>Path to the encryption key to use</td>
</tr>
<tr>
<td nowrap><code>--verbose</code></td>
<td>Enable debug logging</td>
</tr>
<tr>
<td nowrap><code>--help</code></td>
<td>Show this message and exit.</td>
</tr>
</tbody>
</table>
12 changes: 12 additions & 0 deletions 05 Lean CLI/99 API Reference/26 lean encrypt/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"type": "metadata",
"values": {
"description": "API reference for the command `lean encrypt` in command line console.",
"keywords": "lean cli, api, api reference, command, command line, lean encrypt",
"og:description": "API reference for the command `lean encrypt` in command line console.",
"og:title": "lean encrypt - Documentation QuantConnect.com",
"og:type": "website",
"og:site_name": "{key} - QuantConnect.com",
"og:image": "https://cdn.quantconnect.com/docs/i/lean-cli/api-reference/lean-encrypt.png"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -353,3 +353,9 @@
</tr>
</tbody>
</table>
<!-- Missing options:
--ib-weekly-restart-utc-time
--iqfeed-productName
--show-secrets
--extra-docker-config
-->
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@
</tr>
</tbody>
</table>
<!-- Missing options:
--show-secrets
-->

This file was deleted.

34 changes: 0 additions & 34 deletions 05 Lean CLI/99 API Reference/40 lean object-store/02 Commands.html

This file was deleted.

22 changes: 0 additions & 22 deletions 05 Lean CLI/99 API Reference/40 lean object-store/03 Options.html

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<p>Opens the local storage directory in the file explorer.</p>
<div class="cli section-example-container">
<pre>$ lean object-store delete [OPTIONS]</pre>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<p>The <code>lean object-store delete</code> command supports the following options:</p>
<table class="table qc-table">
<thead>
<tr>
<th>Option</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td nowrap><code>--verbose</code></td>
<td>Enable debug logging</td>
</tr>
<tr>
<td nowrap><code>--help</code></td>
<td>Show this message and exit.</td>
</tr>
</tbody>
</table>
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"type": "metadata",
"values": {
"description": "API reference for the command `lean object-store delete` in command line console.",
"keywords": "lean cli, api, api reference, command, command line, lean object-store delete",
"og:description": "API reference for the command `lean object-store delete` in command line console.",
"og:title": "lean object-store delete - Documentation QuantConnect.com",
"og:type": "website",
"og:site_name": "{key} - QuantConnect.com",
"og:image": "https://cdn.quantconnect.com/docs/i/lean-cli/api-reference/lean-object-store-delete.png"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<p>Opens the local storage directory in the file explorer.</p>
<div class="cli section-example-container">
<pre>$ lean object-store get [OPTIONS]</pre>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<p>The <code>lean object-store get</code> command supports the following options:</p>
<table class="table qc-table">
<thead>
<tr>
<th>Option</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td nowrap><code>--verbose</code></td>
<td>Enable debug logging</td>
</tr>
<tr>
<td nowrap><code>--help</code></td>
<td>Show this message and exit.</td>
</tr>
</tbody>
</table>
Loading

0 comments on commit 7c302ee

Please sign in to comment.