Tutorials

Local GUI

Introduction

The local GUI is an add-on to the CLI which provides a graphical user interface similar to the one provided on QuantConnect. This GUI makes it easier to use the CLI to run backtests, optimizations and live deployments locally. It also provides rich and interactive visualizations to all of these, including live updates while backtests and live deployments are running.

The local GUI is a paid addition to the CLI and can be subscribed to on the Pricing page.

Managing the local GUI

Follow these steps to start the local GUI:

  1. Log in to the CLI if you haven't done so already.
  2. Open a terminal in the directory you ran lean init in.
  3. Run lean gui start and select the organization with the GUI subscription to start the latest version of the local GUI.
    $ lean gui start
    Select the organization with the GUI module subscription:
    1) Organization 1
    2) Organization 2
    3) Organization 3
    Enter an option: 1
    Downloading 'QuantConnect.GUI.2.5.12525.nupkg'
    Starting the local GUI, this may take some time...
    The organization selection is skipped if you are only a member of a single organization.
  4. Enjoy the local GUI in the browser, which opens automatically after starting the local GUI.

Follow these steps to stop the local GUI:

  1. Open a terminal.
  2. Run lean gui stop to stop the local GUI.
    $ lean gui stop
    Successfully stopped the local GUI

Desktop shortcut

The first time you launch the GUI you are asked whether you want to create a desktop shortcut for launching the local GUI.

$ lean gui start
Do you want to create a desktop shortcut to launch the local GUI? [Y/n]: y
Successfully created a desktop shortcut for launching the local GUI
Starting the local GUI, this may take some time...
The local GUI has started and is running on http://localhost:5612/

If you want to create a desktop shortcut for launching the local GUI at a later time, you can provide the --shortcut flag to lean gui start when you start the local GUI.

$ lean gui start --shortcut
Successfully created a desktop shortcut for launching the local GUI
Starting the local GUI, this may take some time...
The local GUI has started and is running on http://localhost:5612/

Reporting issues

If you find a bug in the local GUI, you can make it a lot easier for us to help you if you provide us with the recent logs of the local GUI. There are two types of logs, those of the front-end and those of the back-end. Depending on your issue you may find errors in either one or both of those.

Follow these steps to get the logs of the front-end:

  1. Focus your browser window.
  2. Press F12 to open the browser's developer console.
  3. Open the Console tab in the developer console that opens to view the front-end logs.
  4. If you see any red messages (errors), take a screenshot of them and the surrounding messages. Feel free to mask any personal details that you don't want to share.

Follow these steps to get the logs of the back-end:

  1. Open a terminal.
  2. Run lean gui logs to show the logs of the back-end.
    $ lean gui logs
    The local server is running on http://localhost:5612/
    <-- GET /
  3. If you see any stack traces, please copy the lines containing the stack trace and the surrounding lines. Feel free to mask any personal details that you don't want to share.

You can send these logs along with a description of the issue via the regular support channels.

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

Did you find this page helpful?

Contribute to the documentation: