<p align="center">
  <img src="./frontend/public/logo-512.png" alt="OmniScholar logo" width="250" />
</p>

# 📚 OmniScholar

OmniScholar is an AI-powered research platform that runs entirely on your own machine. It brings paper search, a personal library, AI-assisted literature review, and a PDF reader with chat together in one place.

## 📍 Table of Contents

- [📚 Overview](#-overview)
- [🚀 Get Started](#-get-started)

## 📚 Overview

OmniScholar is designed for a focused research workflow: search millions of academic papers, save the ones that matter into your own library, let Claude synthesize literature reviews and answer questions over your collection, and read PDFs inline with an AI side panel. All of your data stays local.

## 🚀 Get Started

OmniScholar is published as an npm package. All you need is [Node.js](https://nodejs.org) 18+ — the Bun runtime it uses is installed automatically:

```bash
# install
npm install -g @frankleeeee/omnischolar

# start the application
omnischolar
```

The app is served at `http://localhost:8000`.

> If you already have [Bun](https://bun.sh) on your `PATH`, OmniScholar uses it; otherwise it falls back to the copy bundled with the package.
