Code generated by Lean-CLI-API-Reference-Code-Generator.py

QuantConnect · Dec 20, 2024 · 5e535b4 · 5e535b4
1 parent 261fa2a
commit 5e535b4
Show file tree

Hide file tree

Showing 32 changed files with 79 additions and 3 deletions.
diff --git a/05 Lean CLI/99 API Reference/00.json b/05 Lean CLI/99 API Reference/00.json
@@ -61,6 +61,7 @@
         "54": "",
         "55": "",
         "56": "",
-        "57": ""
+        "57": "",
+        "58": ""
     }
 }
diff --git a/05 Lean CLI/99 API Reference/51 lean private-cloud add-compute/01 Introduction.html b/05 Lean CLI/99 API Reference/51 lean private-cloud add-compute/01 Introduction.html
@@ -0,0 +1,4 @@
+<p>Add private cloud compute</p>
+<div class="cli section-example-container">
+<pre>$ lean private-cloud add-compute [OPTIONS]</pre>
+</div>
diff --git a/05 Lean CLI/99 API Reference/51 lean private-cloud add-compute/04 Options.html b/05 Lean CLI/99 API Reference/51 lean private-cloud add-compute/04 Options.html
@@ -0,0 +1,59 @@
+<p>The <code>lean private-cloud add-compute</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>--token &lt;string&gt;</code></td>
+    <td>The master server token</td>
+</tr>
+<tr>
+    <td nowrap><code>--master-domain, --master-ip &lt;string&gt;</code></td>
+    <td>The master server domain</td>
+</tr>
+<tr>
+    <td nowrap><code>--master-port &lt;integer&gt;</code></td>
+    <td>The master server port</td>
+</tr>
+<tr>
+    <td nowrap><code>--slave-domain, --slave-ip &lt;string&gt;</code></td>
+    <td>The slave server domain</td>
+</tr>
+<tr>
+    <td nowrap><code>--update</code></td>
+    <td>Pull the latest image before starting</td>
+</tr>
+<tr>
+    <td nowrap><code>--no-update</code></td>
+    <td>Do not update to the latest version</td>
+</tr>
+<tr>
+    <td nowrap><code>--compute &lt;string&gt;</code></td>
+    <td>Compute configuration to use</td>
+</tr>
+<tr>
+    <td nowrap><code>--extra-docker-config &lt;string&gt;</code></td>
+    <td>Extra docker configuration as a JSON string</td>
+</tr>
+<tr>
+    <td nowrap><code>--stop</code></td>
+    <td>Stop any existing deployment</td>
+</tr>
+<tr>
+    <td nowrap><code>--lean-config &lt;file&gt;</code></td>
+    <td>The Lean configuration file that should be used (defaults to the nearest lean.json)</td>
+</tr>
+<tr>
+    <td nowrap><code>--verbose</code></td>
+    <td>Enable debug logging</td>
+</tr>
+<tr>
+    <td nowrap><code>--help</code></td>
+    <td>Display the help text of the <code>lean private-cloud add-compute</code> command and exit</td>
+</tr>
+    </tbody>
+</table>
diff --git a/05 Lean CLI/99 API Reference/51 lean private-cloud add-compute/metadata.json b/05 Lean CLI/99 API Reference/51 lean private-cloud add-compute/metadata.json
@@ -0,0 +1,12 @@
+{
+    "type": "metadata",
+    "values": {
+        "description": "API reference for the command `lean private-cloud add-compute` in command line console.",
+        "keywords": "lean cli, api, api reference, command, command line, lean private-cloud add-compute",
+        "og:description": "API reference for the command `lean private-cloud add-compute` in command line console.",
+        "og:title": "lean private-cloud add-compute - Documentation QuantConnect.com",
+        "og:type": "website",
+        "og:site_name": "lean private-cloud add-compute - QuantConnect.com",
+        "og:image": "https://cdn.quantconnect.com/docs/i/lean-cli/api-reference/lean-private-cloud-add-compute.png"
+    }
+}
diff --git a/... private-cloud start/01 Introduction.html → ... private-cloud start/01 Introduction.html b/... private-cloud start/01 Introduction.html → ... private-cloud start/01 Introduction.html
diff --git a/... lean private-cloud start/04 Options.html → ... lean private-cloud start/04 Options.html b/... lean private-cloud start/04 Options.html → ... lean private-cloud start/04 Options.html
@@ -20,15 +20,15 @@
     <td>The master server token</td>
 </tr>
 <tr>
-    <td nowrap><code>--master-domain &lt;string&gt;</code></td>
+    <td nowrap><code>--master-domain, --master-ip &lt;string&gt;</code></td>
     <td>The master server domain</td>
 </tr>
 <tr>
     <td nowrap><code>--master-port &lt;integer&gt;</code></td>
     <td>The master server port</td>
 </tr>
 <tr>
-    <td nowrap><code>--slave-domain &lt;string&gt;</code></td>
+    <td nowrap><code>--slave-domain, --slave-ip &lt;string&gt;</code></td>
     <td>The slave server domain</td>
 </tr>
 <tr>

diff --git a/...51 lean private-cloud start/metadata.json → ...52 lean private-cloud start/metadata.json b/...51 lean private-cloud start/metadata.json → ...52 lean private-cloud start/metadata.json
diff --git a/...n private-cloud stop/01 Introduction.html → ...n private-cloud stop/01 Introduction.html b/...n private-cloud stop/01 Introduction.html → ...n private-cloud stop/01 Introduction.html
diff --git a/...2 lean private-cloud stop/04 Options.html → ...3 lean private-cloud stop/04 Options.html b/...2 lean private-cloud stop/04 Options.html → ...3 lean private-cloud stop/04 Options.html
diff --git a/.../52 lean private-cloud stop/metadata.json → .../53 lean private-cloud stop/metadata.json b/.../52 lean private-cloud stop/metadata.json → .../53 lean private-cloud stop/metadata.json
diff --git a/... lean project-create/01 Introduction.html → ... lean project-create/01 Introduction.html b/... lean project-create/01 Introduction.html → ... lean project-create/01 Introduction.html
diff --git a/...3 lean project-create/02 Description.html → ...4 lean project-create/02 Description.html b/...3 lean project-create/02 Description.html → ...4 lean project-create/02 Description.html
diff --git a/...e/53 lean project-create/03 Arguments.php → ...e/54 lean project-create/03 Arguments.php b/...e/53 lean project-create/03 Arguments.php → ...e/54 lean project-create/03 Arguments.php
diff --git a/...ce/53 lean project-create/04 Options.html → ...ce/54 lean project-create/04 Options.html b/...ce/53 lean project-create/04 Options.html → ...ce/54 lean project-create/04 Options.html
diff --git a/...ence/53 lean project-create/metadata.json → ...ence/54 lean project-create/metadata.json b/...ence/53 lean project-create/metadata.json → ...ence/54 lean project-create/metadata.json
diff --git a/... lean project-delete/01 Introduction.html → ... lean project-delete/01 Introduction.html b/... lean project-delete/01 Introduction.html → ... lean project-delete/01 Introduction.html
diff --git a/...4 lean project-delete/02 Description.html → ...5 lean project-delete/02 Description.html b/...4 lean project-delete/02 Description.html → ...5 lean project-delete/02 Description.html
diff --git a/...ce/54 lean project-delete/04 Options.html → ...ce/55 lean project-delete/04 Options.html b/...ce/54 lean project-delete/04 Options.html → ...ce/55 lean project-delete/04 Options.html
diff --git a/...ence/54 lean project-delete/metadata.json → ...ence/55 lean project-delete/metadata.json b/...ence/54 lean project-delete/metadata.json → ...ence/55 lean project-delete/metadata.json
diff --git a/...rence/55 lean report/01 Introduction.html → ...rence/56 lean report/01 Introduction.html b/...rence/55 lean report/01 Introduction.html → ...rence/56 lean report/01 Introduction.html
diff --git a/...erence/55 lean report/02 Description.html → ...erence/56 lean report/02 Description.html b/...erence/55 lean report/02 Description.html → ...erence/56 lean report/02 Description.html
diff --git a/... Reference/55 lean report/04 Options.html → ... Reference/56 lean report/04 Options.html b/... Reference/55 lean report/04 Options.html → ... Reference/56 lean report/04 Options.html
diff --git a/...PI Reference/55 lean report/metadata.json → ...PI Reference/56 lean report/metadata.json b/...PI Reference/55 lean report/metadata.json → ...PI Reference/56 lean report/metadata.json
diff --git a/...nce/56 lean research/01 Introduction.html → ...nce/57 lean research/01 Introduction.html b/...nce/56 lean research/01 Introduction.html → ...nce/57 lean research/01 Introduction.html
diff --git a/...rence/56 lean research/02 Description.php → ...rence/57 lean research/02 Description.php b/...rence/56 lean research/02 Description.php → ...rence/57 lean research/02 Description.php
diff --git a/...erence/56 lean research/03 Arguments.html → ...erence/57 lean research/03 Arguments.html b/...erence/56 lean research/03 Arguments.html → ...erence/57 lean research/03 Arguments.html
diff --git a/...eference/56 lean research/04 Options.html → ...eference/57 lean research/04 Options.html b/...eference/56 lean research/04 Options.html → ...eference/57 lean research/04 Options.html
diff --git a/... Reference/56 lean research/metadata.json → ... Reference/57 lean research/metadata.json b/... Reference/56 lean research/metadata.json → ... Reference/57 lean research/metadata.json
diff --git a/...rence/57 lean whoami/01 Introduction.html → ...rence/58 lean whoami/01 Introduction.html b/...rence/57 lean whoami/01 Introduction.html → ...rence/58 lean whoami/01 Introduction.html
diff --git a/...erence/57 lean whoami/02 Description.html → ...erence/58 lean whoami/02 Description.html b/...erence/57 lean whoami/02 Description.html → ...erence/58 lean whoami/02 Description.html
diff --git a/... Reference/57 lean whoami/04 Options.html → ... Reference/58 lean whoami/04 Options.html b/... Reference/57 lean whoami/04 Options.html → ... Reference/58 lean whoami/04 Options.html
diff --git a/...PI Reference/57 lean whoami/metadata.json → ...PI Reference/58 lean whoami/metadata.json b/...PI Reference/57 lean whoami/metadata.json → ...PI Reference/58 lean whoami/metadata.json