Skip to content

Commit 1a12b78

Browse files
committed
update readme
1 parent d58b7f0 commit 1a12b78

File tree

1 file changed

+59
-13
lines changed

1 file changed

+59
-13
lines changed

README.md

Lines changed: 59 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ A locally-focused workflow (local development, local execution) with the CLI may
7171
- [`lean backtest`](#lean-backtest)
7272
- [`lean build`](#lean-build)
7373
- [`lean cloud backtest`](#lean-cloud-backtest)
74+
- [`lean cloud live`](#lean-cloud-live)
7475
- [`lean cloud live deploy`](#lean-cloud-live-deploy)
7576
- [`lean cloud live liquidate`](#lean-cloud-live-liquidate)
7677
- [`lean cloud live stop`](#lean-cloud-live-stop)
@@ -88,6 +89,7 @@ A locally-focused workflow (local development, local execution) with the CLI may
8889
- [`lean init`](#lean-init)
8990
- [`lean library add`](#lean-library-add)
9091
- [`lean library remove`](#lean-library-remove)
92+
- [`lean live`](#lean-live)
9193
- [`lean live add-security`](#lean-live-add-security)
9294
- [`lean live cancel-order`](#lean-live-cancel-order)
9395
- [`lean live deploy`](#lean-live-deploy)
@@ -201,6 +203,26 @@ Options:
201203

202204
_See code: [lean/commands/cloud/backtest.py](lean/commands/cloud/backtest.py)_
203205

206+
### `lean cloud live`
207+
208+
Interact with the QuantConnect cloud live deployments.
209+
210+
```
211+
Usage: lean cloud live [OPTIONS] COMMAND [ARGS]...
212+
213+
Interact with the QuantConnect cloud live deployments.
214+
215+
Options:
216+
--help Show this message and exit.
217+
218+
Commands:
219+
deploy Start live trading for a project in the cloud.
220+
liquidate Stops live trading and liquidates existing positions for a certain project.
221+
stop Stops live trading for a certain project without liquidating existing positions.
222+
```
223+
224+
_See code: [lean/commands/cloud/live.py](lean/commands/cloud/live.py)_
225+
204226
### `lean cloud live deploy`
205227

206228
Start live trading for a project in the cloud.
@@ -699,6 +721,30 @@ Options:
699721

700722
_See code: [lean/commands/library/remove.py](lean/commands/library/remove.py)_
701723

724+
### `lean live`
725+
726+
Interact with the local machine.
727+
728+
```
729+
Usage: lean live [OPTIONS] COMMAND [ARGS]...
730+
731+
Interact with the local machine.
732+
733+
Options:
734+
--help Show this message and exit.
735+
736+
Commands:
737+
add-security Represents a command to add a security to the algorithm.
738+
cancel-order Represents a command to cancel a specific order by id.
739+
deploy Start live trading a project locally using Docker.
740+
liquidate Liquidate the given symbol from the latest deployment of the given project.
741+
stop Stop an already running local live trading project.
742+
submit-order Represents a command to submit an order to the algorithm.
743+
update-order Represents a command to update a specific order by id.
744+
```
745+
746+
_See code: [lean/commands/live.py](lean/commands/live.py)_
747+
702748
### `lean live add-security`
703749

704750
Represents a command to add a security to the algorithm.
@@ -709,10 +755,10 @@ Usage: lean live add-security [OPTIONS] PROJECT
709755
Represents a command to add a security to the algorithm.
710756
711757
Options:
712-
--ticker TEXT The ticker of the symbol to added [required]
713-
--market TEXT The market of the symbol to added [required]
714-
--security-type TEXT The security type of the symbol to added [required]
715-
--resolution TEXT The resolution of the symbol to added
758+
--ticker TEXT The ticker of the symbol to add [required]
759+
--market TEXT The market of the symbol to add [required]
760+
--security-type TEXT The security type of the symbol to add [required]
761+
--resolution TEXT The resolution of the symbol to add
716762
--fill-data-forward The fill forward behavior, true to fill forward, false otherwise - defaults to true
717763
--leverage DECIMAL The leverage for the security, defaults to 2 for equity, 50 for forex, and 1 for everything
718764
else
@@ -937,12 +983,12 @@ _See code: [lean/commands/live/liquidate.py](lean/commands/live/liquidate.py)_
937983

938984
### `lean live stop`
939985

940-
Stop an already running local live trading a project.
986+
Stop an already running local live trading project.
941987

942988
```
943989
Usage: lean live stop [OPTIONS] PROJECT
944990
945-
Stop an already running local live trading a project.
991+
Stop an already running local live trading project.
946992
947993
Options:
948994
--lean-config FILE The Lean configuration file that should be used (defaults to the nearest lean.json)
@@ -962,12 +1008,12 @@ Usage: lean live submit-order [OPTIONS] PROJECT
9621008
Represents a command to submit an order to the algorithm.
9631009
9641010
Options:
965-
--ticker TEXT The ticker of the symbol to submitted [required]
966-
--market TEXT The market of the symbol to submitted [required]
967-
--security-type TEXT The security type of the symbol to submitted [required]
1011+
--ticker TEXT The ticker of the symbol to be submitted [required]
1012+
--market TEXT The market of the symbol to be submitted [required]
1013+
--security-type TEXT The security type of the symbol to be submitted [required]
9681014
--order-type TEXT The order type to be submitted [required]
969-
--quantity DECIMAL the number of units to be ordered (directional) [required]
970-
--limit-price DECIMAL The limit price of the order to submitted
1015+
--quantity DECIMAL The number of units to be ordered (directional) [required]
1016+
--limit-price DECIMAL The limit price of the order be submitted
9711017
--stop-price DECIMAL The stop price of the order to be submitted
9721018
--tag TEXT The tag to be attached to the order
9731019
--lean-config FILE The Lean configuration file that should be used (defaults to the nearest lean.json)
@@ -988,8 +1034,8 @@ Usage: lean live update-order [OPTIONS] PROJECT
9881034
9891035
Options:
9901036
--order-id INTEGER The order id to be updated [required]
991-
--quantity DECIMAL the number of units to be ordered (directional)
992-
--limit-price DECIMAL The limit price of the order to updated
1037+
--quantity DECIMAL The number of units to be updated (directional)
1038+
--limit-price DECIMAL The limit price of the order to be updated
9931039
--stop-price DECIMAL The stop price of the order to be updated
9941040
--tag TEXT The tag to be attached to the order
9951041
--lean-config FILE The Lean configuration file that should be used (defaults to the nearest lean.json)

0 commit comments

Comments
 (0)