Skip to content

kpeez/paperchat

Repository files navigation

PaperChat logo


Paperchat is an AI-powered assistant that helps you take your research to the next level by enabling you to chat with your research library.

Installation

The easiest and fastest way to install PaperChat is using uv:

uv tool install git+https://github.com/kpeez/paperchat.git

This will install PaperChat and make it available as a command-line tool.

To launch PaperChat, run:

paperchat

Alternatively, you can install PaperChat into your Python environment (requires Python 3.12 or newer):

pip install git+https://github.com/kpeez/paperchat.git

and then launch PaperChat by running:

paperchat

Quick Start

  1. Launch PaperChat: paperchat
  2. Upload a PDF document using the sidebar
  3. Wait for processing to complete
  4. Start asking questions about your document!

Settings

PaperChat uses your own model API keys to connect to the AI providers. If you have API keys set as environment variables, they will be automatically detected. Otherwise, you can set them in the settings page. To get API keys, you can sign up for a free account on the providers' websites:

  • Gemini (recommended)
    • This is the recommend provider since you can access models for free (e.g., gemini-2.5-pro-exp-03-25 and gemini-2.0-flash), and their text-embedding model is currently the best available on the MTEB leaderboard.
  • OpenAI
  • Anthropic

Troubleshooting

About

An AI research assistant leveraging RAG to communicate with your research papers

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages