> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arlet.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Dashboard

> How to use the Arlet Dashboard

## Table of Contents

* [Repository Setup](#repository-setup)
* [Running Analysis](#running-analysis)
* [Running Code](#running-code)

***

## Repository Setup

### Add a Repository

Enter the URL of your GitHub repository and click **+ Add Repository** to register it.

<img src="https://mintcdn.com/nexascienceinc/NuouHkV1Lr3jpcs7/images/repo-register.png?fit=max&auto=format&n=NuouHkV1Lr3jpcs7&q=85&s=ba349e6a5e8935c9e57731f182c3f48c" alt="Add a Repository" width="715" height="96" data-path="images/repo-register.png" />

### After Registration

Once registered, you will be taken to a screen where you can select a branch and commit to start the analysis.

<img src="https://mintcdn.com/nexascienceinc/NuouHkV1Lr3jpcs7/images/repo-after-register.png?fit=max&auto=format&n=NuouHkV1Lr3jpcs7&q=85&s=781bc24d04375e5e0154a2091343f5ba" alt="After Registration" width="891" height="440" data-path="images/repo-after-register.png" />

***

## Running Analysis

### Start Analysis

Select a branch and commit, then click **Start Analysis** to run the analysis on your repository.

<img src="https://mintcdn.com/nexascienceinc/NuouHkV1Lr3jpcs7/images/analyze-button.png?fit=max&auto=format&n=NuouHkV1Lr3jpcs7&q=85&s=608af7b00b011d561cfb287285edf354" alt="Start Analysis" width="191" height="59" data-path="images/analyze-button.png" />

When the analysis is complete, the following two items are generated.

### Summary

A summary and description of the repository's code is automatically generated based on its contents.

<img src="https://mintcdn.com/nexascienceinc/NuouHkV1Lr3jpcs7/images/analysis-summary.png?fit=max&auto=format&n=NuouHkV1Lr3jpcs7&q=85&s=9ddf14e89a00f9a82392a667d80e4739" alt="Summary" width="841" height="177" data-path="images/analysis-summary.png" />

### Runs

A list of executable entry points found in the repository is generated. Each entry point includes a description, CLI options, and compute environment settings, and can be run directly via the **Run** button.

<img src="https://mintcdn.com/nexascienceinc/NuouHkV1Lr3jpcs7/images/analysis-entrypoints.png?fit=max&auto=format&n=NuouHkV1Lr3jpcs7&q=85&s=4eba091d2392fac6f0577a8d818f8a8e" alt="Runs" width="861" height="742" data-path="images/analysis-entrypoints.png" />

***

## Running Code

### Entry Point Card

Select the entry point card you want to run from the Runs list. Each card displays the entry point description and its run configuration.

<img src="https://mintcdn.com/nexascienceinc/NuouHkV1Lr3jpcs7/images/entrypoint-card.png?fit=max&auto=format&n=NuouHkV1Lr3jpcs7&q=85&s=c4761ac1465161f6b5db8bd84eee1508" alt="Entry Point Card" width="859" height="190" data-path="images/entrypoint-card.png" />

### Modify Run Config

Expand **Run Config** to change CLI option values and select the compute environment (Compute Type).

<img src="https://mintcdn.com/nexascienceinc/NuouHkV1Lr3jpcs7/images/run-config.png?fit=max&auto=format&n=NuouHkV1Lr3jpcs7&q=85&s=bf87eb9afc1ccedf21040b74048a008c" alt="Modify Run Config" width="806" height="133" data-path="images/run-config.png" />

### Run

Once the configuration is ready, click the **Run** button to start execution.

<img src="https://mintcdn.com/nexascienceinc/NuouHkV1Lr3jpcs7/images/run-button.png?fit=max&auto=format&n=NuouHkV1Lr3jpcs7&q=85&s=3fd002497b7fc278a0328144a72f315b" alt="Run" width="73" height="40" data-path="images/run-button.png" />

### Monitor Execution

When execution starts, a new Run is added to the Runs list at the bottom of the card. The status is updated in real time while running.

<img src="https://mintcdn.com/nexascienceinc/NuouHkV1Lr3jpcs7/images/entrypoint-run.png?fit=max&auto=format&n=NuouHkV1Lr3jpcs7&q=85&s=d35ed97d5ccb8eb9cff0bf9909cfe250" alt="Monitor Execution" width="862" height="545" data-path="images/entrypoint-run.png" />

### Execution Details

Click on a running Run to view the experiment settings, standard output, and standard error in real time.

<img src="https://mintcdn.com/nexascienceinc/NuouHkV1Lr3jpcs7/images/experiment-status.png?fit=max&auto=format&n=NuouHkV1Lr3jpcs7&q=85&s=58a86ed68ab4be731b2ee7c7a2a91aca" alt="Execution Details" width="704" height="657" data-path="images/experiment-status.png" />

### View Results

When execution is complete, the status changes to **Completed** and the results are shown in the standard output.

<img src="https://mintcdn.com/nexascienceinc/NuouHkV1Lr3jpcs7/images/experiment-result.png?fit=max&auto=format&n=NuouHkV1Lr3jpcs7&q=85&s=ddd4225827896ed12dbcb5927ce78c09" alt="View Results" width="674" height="666" data-path="images/experiment-result.png" />
