# Local RAG

![local-rag-demo](demo.gif)

[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8588/badge)](https://www.bestpractices.dev/projects/8588)
![GitHub Commit Activity](https://img.shields.io/github/commit-activity/t/jonfairbanks/local-rag)
![GitHub Last Commit](https://img.shields.io/github/last-commit/jonfairbanks/local-rag)
![GitHub License](https://img.shields.io/github/license/jonfairbanks/local-rag)

Offline, open-source retrieval augmented generation.

Ingest local files, GitHub repositories, and websites for retrieval augmented generation (RAG) with local Ollama models. Local RAG keeps chat, embeddings, and indexed source content on your machine or network.

Features:

- Local Ollama chat models
- Ollama or local Hugging Face embedding models
- Multiple ingestion sources:
  - Local files
  - GitHub repositories
  - Websites
- Streaming RAG responses through LlamaIndex
- Browser-local settings persistence
- Chat history export
- Upload, URL, repository, and ingestion guardrails

Learn More:

- [Setup & Deploy the App](docs/setup.md)
- [Using Local RAG](docs/usage.md)
- [RAG Pipeline](docs/pipeline.md)
- [Planned Features](docs/todo.md)
- [Troubleshooting](docs/troubleshooting.md)
- [Known Bugs & Issues](docs/todo.md#known-issues--bugs)
- [Resources](docs/resources.md)
- [Contributing](docs/contributing.md)
- [Security Policy](SECURITY.md)
- [Changelog](CHANGELOG.md)