Projects

Follow these steps to open the UI:

1. Log in to the CLI if you haven't done so already.

If you don't log in, the UI only lists your local projects and disables the actions that use the cloud.

2. Open a terminal in the organization workspace.
3. Run lean ui.

   $ lean ui

The UI lists your local projects first and then loads your cloud projects. To refresh the project list, press R. On Linux, the CLI runs lean ui with sudo so the commands that the UI runs can access Docker.

To close the UI, press Q. If a command is running, the UI stops it before closing. The UI waits up to 10 seconds for the command to stop its Docker containers.

The UI displays the following panels:

The header displays the path of the organization workspace and the footer displays the keyboard shortcuts of the current screen. The location column of the project list shows one of the following values:

The UI matches local and cloud projects by the cloud Id in the project configuration. If you delete a cloud project, its local copy shows as local.

Follow these steps to run an action on a project:

1. In the project list, select the project.
2. Press Enter.
3. In the Actions panel, select the action and then press Enter.

To run an action without moving to the Actions panel, press the action key in the project list.

4. If the UI asks you to confirm the command, press Y or Enter to run it.

To cancel, press N or Esc. Backtest actions start without confirmation and open the backtest results.

The following table describes the actions:

If the selected project doesn't meet the requirements of an action, the Actions panel disables the action and shows the reason next to it. If you run a cloud backtest on a local project, the UI pushes the project to the cloud first.

The UI runs one command at a time and shows its output in the Output panel. After a push, a pull, or a cloud backtest, the UI refreshes the project list. Local backtests save their results in the backtests directory of the project.

To view the backtest results of a project, run the View backtest results action. The results screen opens the most recent backtest of the project and shows the following sections:

• A summary of the equity, net profit, return, Probabilistic Sharpe Ratio (PSR), unrealized profit, holdings, fees, and volume.
• The runtime error, if the algorithm throws an exception.
• The Strategy Equity chart.
• The Statistics, Orders, and Logs tabs.

The Orders tab shows the order time in UTC and loads more orders as you scroll down. While a backtest runs, the results screen refreshes every 10 seconds for local backtests and every 15 seconds for cloud backtests. To reload the results, press R.

The results screen lists the local backtests of the project and, if you're logged in, the cloud backtests of the project. To view another backtest, press [ for a newer backtest or ] for an older backtest. To pick a backtest from the full list, press O, enter a part of its name to filter the list, and then press Enter.

To return to the project list, press Esc. For more information about the backtest results, see Results.

To stop the running command, press X. The UI interrupts the command the same way Ctrl+C does, so the command can stop its Docker containers.

If the command doesn't stop, press X again to force the Docker containers to stop. Press X a third time to end the command process.

When you stop a cloud backtest, the UI asks whether to cancel and delete the backtest in the cloud. Press Y to delete it or N to keep the backtest running in the cloud.

The following table describes the keyboard shortcuts of the project list:

The following table describes the keyboard shortcuts of the backtest results screen: