Getting Started

Prerequisites

Node.js 18+
Python 3.10+
An OpenAI API key

Install


pnpm install
# or: npm install

Configure Environment

Create .env from the example and set your key:


cp .env.example .env

Required variable:

OPENAI_API_KEY: Used by GraphRAG models (referenced in settings.yaml).

Tip: In production, prefer .env.local and do not commit secrets.

Configure GraphRAG

The pipeline is configured via settings.yaml (preconfigured for OpenAI). You can tune models, chunking, and workflows later. See Configuration for details.

Run the App


pnpm dev
# or: npm run dev

Open http://localhost:3000 and follow the on-screen guidance.

First Graph in 3 Steps

Upload PDFs on the Corpus panel (left side)
Click “Run Index” and watch progress
Explore the 3D graph; search with Cmd/Ctrl+K