Skip to content

Commit

Permalink
Merge pull request #2041 from DerekMelchin/bug-subscription-required-…
Browse files Browse the repository at this point in the history
…for-cli

Add subscription requirement to CLI pages
  • Loading branch information
DerekMelchin authored Jan 3, 2025
2 parents d985f9d + 0ce71c8 commit 07d4e1b
Show file tree
Hide file tree
Showing 69 changed files with 204 additions and 26 deletions.
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<p>
The Lean CLI is a cross-platform CLI which makes it easier to develop with the LEAN engine locally and in the cloud.
</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,3 @@
The commands which run the LEAN engine locally also depend on <a href="https://www.docker.com/" target="_blank" rel='nofollow'>Docker</a> being installed and running. See <a href="/docs/v2/lean-cli/installation/installing-lean-cli#02-Install-Docker">Install Docker</a> to learn how to install Docker on your operating system.
</p>

<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@
This page lists common errors with their possible cause and a way to fix them.
In case you still need help after that this page also contains instructions on how to report issues to our engineers in a way that makes it easy for us to help you with your issue.
</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
<? include(DOCS_RESOURCES."/cli/install/pip/introduction.php"); ?>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@
<p>
The commands which run the LEAN engine locally also depend on <a href='https://www.docker.com/' target='_blank'>Docker</a> being installed and running.
</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
<? include(DOCS_RESOURCES."/cli/init/auth-intro.html"); ?>
<? include(DOCS_RESOURCES."/cli/init/auth-intro.html"); ?>

<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@
Doing so ensures the directory structure is always kept consistent when synchronizing projects between the cloud and your local drive.
It also makes it possible for the CLI to automatically find the Lean configuration file when you run the LEAN engine on your local machine.
</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,6 @@
The CLI stores its persistent configuration in various places depending on the context of the configuration.
We make the distinction between global configuration, Lean configuration, and project configuration, all of which store a specific subset of configurable properties.
</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
<p>LEAN strives to use an open, human-readable format, so all data is stored in flat files (formatted as CSV or JSON). The data is compressed on disk using zip</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@
This generator uses a Brownian motion model to generate realistic market data.
It is capable of generating data for most of LEAN's supported security types and resolutions, which makes it a good solution to design and test algorithms without the need to buy real financial data.
</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
3 changes: 3 additions & 0 deletions 05 Lean CLI/05 Datasets/04 Custom Data/01 Introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
Besides market data, LEAN also supports importing custom data into your algorithm.
This page explains how to access data from local files in your algorithm when running the LEAN engine locally.
</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
<p>Downloading data by the ticker is the ideal, low-cost option to acquiring local trading data if you don't need an entire universe. This technique is for smaller, discrete downloads. You can download our ticker data through the CLI or LEAN in exchange for some <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/credit'>QuantConnect Credit</a> (QCC). Before the CLI or LEAN download new files, they check if your local machine already stores the files.</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
<p>This page describes how to calculate the approximate cost of downloading local data for algorithms of each asset class. The prices reflect the data prices at the time of writing. To view the current prices of each dataset, open a dataset listing in the <a href="https://www.quantconnect.com/datasets">Dataset Market</a> and then click the <span class="page-section-name">Pricing</span> tab. To download the data, use the <a href="/docs/v2/lean-cli/datasets/quantconnect/download-by-ticker/key-concepts#02-Using-the-CLI">lean data download</a> command or the <a href="/docs/v2/lean-cli/backtesting/deployment#04-Download-Datasets-During-Backtests">ApiDataProvider</a>.</p>
<p>This page describes how to calculate the approximate cost of downloading local data for algorithms of each asset class. The prices reflect the data prices at the time of writing. To view the current prices of each dataset, open a dataset listing in the <a href="https://www.quantconnect.com/datasets">Dataset Market</a> and then click the <span class="page-section-name">Pricing</span> tab. To download the data, use the <a href="/docs/v2/lean-cli/datasets/quantconnect/download-by-ticker/key-concepts#02-Using-the-CLI">lean data download</a> command or the <a href="/docs/v2/lean-cli/backtesting/deployment#04-Download-Datasets-During-Backtests">ApiDataProvider</a>.</p>

<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
<p>Download the <a href="https://www.quantconnect.com/datasets/oanda-cfd-data">CFD dataset</a> in bulk to get the full dataset without any selection bias. The bulk dataset packages contain data for every ticker and trading day.</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
<p>Download the <a href="https://www.quantconnect.com/datasets/oanda-forex">FOREX dataset</a> in bulk to get the full dataset without any selection bias. The bulk dataset packages contain data for every ticker and trading day.</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<p>Download the <a href="https://www.quantconnect.com/datasets/algoseek-us-equities">US Equities dataset</a> in bulk to get the full dataset without any selection bias. The bulk dataset packages contain data for every ticker and trading day. If the resolution you download provides trade and quote data, the bulk download contains both data types. To check which data types each resolution provides, see <a href="https://www.quantconnect.com/docs/v2/writing-algorithms/securities/asset-classes/us-equity/requesting-data#03-Resolutions">Resolutions</a>.</p>

<div class="highlight">The US Equities dataset depends on the <a href="https://www.quantconnect.com/datasets/quantconnect-us-equity-security-master">US Equity Security Master</a> dataset because the US Equity Security Master contains information on splits, dividends, and symbol changes.</div>
<div class="highlight">The US Equities dataset depends on the <a href="https://www.quantconnect.com/datasets/quantconnect-us-equity-security-master">US Equity Security Master</a> dataset because the US Equity Security Master contains information on splits, dividends, and symbol changes.</div>

<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<p>Download the <a href='https://www.quantconnect.com/datasets/quantconnect-us-coarse-universe-constituents'>US Equity Coarse Universe dataset</a> in bulk to get the full dataset without any selection bias. The bulk dataset packages contain data for every trading day.</p>

<div class="highlight">The US Equity Coarse Universe dataset depends on the <a href="https://www.quantconnect.com/datasets/quantconnect-us-equity-security-master">US Equity Security Master</a> dataset because the US Equity Security Master contains information on splits, dividends, and symbol changes.</div>
<div class="highlight">The US Equity Coarse Universe dataset depends on the <a href="https://www.quantconnect.com/datasets/quantconnect-us-equity-security-master">US Equity Security Master</a> dataset because the US Equity Security Master contains information on splits, dividends, and symbol changes.</div>

<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@
The US Equity Options dataset depends on the <a href="https://www.quantconnect.com/datasets/quantconnect-us-equity-security-master">US Equity Security Master</a> dataset because the US Equity Security Master contains information on splits, dividends, and symbol changes.
The US Equity Options dataset also depends on the <a href="/docs/v2/lean-cli/datasets/quantconnect/download-in-bulk/us-equity-option-universe">US Equity Option Universe</a> dataset because the US Equity Options Universe dataset contains information on the available contracts and their daily Greeks and implied volatility values.
</div>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@
</p>

<div class="highlight">The US Equity Option Universe dataset depends on the <a href="https://www.quantconnect.com/datasets/quantconnect-us-equity-security-master">US Equity Security Master</a> dataset because the US Equity Security Master contains information on splits, dividends, and symbol changes.</div>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<p>Download the <a href='https://www.quantconnect.com/datasets/quantconnect-us-etf-constituents'>US ETF Constituents dataset</a> in bulk to get the full dataset without any ETF selection bias. The bulk dataset package contains constituents data for all of the <a href='https://www.quantconnect.com/docs/v2/writing-algorithms/datasets/quantconnect/us-etf-constituents#07-Supported-ETFs'>supported ETFs</a> for every trading day.</p>

<div class="highlight">The US ETF Constituents dataset depends on the <a href="https://www.quantconnect.com/datasets/quantconnect-us-equity-security-master">US Equity Security Master</a> dataset because the US Equity Security Master contains information on splits, dividends, and symbol changes.</div>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
<div class="highlight">
The US Futures dataset depends on the <a href="https://www.quantconnect.com/datasets/quantconnect.com/datasets/quantconnect-us-futures-security-masterr">US Futures Security Master</a> dataset because the US Futures Security Master dataset contains information to construct continuous Futures.
</div>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@
The US Future Options dataset depends on the <a href="https://www.quantconnect.com/datasets/quantconnect.com/datasets/algoseek-us-futures">US Futures</a> dataset because the US Futures Sdataset contains data on the underlying Futures contracts.
The US Future Options dataset also depends on the <a href="https://www.quantconnect.com/datasets/quantconnect.com/datasets/quantconnect-us-futures-security-master">US Futures Security Master</a> dataset because the US Futures Security Master dataset contains information to construct continuous Futures.
</div>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
<div class="highlight">
The US Index Options dataset depends on the <a href="/docs/v2/lean-cli/datasets/quantconnect/download-in-bulk/us-index-option-universe">US Index Option Universe</a> dataset because the US Index Options Universe dataset contains information on the available contracts, including their daily Greeks and implied volatility values.
</div>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
The bulk dataset packages contains the available Option contracts and their daily Greeks and implied volatility values for every underlying US Index and trading day.
</p>



<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
4 changes: 3 additions & 1 deletion 05 Lean CLI/05 Datasets/06 Brokerages/01 Introduction.html
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
<p>Instead of using the data from QuantConnect, you can use data from your brokerage.</p>
<p>Instead of using the data from QuantConnect, you can use data from your brokerage.</p>

<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
3 changes: 3 additions & 0 deletions 05 Lean CLI/05 Datasets/07 Alpha Vantage/01 Introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@
</p>

<p>To view the implementation of the Alpha Vantage integration, see the <a href='https://github.com/QuantConnect/Lean.DataSource.AlphaVantage' rel='nofollow' target='_blank'>Lean.DataSource.AlphaVantage repository</a>.</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
4 changes: 3 additions & 1 deletion 05 Lean CLI/05 Datasets/08 FactSet/01 Introduction.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<p>Instead of using the data from QuantConnect or your brokerage, you can use data from <a rel='nofollow' target='_blank' href='https://www.factset.com/'>FactSet</a> if you have the authetication <span class="public-file-name">JSON</span> file.</p>

<p>To view the implementation of the FactSet integration, see the <a href='https://github.com/QuantConnect/Lean.DataSource.FactSet' rel='nofollow' target='_blank'>Lean.DataSource.FactSet repository</a>.</p>
<p>To view the implementation of the FactSet integration, see the <a href='https://github.com/QuantConnect/Lean.DataSource.FactSet' rel='nofollow' target='_blank'>Lean.DataSource.FactSet repository</a>.</p>

<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
3 changes: 3 additions & 0 deletions 05 Lean CLI/05 Datasets/10 IQFeed/01 Introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@
</p>

<p>To view the implementation of the IQFeed integration, see the <a href='https://github.com/QuantConnect/Lean.DataSource.IQFeed' rel='nofollow' target='_blank'>Lean.DataSource.IQFeed repository</a>.</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
3 changes: 3 additions & 0 deletions 05 Lean CLI/05 Datasets/11 Polygon/01 Introduction.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<p>Instead of using the data from QuantConnect or your brokerage, you can use data from <a rel='nofollow' target='_blank' href='https://polygon.io/'>Polygon</a> if you have an API key. To get an API key, see the <a href='https://polygon.io/dashboard/api-keys' rel='nofollow' target='_blank'>API Keys</a> page on the Polygon website</p>

<p>To view the implementation of the Polygon integration, see the <a href='https://github.com/QuantConnect/Lean.DataSource.Polygon' rel='nofollow' target='_blank'>Lean.DataSource.Polygon repository</a>.</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
3 changes: 3 additions & 0 deletions 05 Lean CLI/05 Datasets/12 Terminal Link/01 Introduction.html
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
<p>Instead of using the data from QuantConnect, you can use data from Bloomberg EMSX through Terminal Link if you're in an organization on the <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features#06-Institution-Tier'>Institution tier</a>.</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
3 changes: 3 additions & 0 deletions 05 Lean CLI/05 Datasets/13 Theta Data/01 Introduction.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@
</p>

<p>To view the implementation of the Theta Data integration, see the <a href='https://github.com/QuantConnect/Lean.DataSource.ThetaData' rel='nofollow' target='_blank'>Lean.DataSource.ThetaData repository</a>.</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
The CLI can automatically scaffold basic Python and C# projects, creating basic algorithm files, research notebooks, and the required editor configuration.
Projects scaffolded by the CLI are similar to the ones created on QuantConnect, making it easy to switch between your local environment and the cloud.
</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,6 @@
Cloud synchronization allows you to synchronize your projects in QuantConnect Cloud with your local drive using the Lean CLI.
Cloud synchronization makes it possible to use your local development environment when writing your algorithms while using QuantConnect's infrastructure and data library when executing them.
</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
4 changes: 3 additions & 1 deletion 05 Lean CLI/06 Projects/03 Structure/01 Introduction.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<p>
When you run the <code>lean project-create</code> or <code>lean cloud pull</code> commands, the CLI creates the basic files and folders most editors need to open your source code, provide autocomplete, and enable local debugging. This page documents exactly which files are created when you create a new local project with <code>lean project-create</code> or <code>lean cloud pull</code>.
</p>
</p>

<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
3 changes: 3 additions & 0 deletions 05 Lean CLI/06 Projects/04 Workflows/01 Introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,6 @@
The Lean CLI supports multiple workflows, ranging from running everything locally to just using your local development environment but keeping all execution in the cloud.
This page contains several examples of common workflows, but you're free to mix local and cloud features in any way you'd like.
</p>


<p>To use the CLI, you must be a member in an <a href='https://www.quantconnect.com/docs/v2/cloud-platform/organizations/tier-features'>organization</a> on a paid tier.</p>
Loading

0 comments on commit 07d4e1b

Please sign in to comment.