Skip to content

Document lean cloud live broadcast command #2618

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.

Sign up for GitHub

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

Merged
AlexCatarino merged 1 commit into from
Aug 13, 2026
Merged

Document lean cloud live broadcast command #2618

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions 05 Lean CLI/09 Live Trading/03 Algorithm Control/03 Control Cloud Algorithms.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,20 @@
</div>

<p>For more information about the command options, see <a href='/docs/v2/lean-cli/api-reference/lean-cloud-live-command#04-Options'>Options</a>.</p>

<h4>Broadcast Commands</h4>
<p>To send a <a href='https://www.quantconnect.com/docs/v2/writing-algorithms/live-trading/commands'>command</a> to every live algorithm that runs in your organization, open a terminal in the <a href='/docs/v2/lean-cli/initialization/organization-workspaces'>organization workspace</a> and then run <code>lean cloud live broadcast --data "&lt;payload&gt;"</code>.</p>

<div class="cli section-example-container">
<pre>$ lean cloud live broadcast --data "{'ticker': 'AAPL', 'quantity': 1}"</pre>
</div>

<p>The payload follows the same rules as the one you pass to <code>lean cloud live command</code>, so include a <code>$type</code> key to run the logic you wrap in a <code>Command</code> class and use <code>`$type</code> in PowerShell.</p>

<p>The command targets the organization of the current Lean CLI directory. To broadcast to another organization, pass its name or Id to the <code>--organization</code> option. To leave one project out of the broadcast, pass its name or Id to the <code>--exclude-project</code> option.</p>

<div class="cli section-example-container">
<pre>$ lean cloud live broadcast --data "{'$type': 'MyCommand', 'ticker': 'AAPL', 'quantity': 1}" --organization "My Organization" --exclude-project "My Project"</pre>
</div>

<p>For more information about the command options, see <a href='/docs/v2/lean-cli/api-reference/lean-cloud-live-broadcast#04-Options'>Options</a>.</p>