Spaces:
Runtime error
Runtime error
File size: 10,430 Bytes
28aea4f 036a2db 28aea4f 036a2db | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 | ---
title: Diffcontext
emoji: π
colorFrom: blue
colorTo: indigo
sdk: docker
app_port: 7860
---
# DiffContext
Static-analysis-powered repository context compiler for LLMs.
**Git diff + AST parsing + dependency graph + blast radius + impact scoring β optimized context package**
Instead of dumping an entire codebase (or doing keyword/vector search), DiffContext:
1. **Parses** Python files via AST β extracts every function, method, class
2. **Builds a dependency graph** β calls, imports, inheritance, attribute ownership, decorators
3. **Detects changes** β via git diff (including uncommitted edits) or snapshot comparison
4. **Computes blast radius** β everything transitively affected by the change
5. **Scores impact** β prioritizes symbols by structural importance
6. **Selects relevant code** β respects a token budget
7. **Compiles context** β structured output ready to paste into an LLM
On a real ~1,100-symbol production repo, this reliably produces **95β99% token
reduction** versus pasting the whole codebase, while keeping the functions that
are actually call-graph-connected to your change.
## Quick Start
### Step 1: Install
```bash
git clone https://github.com/trakshan-mishra/Diffcontext.git
cd Diffcontext
pip install -e .
diffcontext --help
```
### Step 2: Index a repository
```bash
diffcontext index /path/to/any/python/project
```
If any file fails to parse (a real `SyntaxError`), it's reported explicitly β
not silently skipped:
```
Skipping broken_file.py due to SyntaxError: unmatched ')' (line 237)
```
### Step 3: Check impact of a function you're working on
This is the recommended default mode while actively editing β it doesn't
depend on git at all, so it works on uncommitted or untracked files too:
```bash
diffcontext blast --changed ./src/auth.py:validate_jwt
```
Shows who calls it, what it calls, and the full transitive blast radius.
### Step 4: Auto-detect changes from git (optional)
```bash
diffcontext diff
```
Compares your working tree (including uncommitted edits to **tracked** files)
against `HEAD~1` by default. Note: this only sees changes to files git
already knows about β a brand-new untracked file is invisible to any
git-diff-based tool until you `git add -N <file>` or commit it. Use
`--committed-only` to compare two commits and ignore working-tree changes.
### Step 5: Build LLM-ready context
```bash
# From a specific function:
diffcontext compile --changed ./src/auth.py:validate_jwt
# From git diff:
diffcontext compile --ref HEAD~1
# With a token budget:
diffcontext compile --changed ./src/auth.py:validate_jwt --max-tokens 8000
# JSON output (for piping into another tool):
diffcontext compile --changed ./src/auth.py:validate_jwt --json
```
Then paste the output into Claude / ChatGPT / your LLM of choice, **with a
specific question** β not just the raw context. E.g.:
> "Is the dynamic SQL construction in `update_run` safe, given how `kwargs`
> is validated against `_UPDATABLE_RUN_COLUMNS`?"
### Step 6: Use as a library
```python
from diffcontext.pipeline import index_repository, analyze_impact, compile
idx = index_repository("/path/to/repo")
impact = analyze_impact(idx, ["./src/auth.py:validate_jwt"])
ctx = compile(idx, impact, max_tokens=10000)
print(ctx.text) # the context to send to the LLM
print(f"{ctx.token_estimate:,} / {ctx.total_repo_tokens:,} tokens")
print(f"{ctx.reduction_pct:.1f}% reduction")
```
See `USAGE.md` for the full day-to-day workflow, including shell aliases.
### Step 7: Cloud sync (CtxSync) (yet to be impemented)
```bash
diffcontext sync
```
One command. Compiles blast radius and pushes to your CtxSync cloud endpoint.
Credentials are read from `~/.ctxsync`, env vars, or `--url`/`--key` flags.
### Step 8: Use as an MCP Server (Claude Desktop / Cursor)
DiffContext includes a built-in **Model Context Protocol (MCP)** server, allowing AI assistants to natively query your codebase's blast radius without manual copy-pasting.
**1. Install with MCP support:**
```bash
pip install -e .[mcp]
```
**2. Configure your AI client:**
For Claude Desktop (`claude_desktop_config.json`) or Cursor:
```json
{
"mcpServers": {
"diffcontext": {
"command": "diffcontext-mcp"
}
}
}
```
Now you can just ask your AI: *"What is the blast radius of validate_jwt in the diffcontext repo?"* and it will autonomously use DiffContext to find the precise context!
## What the resolver actually handles
Confirmed via an automated test suite (`tests/`) that builds small repos on
the fly and asserts on real resolved call-graph edges β not just "it ran
without crashing":
- Function and method calls, including multi-hop attribute chains (`self.a.b.method()`)
- Multiple inheritance / MRO, including cross-file base classes
- Circular imports
- Local variables instantiating a class inside a **free function** (not just
`self.x = ...` inside a method) β e.g. `h = Handler(); h.process()`
- Annotated parameters as call receivers (`def run(h: Handler): h.process()`)
- Import aliasing (`from .user import Handler as UserHandler`), including
disambiguating two same-named classes in different files
- Bare `import x` where `x` lives in a sibling directory rather than the
repo root (common in script-style codebases)
- **Decorators**: a decorated function's graph entry now correctly includes
calls made by its decorator's wrapper β e.g. `@require_auth` wrapping
`get_profile` correctly shows `get_profile` depending on whatever
`require_auth`'s wrapper calls (like a session check), not falsely
attributed to `require_auth` itself
- Higher-order stdlib functions: `map(fn, items)`, `sorted(x, key=fn)`,
`filter(fn, items)` β a function passed *by reference* to these is
tracked as an implicit call
## Known limitations (genuinely unfixable by static analysis, not bugs)
- **Dynamic dispatch / `getattr()`-based routing**: `getattr(obj, name)()`
can't be resolved statically when `name` is computed at runtime (from
config, user input, etc.) β no static analysis tool can do this in
general, including IDEs.
- **Cross-file changes related by theme, not by function calls**: e.g. "remove
a dependency," touching 3 files for one conceptual reason with no direct
call-graph edges between them. Blast radius is a call-graph tool; it
cannot detect relatedness that isn't expressed as a function call.
- **User-defined higher-order functions**: only the common stdlib cases
(`map`, `filter`, `sorted`/`max`/`min` with `key=`) are recognized.
A custom function like `def apply_twice(fn, value): return fn(fn(value))`
is not β this would need cross-function signature analysis to know which
parameter is expected to be callable.
Run `grep -rn "function_name(" --include="*.py" .` to spot-check anything
important before fully trusting "no callers found."
## Architecture
```
diffcontext/
βββ __init__.py # Package entry, high-level API
βββ models.py # Data classes (Symbol, RepositoryIndex, etc.)
βββ scanner.py # File discovery with exclusion list
βββ parser.py # AST symbol extraction
βββ resolver.py # Import -> filesystem path resolution
βββ symbols.py # Attribute / local-var type tracking
βββ graph_builder.py # Core: dependency graph construction
βββ pipeline.py # Pipeline orchestrator
βββ _warn_once.py # De-duplicated warnings (broken files, encoding, unknown symbols)
βββ diff/
β βββ git_diff.py # Git diff -> changed symbols
β βββ state_manager.py # Snapshot-based change detection
βββ impact/
β βββ blast_radius.py # Reverse graph traversal
β βββ scoring.py # Impact scoring
β βββ traversal.py # Forward dependency expansion
β βββ visualizer.py # Terminal tree rendering
βββ context/
β βββ selector.py # Token-budget-aware selection
β βββ compiler.py # Structured output formatting
βββ cli/
βββ __init__.py # CLI: index, impact, diff, compile, blast, sync
```
## Try it (30 seconds)
```bash
bash demos.sh # interactive β pick from 5 famous repos or use your own
```
## How symbol IDs work
Every function gets a unique ID: `./relative/path.py:ClassName.method_name`
```
./src/auth.py:validate_jwt
./src/flask/app.py:Flask.route
```
**No parentheses, no arguments** β `validate_jwt`, never `validate_jwt(token)`.
## Testing
```bash
python3 -m pytest tests/ -v
```
17 tests, all self-contained (no external clone needed), covering both
correct resolution and the documented limitations above β including tests
that were written to fail loudly if a future change silently regresses
something that's currently working.
## Status
This is a personal project, built and iteratively debugged against real
production codebases (openai/whisper, pallets/click, pallets/flask). Several
real resolver bugs were found and fixed through dogfooding β decorators,
higher-order functions, and sibling-directory imports all required fixes
that were only visible on real code, not toy examples. Treat blast-radius
output as a strong starting point, not a guarantee, and spot-check with
`grep` on anything load-bearing.
## License
MIT
## Benchmarks & Performance (Baseline)
We adhere strictly to **Measure Before Optimizing**. Our baseline metrics demonstrate that traversal and compilation are nearly instantaneous, while parsing and graph construction are the primary bottlenecks. This data drives our roadmap for v0.4 (Incremental Caching).
| Repo | Files | Symbols | Parse (ms) | Graph Build (ms) | Traversal (ms) | Compile (ms) | Token Reduction |
| --- | --- | --- | --- | --- | --- | --- | --- |
| **Flask** | 20 | 354 | 488 | 930 | 0.1 | 0.0 | 98.15% |
| **Click** | 19 | 506 | 1273 | 1824 | 0.2 | 0.0 | 96.51% |
| **HTTPX** | 21 | 434 | 665 | 1147 | 0.1 | 0.0 | 96.70% |
| **Pydantic** | 90 | 1826 | 4519 | 7914 | 0.6 | 0.0 | 98.43% |
*Note: Peak memory for Pydantic (the largest repo) was only 66.4 MB, validating that memory is not currently a bottleneck.*
|