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

1. Clone the Repository

   Clone the codebase to your local machine:

   git clone https://github.com/hiroshi-os/Hypr.git
   cd Hypr
   
2. Install Dependencies

   Install packages using Bun:

   bun install
   
3. Configure Environment Keys

   Export your preferred AI model API keys:

   # Windows PowerShell
   $env:GEMINI_API_KEY="your_api_key_here"
   
   # Linux / macOS Bash
   export GEMINI_API_KEY="your_api_key_here"
   
4. Launch Hypr

   Run the application directly:

   bun start
   

   Or compile a single standalone binary:

   bun run build
   # Executes compiled binary
   ./dist/hypr
   

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