API Reference

lean gui start


Start the local GUI.

$ lean gui start [options]


Starts the local GUI and opens it in the browser. If you are in multiple organizations, you are asked for the organization that has a subscription for the local GUI before it starts.


The lean gui start command supports the following options:

--organization <value>The name or id of the QuantConnect organization with a license for the local GUI add-on. When this option is provided, the CLI skips the interactive organization selection.
--port <number>The port to run the local GUI on (defaults to 5612).
--no-openDon't open the local GUI in the browser after starting it.
--shortcutCreate a desktop shortcut for launching the local GUI.
--verboseEnable debug logging.
--helpDisplay the help text of the lean gui start command and exit.

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: