Skip to content

Installation

Prerequisites

  • Python 3.11 or later
  • uv package manager
  • Node.js 20+ for TypeScript packages
  • pnpm for TypeScript packages

Install dependencies

git clone https://github.com/greynewell/raghelm.git
cd raghelm

uv sync --extra dev
pnpm install
cd packages/api && pnpm install && cd ../..
cd packages/dashboard && pnpm install && cd ../..

Verify installation

uv run pytest tests/ -q
uv run mkdocs build --strict

Environment configuration

cp .env.example .env

Edit .env with Pinecone and LLM provider credentials only when you need hosted ingestion, hosted retrieval, production evals, or production judge behavior.

For local development without hosted Pinecone:

RAGHELM_PINECONE_MODE=local
PINECONE_LOCAL_URL=http://localhost:5080

For safe ingestion previews that do not call embedding or vector APIs, use --dry-run.

Production-mode expectations

Production eval mode is intentionally stricter than local mode:

  • Pinecone and LLM provider configuration must be present.
  • Missing production config should fail closed rather than producing misleading evidence.
  • Public quality claims require a production ReadinessScorecard linked to a valid production RAGRunManifest.
  • Private source content, credentials, and sensitive traces must not appear in public proof artifacts.

Development commands

uv run ruff check .
uv run pytest tests/ -q
uv run mkdocs build --strict
pnpm run format:check