repo-rag
Local RAG indexer and MCP server for AI coding agents. Run it once per repo, and every MCP-compatible agent on your machine - Claude Code, Claude Desktop, Cursor, Windsurf, Codex CLI/Desktop, Gemini CLI, Factory Droid, MiniMax Agent, Antigravity, Aider, Cline, Continue.dev, Zed, and any future
AGENTS.md-aware tool - searches your code through the same hybrid keyword + vector index instead of grepping blind.
Quickstart
# Recommended: isolated global CLI via pipx
pipx install repo-rag
# Or inside an existing project venv
pip install repo-rag
cd /path/to/your/repo
rag init
rag rebuild
rag agents setup --all # writes rules files + MCP configs for every detected agent
rag hooks install # keep the index fresh on every commit / merge / checkout
That's it. Open Claude Code, Cursor, or any other supported agent and ask
"where is auth configured" - the agent will call repo_rag_search first.
repo-ragpulls in lancedb, pyarrow, model2vec, fastembed, tree-sitter, and onnxruntime, so expect roughly 500 MB on disk for the dependency stack regardless of install method.pipxkeeps that footprint in one isolated environment instead of every project venv.
What you get
- One index, every agent. Indexed under
~/.repo-rag/<repo-id>/and shared across every MCP client. No per-tool re-embedding. - Hybrid retrieval. SQLite FTS5 BM25 keyword search plus LanceDB vector search, merged with configurable weights.
- AST-aware chunking by default. Code is split with tree-sitter definition boundaries when the language parser succeeds, with regex chunking as the fallback for unsupported files.
- Local by default. The default
model2vecbackend runs code-specialized static embeddings on CPU (withfastembedas a transformer fallback for prose/docs); your code never leaves your machine and no API keys are needed. - Memory across sessions.
repo_rag_rememberlets agents persist architectural decisions, gotchas, and invariants that surviverag rebuild. - Background-mode git hooks. Re-indexing happens off the critical path
with truncating per-run logs you can
--follow. - Hardware-aware throttling. On Windows,
BELOW_NORMAL_PRIORITY_CLASSplus non-P-core affinity keeps your laptop responsive while indexing.
Supported agents
| Agent | Rules | MCP auto-write | Docs |
|---|---|---|---|
| Factory Droid | ~/.factory/AGENTS.md, <repo>/AGENTS.md |
yes | docs/clients/factory.md |
| Claude (CLI + Desktop) | ~/.claude/CLAUDE.md, <repo>/CLAUDE.md |
yes (CLI + Desktop) | docs/clients/claude.md |
| Codex CLI/Desktop | ~/.codex/AGENTS.md, <repo>/AGENTS.md |
yes (TOML) | docs/clients/codex.md |
| Cursor | ~/.cursor/rules/repo-rag.mdc, <repo>/.cursor/rules/repo-rag.mdc |
yes | docs/clients/cursor.md |
| Windsurf | ~/.codeium/windsurf/global_rules.md, <repo>/.windsurfrules |
yes | docs/clients/windsurf.md |
| Cline | <repo>/AGENTS.md |
manual (VS Code settings) | docs/clients/cline.md |
| Continue.dev | ~/.continue/AGENTS.md, <repo>/AGENTS.md |
yes | docs/clients/continue.md |
| Gemini CLI | ~/.gemini/GEMINI.md, <repo>/GEMINI.md |
yes | docs/clients/gemini.md |
| Google Antigravity | ~/.antigravity/AGENTS.md, <repo>/AGENTS.md |
yes | docs/clients/antigravity.md |
| Aider | ~/.aider/CONVENTIONS.md, <repo>/CONVENTIONS.md |
reference YAML | docs/clients/aider.md |
| MiniMax Agent | <repo>/AGENTS.md |
yes | docs/clients/minimax.md |
| Zed | <zed-config>/.rules, <repo>/.rules |
yes (context_servers) |
docs/clients/zed.md |
| OpenCode (CLI + Desktop) | ~/.config/opencode/CLAUDE.md, <repo>/CLAUDE.md |
yes | docs/clients/opencode.md |
| Universal (AGENTS.md) | ~/.config/repo-rag/AGENTS.md, <repo>/AGENTS.md |
n/a | docs/clients/universal.md |
Run rag agents list for a live table of what is detected on your machine.
MCP tools
The server exposed by rag mcp-server advertises five tools (full reference
in docs/mcp-tools.md):
| Tool | Purpose |
|---|---|
repo_rag_search |
Primary hybrid search; use instead of Grep / ripgrep / Glob. |
repo_rag_get_context |
Markdown context pack for a multi-step task. |
repo_rag_remember |
Persist a durable note for future sessions. |
repo_rag_forget |
Remove a note by id. |
repo_rag_status |
Index health summary. |
Read-only tools are annotated readOnlyHint=true, idempotentHint=true, openWorldHint=false so MCP clients can auto-approve them in strict trust
modes.
Performance highlights
- Very fast indexing with the default
model2vecstatic model (no transformer forward pass); ~3-10 chunks/sec with thefastembedtransformer fallback. - Embedding cache keyed by
(provider, model, dim, sha256(content))makes interrupted rebuilds resume cheaply and lets you switch providers without invalidating the unrelated rows. --window-size,--pace-sec,--sequential,--full-speed, and--threadscover every tuning knob from "go as fast as possible" to "do not interfere with anything I am doing".
See docs/performance.md for the full guide.
Configuration
The global config lives at ~/.repo-rag/config.toml. Override per-repo at
~/.repo-rag/<repo-id>/config.toml. Every value can also be set with an
environment variable (RAG_EMBEDDING_PROVIDER, REPO_RAG_INDEX_DIR, ...).
Before a large rebuild, preview the exact inventory and likely cache/embed work:
rag preview
rag preview --all --sort embed
rag preview /path/to/repo --json
For repo-only exclusions, initialize the repo config and edit its
exclude_globs:
rag config repo-init
rag config show --path /path/to/repo
Full reference: docs/configuration.md.
Storage layout
~/.repo-rag/
registry.json
config.toml
<repo_id>/
metadata.sqlite # files, chunks, FTS5, notes, embedding cache
lancedb/ # vector store
cache/
logs/
Nothing is written inside your repo apart from optional AGENTS.md,
CLAUDE.md, etc. (which you can .gitignore or commit, your choice).
Docker
docker pull ghcr.io/ramanan-bala/repo-rag:latest
{
"mcpServers": {
"repo-rag": {
"command": "docker",
"args": [
"run", "-i", "--rm",
"-v", "~/.repo-rag:/data/.repo-rag",
"ghcr.io/ramanan-bala/repo-rag:latest"
]
}
}
}
Troubleshooting
Common gotchas (Windows model load hang, AV interaction on corporate
machines, hybrid-CPU thread tuning, MCP server PATH issues, etc.) live in
docs/troubleshooting.md.
Contributing
Pull requests welcome. See CONTRIBUTING.md for setup,
test, lint, and release-process notes. To add a new agent plugin, follow
docs/development.md.
License
MIT. See LICENSE.
Code of Conduct: CODE_OF_CONDUCT.md.
Security policy: SECURITY.md.
Metadata
Release files for repo-rag 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| repo_rag-0.3.1.tar.gz | 66.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| repo_rag-0.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 138.7 kB
Release files / repo_rag-0.3.1.tar.gz
| Download URL | repo_rag-0.3.1.tar.gz |
|---|---|
| Size | 66.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2387d32e1f8635ee6c82f3aa167e06a81e99d0c6fccf54619b6a3fc923d9b8b5
|
|
BLAKE2b-256 checksum How to use checksums |
4816dffdc1fbb0d9d7432f7c111364efb10450fe0f150d165f4992aa779c83c6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 9, 2026.
Transparency logRelease files / repo_rag-0.3.1-py3-none-any.whl
| Download URL | repo_rag-0.3.1-py3-none-any.whl |
|---|---|
| Size | 72.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eba2a94f0243fdb2772b095b88eb1eec6640bd13f2839242a16addd1ef84d5ec
|
|
BLAKE2b-256 checksum How to use checksums |
70bb77aff84f679e54f523ccd9709a12afaccec1d8c26785544a1e923e90faf7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 9, 2026.
Transparency log