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

# Quickstart

> Start coding with Hypr CLI in less than 2 minutes

## Prerequisites

Before running or compiling Hypr CLI, ensure you have:

* **Bun Runtime**: Bun 1.3.5 or newer installed on your system.
* **API Key**: A valid key for Gemini (`GEMINI_API_KEY`) or Anthropic (`ANTHROPIC_API_KEY`).
* **Zig Compiler**: (Optional) required only if compiling native OpenTUI core extensions manually.

## Get Started

<Steps>
  <Step title="Clone the Repository">
    Clone the codebase to your local machine:

    ```bash theme={null}
    git clone https://github.com/hiroshi-os/Hypr.git
    cd Hypr
    ```
  </Step>

  <Step title="Install Dependencies">
    Install packages using Bun:

    ```bash theme={null}
    bun install
    ```
  </Step>

  <Step title="Configure Environment Keys">
    Export your preferred AI model API keys:

    ```bash theme={null}
    # Windows PowerShell
    $env:GEMINI_API_KEY="your_api_key_here"

    # Linux / macOS Bash
    export GEMINI_API_KEY="your_api_key_here"
    ```
  </Step>

  <Step title="Launch Hypr">
    Run the application directly:

    ```bash theme={null}
    bun start
    ```

    Or compile a single standalone binary:

    ```bash theme={null}
    bun run build
    # Executes compiled binary
    ./dist/hypr
    ```
  </Step>
</Steps>

<Tip>
  To quit or exit the fullscreen alternate TUI screen cleanly, type `exit` or `quit` into the command prompt, or press `Ctrl+C`.
</Tip>