Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
**100% Offline, Privacy-First Local RAG Search & Chat Engine for Codebases and Documents**

[![CI](https://github.com/RitualDev-Lab/localrag-kit/actions/workflows/ci.yml/badge.svg)](https://github.com/RitualDev-Lab/localrag-kit/actions)
[![PyPI version](https://img.shields.io/pypi/v/localrag-kit?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/localrag-kit/)
[![Python 3.10+](https://img.shields.io/badge/Python-3.10+-3776AB?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/downloads/)
[![Storage: Pure SQLite](https://img.shields.io/badge/Storage-SQLite%20+%20FTS5%20+%20Vectors-003B57?style=for-the-badge&logo=sqlite&logoColor=white)](https://github.com/RitualDev-Lab/localrag-kit)
[![Tests Passing](https://img.shields.io/badge/Tests-31%20Passing-brightgreen?style=for-the-badge&logo=pytest&logoColor=white)](tests/)
Expand Down Expand Up @@ -38,6 +39,20 @@ Stop paying monthly subscriptions for Pinecone or fighting dependency hell in La
| **Built-in Local Web UI** | <b>βœ… Instant Tailwind Dark UI included</b> | ❌ None (build yourself) | ❌ None |
| **Storage Portability** | <b>βœ… Single portable `.db` file</b> | ❌ Requires external DBs | ❌ Closed proprietary SaaS |

### πŸ›‘οΈ Why 100% Offline RAG vs. Cloud Embeddings APIs

| Dimension | ⚑ 100% Offline LocalRAG | ☁️ Cloud Embeddings APIs (OpenAI / Cohere) |
|---|:---:|:---:|
| **Data Privacy** | **100% Zero Data Leakage** (Never leaves local memory / disk) | Transmitted to 3rd-party servers across the public internet |
| **Retrieval Latency** | **< 5ms** (Direct in-process SQLite + SIMD cosine search) | 120ms - 350ms+ (Network round-trip + external API queue) |
| **Network Reliance** | **100% Air-Gapped & Offline** (Works anywhere without internet) | Fails during network drops or API provider outages |
| **Cost & Metering** | **$0 Forever** (No token fees or tiered subscription costs) | Metered per token/call with unexpected cloud billing spikes |
| **API Keys & Infra** | **Zero Setup** (No API keys or cloud credential rotators) | Secret key management, quota tracking, vendor lock-in |

- πŸ”’ **Zero-Data-Leakage Guarantee**: Codebases, proprietary documents, and private chats remain strictly on local storage. No enterprise IP is ever exposed to cloud providers or used for third-party model training.
- ⚑ **Ultra-Low Latency & High Throughput**: Fast 384-dimensional feature hashing and SIMD vector lookups bypass network hops, API rate limits, and multi-tenant cloud bottlenecks.
- ✈️ **True Air-Gapped Reliability**: Fully operational in restricted corporate enclaves, offline flights, local servers, and secure development environments.

---

## ✨ Features
Expand Down
12 changes: 11 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,19 @@ license = "MIT"
authors = [
{ name = "RitualDev Lab", email = "dev@ritualdev.com" },
]
keywords = ["rag", "llm", "local-first", "offline", "search", "sqlite-vec", "embeddings", "ai"]
keywords = ["local-rag",
"offline-rag",
"private-ai",
"sqlite-vec",
"document-search",
"codebase-rag",
"local-embeddings",
"privacy-first"]

classifiers = [
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"Intended Audience :: Information Technology",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.10",
Expand All @@ -25,6 +34,7 @@ classifiers = [
"Programming Language :: Python :: 3.14",
"Topic :: Scientific/Engineering :: Artificial Intelligence",
"Topic :: Software Development :: Libraries :: Python Modules",
"Topic :: Text Processing :: Indexing",
]
dependencies = [
"pydantic>=2.0.0",
Expand Down