API Reference

lean live

Introduction

Interact with the local machine.

$ lean live [OPTIONS] COMMAND [ARGS]...

To use the CLI, you must be a member in an organization on a paid tier.

Description

The lean live command provides subcommands for managing live trading on your local machine using Docker. Use lean live deploy to start a new local live deployment, lean live stop to stop a running deployment, and lean live liquidate to liquidate positions in a running deployment.

You can also interact with a running algorithm using lean live add-security, lean live submit-order, lean live cancel-order, lean live update-order, and lean live command. See the subcommand pages for full details on each operation.

Options

The lean live command supports the following options:

OptionDescription
--helpDisplay the help text of the lean live command and exit

Commands

The lean live command expects the following arguments:

ArgumentDescription
add-securityRepresents a command to add a security to the algorithm
cancel-orderRepresents a command to cancel a specific order by id
commandSend a command to a local running live trading project
deployStart live trading a project locally using Docker
liquidateLiquidate the given symbol from the latest deployment of the given project
stopStop an already running local live trading project
submit-orderRepresents a command to submit an order to the algorithm
update-orderRepresents a command to update a specific order by id

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: