Skip to main content

RAG Your Code

A local code-retrieval index for coding agents. Ask a question in plain language, get back the functions that answer it — each with its file, its exact line range, the words that matched, and its source.

PyPI License Python

No network calls. No runtime dependencies. No model. It is built to run over a private repository on a machine with the network switched off, and to produce an index a human can read.


The problem it solves

An agent that needs to find something in an unfamiliar codebase has two bad options. It can grep — fast, but it only finds the string you already guessed. Or it can read whole files into context — thorough, but a handful of them exhausts the budget and most of what it read was irrelevant.

This sits in between. It indexes every function, method and class once, then answers a question with the eight units most likely to be relevant, at roughly a hundred lines instead of ten thousand. Every result carries its provenance, so the agent can open the real code before it edits anything, and you can see why each one came back.

It is the R in RAG. There is no generation here — your agent is the G.

Install

As a Claude Code plugin (this is the primary way to use it):

/plugin marketplace add skymanbp/rag-your-code
/plugin install rag-your-code@rag-your-code
/reload-plugins

The plugin is one skill and nothing else — no hooks, no agents, no MCP server. Measured with claude plugin details: ~39 tokens added to every session, and ~1.4k only when the skill actually fires. The skill installs the Python package itself on first use.

Or as a plain CLI:

pip install rag-your-code

rag-your-code index .
rag-your-code search "where are HTTP retries handled" --json
rag-your-code search "what calls the retry handler" --graph --hops 1 --json

The index is written under .rag-your-code/; your source files are never modified. Later index runs reuse unchanged files. For a large repository, prefer rag-your-code index . --compact.

How it works

your repository
  → walk source files (configurable ignores, suffixes, size cap)
  → parse declarations   Python via its own AST; 14 other languages via a
                         line scanner + per-language rule table
  → one CodeUnit each    id, signature, exact line range, source, calls,
                         imports, a stable serial number, a description
  → embed description + source into a deterministic local vector
  → inverted word index + hybrid ranking
  → optional graph expansion over calls / imports / contains
  → results, or a JSON-lines protocol for an agent subprocess

Parsing. Python goes through the standard-library syntax tree, so nesting, qualified names, call lists and line ranges are exact. Every other language goes through three separated layers: a scanner that reads one line at a time, a rule table per language, and a span closer that follows brace depth, Ruby's end, or the next declaration. Because a pattern never sees a second line, a reported line number is the scanner's loop index and cannot drift, and a declaration cannot swallow the ones after it.

Fifteen languages: Python, JavaScript, TypeScript, Go, Rust, Java, Kotlin, Scala, C#, C, C++, Ruby, PHP, Swift, shell.

Graph. calls, imports and contains edges, each conservative: an unresolved or ambiguous reference produces no edge rather than a guessed one, and every expanded result carries the exact edge path as evidence.

What the embedding does — and what it does not

This matters more than any feature list, so it is here rather than in a footnote.

The embedder is a signed feature hash: it hashes words into 384 buckets. Cosine similarity over those vectors is therefore a normalised measure of shared words, and it carries no semantics whatsoever:

pair cosine
retry failed card charge vs itself 1.0000
sum two numbers vs add a pair of integers 0.0000
计算两个数的和 vs sum two numbers 0.0000
sum two numbers vs delete the user database table 0.0000

A trained embedding model scores row 2 at around 0.8. Here a synonym pair and an unrelated pair are indistinguishable, because no shared word is no shared word either way.

Retrieval works regardless, because identifiers and docstrings are already natural languageretry_charge contains retry and charge. But it reaches only concepts somebody wrote down. Two things close the rest of the gap, and neither is a model:

  • Your agent rewrites the query. It has the conversation; turning "重试扣款" into retry charge payment gateway costs it nothing.
  • Your agent writes the descriptions, which puts the missing vocabulary into the index once instead of into every query.

Agent-authored descriptions

Every unit carries a description, and that description is indexed. By default it is generated without a model: the identifier humanised, the parameters and callees listed, the docstring appended. It introduces no vocabulary the source did not already have — which is exactly why retrieval cannot reach a concept nobody wrote down.

The agent already reading the index can supply those words:

rag-your-code describe status              # coverage, and what is pending
rag-your-code describe export --limit 20   # a batch, with source and a brief
rag-your-code describe import written.json # store what the agent wrote
rag-your-code index .                      # apply it

or, in the protocol, describe_pending and describe_put — which take effect in the same session, with no refresh.

Measured on this repository

This project describes its own implementation: all 120 units under src/ carry an agent-written bilingual description, committed to the repo. Ten natural-language questions about the codebase, before and after:

before after
top result in the expected file 2 / 8 6 / 8
Chinese-language queries 0 / 4 3 / 4
queries with no shared word at all (pure fallback) 4 0

Two still miss, and both are worth stating. One query says catastrophic backtracking where the description says backtracks catastrophically: there is no stemming, so those share no word — exactly the limit documented above. The other returned a unit that answers the question from a different file than predicted, so the expectation was wrong rather than the retrieval.

What this is: it moves the semantic work from query time to index time. Matching stays lexical. It is LLM-authored keyword expansion, and its reach is bounded by how many ways of saying the thing the agent thought to write down.

Descriptions live in rag-your-code.descriptions.json at the repository root and are meant to be committed, so one person's pass benefits everyone who clones. Each is keyed by unit id and a digest of the unit's source: when the code changes, the description is not applied, the unit returns to the pending queue, and retrieval falls back to the generated sentence. A description that outlived its code would be a confident wrong answer, which is the one thing this index is built not to give. When code merely moves — an import added above it — the description follows it by digest.

Measured

Parsing, against source-controlled fixtures in tests/fixtures/languages/ (15 fixture files, 96 expected units, 237 negative cases, 89 constructs the spec deliberately excludes):

core declarations found 91 / 91
with the correct start_line 91 / 91
with a usable signature 91 / 91
units that do not exist 0

A 441-byte JavaScript file that once took 12.6 s to parse now takes 0.36 ms, and 10 KB takes 2.1 ms — growth is linear again.

Scale, on a synthetic 10,000-unit repository (500 files):

full build 1.84 s
incremental rebuild after one file changes 0.207 s (8.9x)
compact storage vs readable JSON 35.6%
index load, in a fresh process 45.4 ms
inverted index build 117.7 ms
resident memory 58.7 MiB
query, mean of 200 warmed samples 3.90 ms

Directional local measurements, not service levels; the archived run is large-benchmark-result.json.

Suite: Python 3.10 – 3.13 on Linux and Windows, plus a job that installs the built wheel into a clean environment and runs every command the documentation prescribes, and another that runs the skill's own install line verbatim. 208 tests as of 0.4.2 — the count is version-stamped rather than maintained, because a bare figure in a living document is a claim that rots; per-release counts are in CHANGELOG.md.

Configuration

Twelve settings in rag-your-code.toml at the repository root:

rag-your-code config init                     # a commented file, all defaults
rag-your-code config list                     # effective values and their source
rag-your-code config set index.ignore '["vendor", "generated"]'
rag-your-code config set search.vector_weight 0.25
section settings
[index] ignore, suffixes, max_file_bytes
[embedding] dimensions
[search] vector_weight, limit, max_chars
[agent] max_open_bytes, max_open_chars
[describe] languages, batch, max_chars

Resolution is CLI flag > file > built-in default. There is no environment layer: an index is an artifact of a repository, not of a shell.

An unknown key or an out-of-range value is an error, not a shrug — a setting silently dropped is indistinguishable from one that had no effect. index.suffixes may only name suffixes the parser has rules for, because a suffix it cannot read is walked, parsed to nothing, and reported as a clean index of zero units.

The four settings under [index] and [embedding] decide what an index contains, so a digest of them is stored in the index and a change forces a full rebuild. The rest take effect immediately and invalidate nothing.

Agent protocol

rag-your-code agent --root PATH reads one JSON request per line and writes one reply per line:

{"action":"search","query":"database transaction rollback","limit":5}
{"action":"research","query":"trace payment retry behavior","max_steps":2}
{"action":"neighbors","id":"payments.py:4:retry_charge","hops":1}
{"action":"open","path":"payments.py","start_line":1,"end_line":80}
{"action":"describe_pending","limit":20}
{"action":"describe_put","descriptions":[{"id":"payments.py:4:retry_charge","text":"..."}]}
{"action":"refresh"}
{"action":"stats"}

No single request can end the session. Numeric fields saturate at their bounds, open is bounded in both lines and bytes, and anything unanticipated is reported in-band with its exception type. Streams are pinned to UTF-8 rather than following the console codepage.

research is a deliberately bounded two-step controller: retrieve, then at most one graph expansion when confidence is low, reporting each step and why it stopped.

What lives where

path authored or generated commit it?
rag-your-code.toml authored yes
rag-your-code.descriptions.json authored by your agent yes
.rag-your-code/ (index, vectors, annotations) generated no

Nothing authored lives under .rag-your-code/ — that directory is what people delete to clear the cache.

Not here yet

Provider-backed embeddings, Tree-sitter parsing, and a SQLite/ANN storage layer for repositories past the measured JSON envelope. Agent-authored descriptions are deliberately the cheaper answer to the same problem provider embeddings solve: they keep the zero-dependency, offline, reproducible-index properties, and produce text a human can read and correct rather than opaque floats. See docs/ROADMAP.md.

Development

python -m pip install -e ".[dev]"
pytest -q

No runtime dependencies; pytest and, below Python 3.11, tomli come from the dev extra.

MIT licensed.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rag_your_code-0.4.2.tar.gz (68.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rag_your_code-0.4.2-py3-none-any.whl (52.6 kB view details)

Uploaded Python 3

File details

Details for the file rag_your_code-0.4.2.tar.gz.

File metadata

  • Download URL: rag_your_code-0.4.2.tar.gz
  • Upload date:
  • Size: 68.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for rag_your_code-0.4.2.tar.gz
Algorithm Hash digest
SHA256 2788d3a527dce42464cc71726ffaa554892d9f226f75c222fd2c1e71b75fb0d7
MD5 ad02134bc884a0349874d624d34cde3c
BLAKE2b-256 8e74b62f46dd09cbfa3b37687e4fa8b7db682b32b2532937a4763e4487dc1a66

See more details on using hashes here.

Provenance

The following attestation bundles were made for rag_your_code-0.4.2.tar.gz:

Publisher: release.yml on skymanbp/rag-your-code

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rag_your_code-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: rag_your_code-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 52.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for rag_your_code-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8127e0e5e31f6fd1c3af643e912bd967836fdd936fba0353aecff0c01672a653
MD5 09dd3f617bbf013c5873d6ec4067883e
BLAKE2b-256 eeffe8e446ac96881a0408c52b67cb1965b3b63bbf4281e64dabfb5b81db2ad2

See more details on using hashes here.

Provenance

The following attestation bundles were made for rag_your_code-0.4.2-py3-none-any.whl:

Publisher: release.yml on skymanbp/rag-your-code

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.5.2

2 files

1.5.1

2 files

1.5.0

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.0

2 files

1.2.1

2 files

1.2.0

2 files

1.1.0

2 files

1.0.0

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.0

2 files

This release

0.4.2 This release

2 files

0.4.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page