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

# Quickstart

> Get up and running with the LynxHub desktop application.

LynxHub consolidates your AI workflow into a single, unified workspace.

You can configure, manage, and run local AI interfaces.

## Prerequisites

Before you install LynxHub, make sure you have the required software on your system:

* **Git:** Install the latest version of [Git](https://git-scm.com/downloads) to handle repository operations.
* **PowerShell 7+ (Windows only):** Download and install [PowerShell 7+](https://github.com/PowerShell/PowerShell/releases/latest) for terminal operations.

## Get started

Follow these steps to set up and run LynxHub.

<Steps>
  <Step title="Download LynxHub">
    Get the latest release of LynxHub:

    * Download public releases from [GitHub Releases](https://github.com/KindaBrazy/LynxHub/releases/latest) or the official [Download Page](https://lynxhub.app/download).
    * Get insider or early access versions from the [Patreon Collection](https://www.patreon.com/collection/714004).
  </Step>

  <Step title="Install and launch">
    Run the downloaded installer or launch the portable executable on your machine.

    If you are on macOS:

    1. Right-click (or Control-click) the application.
    2. Click **Open** from the menu.
    3. Click **Open** in the security confirmation dialog.

    You only need to perform this bypass on the first launch.
  </Step>

  <Step title="Select an AI tool">
    When the app starts, you see a catalog of preloaded AI tools on the dashboard. Use the search bar at the top or filter by categories to find the tool you want to
    install. Click on the tool's card to open the installation menu.
  </Step>

  <Step title="Install or locate the WebUI">
    Choose to either perform a fresh installation or link a pre-existing directory:

    * **To install fresh:** Click the clone option in the modal to begin download and setup.
    * **To locate an existing installation:** Click the **Locate** button at the bottom of the installation window and select your existing WebUI folder on your drive.
  </Step>

  <Step title="Configure arguments">
    Click the **3 dots menu** on your interface card and select **Launch Config**. Use the visual argument manager to enable desired flags. You can save presets here for
    quick switching.
  </Step>

  <Step title="Launch the interface">
    Click directly on the card itself to start the WebUI.

    LynxHub starts the backend process in a built-in terminal tab, and the built-in browser automatically loads the interface when ready.
  </Step>
</Steps>

## Explore features

Once you are set up, explore more capabilities built into LynxHub:

* **Git Control:** Select **Repo Config** from the **3 dots menu** to switch branches, stash changes, and reset repositories.
* **Auto Updates & Updates:** Toggle auto-updates or manually check for new versions of WebUI modules directly from the card options.
* **Terminal & Browser Workspace:** Switch tabs or spawn separate windows for terminal commands and web browsing.

<Tip>If you run into issues, join the community on the [LynxHub Discord](https://discord.gg/e8rBzhtcnK).</Tip>
