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

# Dashboard

> How to use the Aixs 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/aixs/KIcyjiZ7QpqCcdVw/images/repo-register.png?fit=max&auto=format&n=KIcyjiZ7QpqCcdVw&q=85&s=c715b1fcd13e77d9ac516ce796f6b2ad" 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/aixs/KIcyjiZ7QpqCcdVw/images/repo-after-register.png?fit=max&auto=format&n=KIcyjiZ7QpqCcdVw&q=85&s=de7b8ceaad6695ce231c470e1c313a24" 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/aixs/KIcyjiZ7QpqCcdVw/images/analyze-button.png?fit=max&auto=format&n=KIcyjiZ7QpqCcdVw&q=85&s=373b98f8ebbf855f43589dec2fdba262" 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/aixs/KIcyjiZ7QpqCcdVw/images/analysis-summary.png?fit=max&auto=format&n=KIcyjiZ7QpqCcdVw&q=85&s=7ed61a98aa2e0d9cc563d0fa27dae288" 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/aixs/KIcyjiZ7QpqCcdVw/images/analysis-entrypoints.png?fit=max&auto=format&n=KIcyjiZ7QpqCcdVw&q=85&s=69f9ec65acbeb535d1e540781a294ef3" 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/aixs/KIcyjiZ7QpqCcdVw/images/entrypoint-card.png?fit=max&auto=format&n=KIcyjiZ7QpqCcdVw&q=85&s=f3327e4ce3e80faa4845b3ce08de6439" 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/aixs/KIcyjiZ7QpqCcdVw/images/run-config.png?fit=max&auto=format&n=KIcyjiZ7QpqCcdVw&q=85&s=80a3339b3d4961834dfa9cbdb6bcfc83" 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/aixs/KIcyjiZ7QpqCcdVw/images/run-button.png?fit=max&auto=format&n=KIcyjiZ7QpqCcdVw&q=85&s=c0327998b3ee53a3b41a107501cbc201" 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/aixs/KIcyjiZ7QpqCcdVw/images/entrypoint-run.png?fit=max&auto=format&n=KIcyjiZ7QpqCcdVw&q=85&s=38eebb15e40fd09272f02e78bab24a59" 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/aixs/KIcyjiZ7QpqCcdVw/images/experiment-status.png?fit=max&auto=format&n=KIcyjiZ7QpqCcdVw&q=85&s=edd1fe40261f254c0bac75bc6bfa004c" 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/aixs/KIcyjiZ7QpqCcdVw/images/experiment-result.png?fit=max&auto=format&n=KIcyjiZ7QpqCcdVw&q=85&s=84977a867e8755bca5d5798d93ca90a5" alt="View Results" width="674" height="666" data-path="images/experiment-result.png" />
