Skip to content

Installation

Prerequisites

  • Python 3.11 or later
  • uv package manager
  • Node.js 18+ (for TypeScript components)

Install Dependencies

# Clone the repository
git clone https://github.com/greynewell/raghelm.git
cd raghelm

# Install Python dependencies with uv
uv sync

# Install Node.js dependencies (optional, for API and dashboard)
pnpm install

Verify Installation

uv run pytest tests/ -v

Environment Configuration

cp .env.example .env

Edit .env with your Pinecone API key, LLM provider keys, and other credentials.

Development Setup

# Install pre-commit hooks
uv run lefthook install

# Lint check
uv run ruff check .