rekipedia 0.21.2 → 0.22.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +185 -118
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,25 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<img src="https://capsule-render.vercel.app/api?type=waving&color=gradient&customColorList=6,11,20&height=170§ion=header&text=rekipedia&fontSize=52&fontColor=ffffff&fontAlignY=38&desc=Turn+any+repo+into+an+AI-ready+knowledge+base&descAlignY=58&descSize=14" alt="Header"/>
|
|
4
|
+
|
|
5
|
+
[](https://pypi.org/project/rekipedia/)
|
|
6
|
+
[](https://www.python.org/)
|
|
7
|
+
[](LICENSE)
|
|
8
|
+
[](https://modelcontextprotocol.io)
|
|
9
|
+
|
|
10
|
+
</div>
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
1
14
|
# rekipedia
|
|
2
15
|
|
|
3
|
-
**
|
|
16
|
+
> **One scan. A living wiki. AI agents that actually know your code.**
|
|
17
|
+
>
|
|
18
|
+
> Parse any codebase into a structured SQLite knowledge store, auto-generate wiki pages, and expose everything via CLI and an MCP stdio server — with file:line citations and zero hallucinations.
|
|
4
19
|
|
|
5
|
-
[](https://pypi.org/project/rekipedia/)
|
|
20
|
+
[](https://pypi.org/project/rekipedia/)
|
|
21
|
+
[](https://www.python.org/)
|
|
22
|
+
[](LICENSE)
|
|
6
23
|
|
|
7
24
|
---
|
|
8
25
|
|
|
@@ -13,29 +30,71 @@
|
|
|
13
30
|
| "Where does the auth logic live?" | `reki ask "how does auth work?"` → `src/auth.py:42` |
|
|
14
31
|
| Onboarding new devs takes days | `reki onboard .` generates a guided walkthrough in seconds |
|
|
15
32
|
| AI agents hallucinate about your codebase | `reki mcp` gives agents a grounded knowledge base with citations |
|
|
16
|
-
| Refactor anxiety | `reki hotspots` surfaces hub
|
|
33
|
+
| Refactor anxiety — will this break everything? | `reki hotspots` surfaces hub and bridge nodes before you touch anything |
|
|
17
34
|
| Wiki goes stale immediately | `reki watch .` auto-reindexes on every file save |
|
|
18
35
|
|
|
19
36
|
---
|
|
20
37
|
|
|
21
38
|
## ⚡ Quickstart
|
|
22
39
|
|
|
40
|
+
### Install
|
|
41
|
+
|
|
23
42
|
```bash
|
|
24
43
|
pip install rekipedia
|
|
25
44
|
# or: npx rekipedia
|
|
26
45
|
```
|
|
27
46
|
|
|
28
|
-
###
|
|
47
|
+
### Scan & Ask (with LLM)
|
|
29
48
|
|
|
30
49
|
```bash
|
|
31
|
-
export
|
|
50
|
+
export REKIPEDIA_MODEL=gemini/gemini-2.5-flash
|
|
51
|
+
export GOOGLE_API_KEY=...
|
|
32
52
|
reki scan .
|
|
33
53
|
reki ask "how does authentication work?"
|
|
34
54
|
```
|
|
35
55
|
|
|
56
|
+
### Scan without LLM (zero config, no API key)
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
reki scan . --no-llm
|
|
60
|
+
reki ask "what is the entry point?" --no-llm
|
|
61
|
+
```
|
|
62
|
+
|
|
36
63
|
---
|
|
37
64
|
|
|
38
|
-
##
|
|
65
|
+
## 🏗️ Architecture & Data Storage
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
.rekipedia/
|
|
69
|
+
│
|
|
70
|
+
├── store.db # 🗃️ Structured SQLite graph
|
|
71
|
+
│ └── symbols, relationships, file manifests, scan history
|
|
72
|
+
│
|
|
73
|
+
├── rag/
|
|
74
|
+
│ └── faiss.index # 🔍 Dense embedding vectors (FAISS / Qdrant / Chroma)
|
|
75
|
+
│
|
|
76
|
+
├── wiki/
|
|
77
|
+
│ └── *.md # 📄 Auto-generated wiki pages per module
|
|
78
|
+
│
|
|
79
|
+
├── diagrams/
|
|
80
|
+
│ └── *.md # 🏛️ Architecture diagrams & hotspot reports
|
|
81
|
+
│
|
|
82
|
+
└── config.yml # ⚙️ Backend, LLM, and team-sync settings
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Storage at a Glance
|
|
86
|
+
|
|
87
|
+
| Layer | Format | Purpose | Size (typical 50k–200k LOC repo) |
|
|
88
|
+
|---|---|---|---|
|
|
89
|
+
| **SQLite** | `store.db` | Structured graph — symbols, callers, exact lookup | ~10–80 MB |
|
|
90
|
+
| **Vector** | `.rekipedia/rag/` | Dense embeddings for semantic / fuzzy search | ~50–500 MB |
|
|
91
|
+
| **Wiki** | `wiki/*.md` | Human-readable pages, git-publishable | ~1–5 MB |
|
|
92
|
+
|
|
93
|
+
> **Gitignore note:** `store.db` and `rag/` are gitignored — they contain machine-specific absolute paths. Each developer runs `reki scan .` locally. Share human-readable output via `reki publish .`.
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## 🚀 Core Features
|
|
39
98
|
|
|
40
99
|
### 🗂 `reki scan` — Instant knowledge store
|
|
41
100
|
|
|
@@ -48,15 +107,16 @@ reki scan . --no-llm # zero config, no API key required
|
|
|
48
107
|
|
|
49
108
|
### 💬 `reki ask` — Q&A grounded in your code
|
|
50
109
|
|
|
51
|
-
Answers
|
|
110
|
+
Answers with **file:line citations and real code examples**. No hallucinations — every answer is backed by indexed source, with actual function bodies quoted inline.
|
|
52
111
|
|
|
53
112
|
```bash
|
|
54
113
|
reki ask "what is the entry point?"
|
|
55
114
|
reki ask "which modules handle payments?" --brief
|
|
56
115
|
```
|
|
57
116
|
|
|
117
|
+
**Example output:**
|
|
58
118
|
```
|
|
59
|
-
Answer: The entry point is src/main.py:12 —
|
|
119
|
+
Answer: The entry point is src/main.py:12 — App.run() bootstraps the server.
|
|
60
120
|
|
|
61
121
|
```python
|
|
62
122
|
# src/main.py:12
|
|
@@ -68,28 +128,39 @@ def run(self):
|
|
|
68
128
|
Sources: src/main.py:12, src/server.py:34
|
|
69
129
|
```
|
|
70
130
|
|
|
71
|
-
**How it works:** rekipedia extracts
|
|
131
|
+
**How it works:** rekipedia extracts actual source bodies of the most relevant functions/classes and passes them directly to the LLM — so answers include real, runnable code, not just paraphrases. When a FAISS index exists (`reki embed .`), RAG chunks are used for even higher precision.
|
|
72
132
|
|
|
73
133
|
### 🤖 `reki mcp` — MCP server for AI agents
|
|
74
134
|
|
|
75
|
-
Plug rekipedia directly into Claude Code, Cursor, or any MCP-aware agent.
|
|
135
|
+
Plug rekipedia directly into Claude Code, Cursor, GitHub Copilot, or any MCP-aware agent.
|
|
76
136
|
|
|
77
137
|
```bash
|
|
78
138
|
reki mcp
|
|
79
139
|
```
|
|
80
140
|
|
|
81
|
-
Available tools
|
|
141
|
+
**Available MCP tools:**
|
|
142
|
+
|
|
143
|
+
| Tool | Purpose |
|
|
144
|
+
|---|---|
|
|
145
|
+
| `ask` | Natural-language Q&A grounded in the scanned wiki |
|
|
146
|
+
| `search_nodes` | Fast symbol/file lookup by name |
|
|
147
|
+
| `get_context` | Symbols and relationships for a file |
|
|
148
|
+
| `get_relationships` | Callers and callees for a symbol |
|
|
149
|
+
| `get_hub_nodes` | Architectural chokepoints |
|
|
150
|
+
| `get_impact` | Blast-radius for a changed file |
|
|
151
|
+
| `get_knowledge_gaps` | Untested high-call-count symbols |
|
|
152
|
+
| `list_wiki_pages` / `get_wiki_page` | Wiki browsing |
|
|
82
153
|
|
|
83
154
|
### 🔥 `reki hotspots` — Architectural hotspot detection
|
|
84
155
|
|
|
85
|
-
Finds hub
|
|
156
|
+
Finds hub nodes (files many depend on) and bridge nodes (files connecting clusters).
|
|
86
157
|
|
|
87
158
|
```bash
|
|
88
159
|
reki hotspots
|
|
89
160
|
```
|
|
90
161
|
|
|
91
162
|
```
|
|
92
|
-
Hub nodes:
|
|
163
|
+
Hub nodes: src/core/engine.py (42 dependents)
|
|
93
164
|
Bridge nodes: src/adapters/db.py (connects 3 clusters)
|
|
94
165
|
```
|
|
95
166
|
|
|
@@ -101,84 +172,25 @@ Only regenerates wiki pages affected by your changes.
|
|
|
101
172
|
reki update . --impact-only
|
|
102
173
|
```
|
|
103
174
|
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
## MCP Integration
|
|
107
|
-
|
|
108
|
-
rekipedia ships a full MCP stdio server. Connect it to any MCP-aware agent in seconds.
|
|
109
|
-
|
|
110
|
-
Add to your `.mcp.json`:
|
|
111
|
-
|
|
112
|
-
```json
|
|
113
|
-
{
|
|
114
|
-
"mcpServers": {
|
|
115
|
-
"rekipedia": {
|
|
116
|
-
"command": "reki",
|
|
117
|
-
"args": ["mcp"],
|
|
118
|
-
"cwd": "."
|
|
119
|
-
}
|
|
120
|
-
}
|
|
121
|
-
}
|
|
122
|
-
```
|
|
175
|
+
### 🌐 `reki serve` — Local web UI
|
|
123
176
|
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
- `ask` — Q&A over the codebase
|
|
127
|
-
- `search_nodes` — symbol/file search
|
|
128
|
-
- `get_context` — file-level context
|
|
129
|
-
- `get_relationships` — dependency graph queries
|
|
130
|
-
- `get_hub_nodes` — architectural hotspots
|
|
131
|
-
- `get_impact` — change impact analysis
|
|
132
|
-
- `list_wiki_pages` — enumerate all wiki pages
|
|
133
|
-
- `get_wiki_page` — read a specific wiki page by name
|
|
134
|
-
---
|
|
135
|
-
## AI CLI tool integration
|
|
136
|
-
|
|
137
|
-
rekipedia integrates natively with the major AI coding assistants via MCP (Model Context Protocol). After scanning your codebase, run:
|
|
177
|
+
Launch a browsable wiki at `http://127.0.0.1:7070`.
|
|
138
178
|
|
|
139
179
|
```bash
|
|
140
|
-
reki
|
|
141
|
-
# or pick individually:
|
|
142
|
-
reki init --with-copilot # GitHub Copilot (VS Code) — writes .vscode/mcp.json
|
|
143
|
-
reki init --with-codex # Codex CLI — writes .codex/instructions.md + setup hint
|
|
144
|
-
reki init --with-cursor # Cursor — writes .cursor/mcp.json + rules
|
|
180
|
+
reki serve .
|
|
145
181
|
```
|
|
146
182
|
|
|
147
|
-
|
|
183
|
+
### 📤 `reki publish` — Team sharing
|
|
148
184
|
|
|
149
|
-
|
|
150
|
-
|---|---|
|
|
151
|
-
| `ask` | Natural-language Q&A grounded in the scanned wiki |
|
|
152
|
-
| `search_nodes` | Fast symbol lookup by name |
|
|
153
|
-
| `get_context` | Symbols and relationships for a file |
|
|
154
|
-
| `get_relationships` | Callers and callees for a symbol |
|
|
155
|
-
| `get_hub_nodes` | Architectural chokepoints |
|
|
156
|
-
| `get_impact` | Blast-radius for a changed file |
|
|
157
|
-
| `get_knowledge_gaps` | Untested high-call-count symbols |
|
|
158
|
-
| `list_wiki_pages` | List all wiki pages |
|
|
159
|
-
| `get_wiki_page` | Read a specific wiki page by name |
|
|
160
|
-
|
|
161
|
-
---
|
|
162
|
-
|
|
163
|
-
## LLM Setup
|
|
164
|
-
|
|
165
|
-
rekipedia works without an LLM (`--no-llm`). To enable richer summaries and Q&A:
|
|
185
|
+
Copy generated wiki into a git-tracked directory for team browsing.
|
|
166
186
|
|
|
167
187
|
```bash
|
|
168
|
-
|
|
169
|
-
export REKIPEDIA_MODEL=gpt-4o # default: gpt-4o
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
Any OpenAI-compatible endpoint works:
|
|
173
|
-
|
|
174
|
-
```bash
|
|
175
|
-
export REKIPEDIA_API_KEY=ollama
|
|
176
|
-
export REKIPEDIA_MODEL=ollama/llama3
|
|
188
|
+
reki publish . [--output-dir PATH]
|
|
177
189
|
```
|
|
178
190
|
|
|
179
191
|
---
|
|
180
192
|
|
|
181
|
-
## Commands
|
|
193
|
+
## 🛠️ Commands Cheat Sheet
|
|
182
194
|
|
|
183
195
|
| Command | Description |
|
|
184
196
|
|---|---|
|
|
@@ -189,11 +201,11 @@ export REKIPEDIA_MODEL=ollama/llama3
|
|
|
189
201
|
| `reki update . --impact-only` | Incremental update, affected pages only |
|
|
190
202
|
| `reki serve .` | Local web UI at `http://127.0.0.1:7070` |
|
|
191
203
|
| `reki embed .` | Build FAISS semantic index |
|
|
192
|
-
| `reki publish . [--output-dir PATH]` | Publish wiki to a git-tracked directory
|
|
193
|
-
| `reki export . --format bundle` | Export a content-addressed wiki bundle
|
|
194
|
-
| `reki merge <bundle-A> <bundle-B> [--base BASE]` | Three-way
|
|
195
|
-
| `reki pull [URL]` | Fetch and merge a remote wiki bundle
|
|
196
|
-
| `reki watch . --publish` | Auto-index + auto-publish
|
|
204
|
+
| `reki publish . [--output-dir PATH]` | Publish wiki to a git-tracked directory |
|
|
205
|
+
| `reki export . --format bundle` | Export a content-addressed wiki bundle |
|
|
206
|
+
| `reki merge <bundle-A> <bundle-B> [--base BASE]` | Three-way conflict-free wiki merge |
|
|
207
|
+
| `reki pull [URL]` | Fetch and merge a remote wiki bundle |
|
|
208
|
+
| `reki watch . --publish` | Auto-index + auto-publish on every file save |
|
|
197
209
|
| `reki export . --format md\|zip\|json\|html\|bundle` | Export the wiki |
|
|
198
210
|
| `reki diff` | Show impact of uncommitted changes |
|
|
199
211
|
| `reki hotspots` | Hub & bridge node detection |
|
|
@@ -201,96 +213,151 @@ export REKIPEDIA_MODEL=ollama/llama3
|
|
|
201
213
|
| `reki refactor . --apply` | Apply refactor suggestions |
|
|
202
214
|
| `reki mcp` | Start MCP stdio server |
|
|
203
215
|
| `reki review` | LLM-powered PR review |
|
|
204
|
-
| `reki watch .` | Auto-index on file change |
|
|
205
216
|
| `reki hook install` | Install git post-commit hook |
|
|
206
|
-
| `reki init --with-all-ai` | Configure MCP for
|
|
217
|
+
| `reki init --with-all-ai` | Configure MCP for Copilot + Codex + Cursor |
|
|
218
|
+
| `reki init --with-ci` | Scaffold GitHub Actions workflow for auto-wiki |
|
|
207
219
|
|
|
208
220
|
---
|
|
209
221
|
|
|
210
|
-
##
|
|
222
|
+
## 🤖 AI CLI Tool Integration
|
|
211
223
|
|
|
212
|
-
|
|
224
|
+
```bash
|
|
225
|
+
reki init --with-all-ai # configure Copilot + Codex + Cursor in one step
|
|
226
|
+
|
|
227
|
+
# or pick individually:
|
|
228
|
+
reki init --with-copilot # VS Code — writes .vscode/mcp.json
|
|
229
|
+
reki init --with-codex # Codex CLI — writes .codex/instructions.md
|
|
230
|
+
reki init --with-cursor # Cursor — writes .cursor/mcp.json + rules
|
|
231
|
+
```
|
|
213
232
|
|
|
214
|
-
|
|
233
|
+
Once configured, each tool automatically gets access to the [MCP tools listed above](#-reki-mcp--mcp-server-for-ai-agents).
|
|
215
234
|
|
|
216
235
|
---
|
|
217
236
|
|
|
218
|
-
|
|
237
|
+
## ⚙️ LLM Setup
|
|
219
238
|
|
|
220
|
-
|
|
239
|
+
rekipedia works **entirely without an LLM** (`--no-llm`). To enable richer summaries and Q&A:
|
|
240
|
+
|
|
241
|
+
```bash
|
|
242
|
+
export REKIPEDIA_MODEL=gemini/gemini-2.5-pro
|
|
243
|
+
export GOOGLE_API_KEY=...
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
Or use any OpenAI-compatible endpoint:
|
|
247
|
+
|
|
248
|
+
```bash
|
|
249
|
+
export REKIPEDIA_MODEL=openai/gpt-4o
|
|
250
|
+
export REKIPEDIA_API_KEY=sk-...
|
|
251
|
+
|
|
252
|
+
# Local / offline
|
|
253
|
+
export REKIPEDIA_API_KEY=ollama
|
|
254
|
+
export REKIPEDIA_MODEL=ollama/llama3
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
---
|
|
258
|
+
|
|
259
|
+
## ❓ FAQ
|
|
260
|
+
|
|
261
|
+
**Q: Why is `store.db` gitignored? How do teammates use rekipedia?**
|
|
262
|
+
|
|
263
|
+
`store.db` contains machine-specific absolute paths — committing it would cause path mismatches and noisy binary diffs. Each developer runs `reki scan .` locally. To share human-readable output, use `reki publish .`, which copies generated wiki pages to `docs/wiki/` so they can be committed and browsed on GitHub or your docs site.
|
|
221
264
|
|
|
222
265
|
---
|
|
223
266
|
|
|
224
|
-
|
|
267
|
+
**Q: What is `store.db` for vs the FAISS index? Why do I need both?**
|
|
225
268
|
|
|
226
|
-
|
|
269
|
+
| | `store.db` | FAISS / Qdrant / Chroma |
|
|
270
|
+
|---|---|---|
|
|
271
|
+
| **Format** | Structured SQLite graph | Dense embedding vectors |
|
|
272
|
+
| **Purpose** | Precise filters — "find all callers of function X" | Fuzzy semantic search — "find code that handles authentication" |
|
|
273
|
+
| **Used by** | `search_nodes`, `get_relationships`, `hotspots` | `reki ask` RAG pipeline |
|
|
274
|
+
|
|
275
|
+
`reki ask` uses both: BM25 keyword search over SQLite **plus** vector similarity search, then merges and re-ranks results.
|
|
227
276
|
|
|
228
277
|
---
|
|
229
278
|
|
|
230
|
-
|
|
279
|
+
**Q: Can I use Postgres or MySQL instead of SQLite?**
|
|
231
280
|
|
|
232
|
-
|
|
281
|
+
Not currently. SQLite is intentional — zero-config, portable, no running server. `reki export .` produces `symbols.json` and `relationships.json` for loading into any database. Postgres/MySQL support is not on the roadmap, but the JSON exports make integration straightforward.
|
|
233
282
|
|
|
234
283
|
---
|
|
235
284
|
|
|
236
|
-
|
|
285
|
+
**Q: Does rekipedia support Qdrant or Chroma instead of FAISS?**
|
|
286
|
+
|
|
287
|
+
Yes. FAISS is the default, but Qdrant and Chroma are supported as optional backends — useful for shared, persistent vector stores across a team. Install extras:
|
|
288
|
+
|
|
289
|
+
```bash
|
|
290
|
+
pip install rekipedia[qdrant] # or rekipedia[chroma]
|
|
291
|
+
```
|
|
237
292
|
|
|
238
|
-
|
|
293
|
+
Then configure the backend in `.rekipedia/config.yml`.
|
|
239
294
|
|
|
240
295
|
---
|
|
241
296
|
|
|
242
|
-
|
|
297
|
+
**Q: Do I need an OpenAI API key?**
|
|
243
298
|
|
|
244
|
-
|
|
299
|
+
No. `reki scan . --no-llm` performs static analysis only — fully offline and air-gap safe. When LLM features are enabled, only retrieved chunks (not your full source) are sent as context. Use [Ollama](https://ollama.com) for fully local inference — no internet required.
|
|
245
300
|
|
|
246
301
|
---
|
|
247
302
|
|
|
248
|
-
|
|
303
|
+
**Q: How do I keep the wiki up to date automatically?**
|
|
249
304
|
|
|
250
|
-
Run `reki init --with-ci` to scaffold a GitHub Actions workflow
|
|
305
|
+
Run `reki init --with-ci` to scaffold a GitHub Actions workflow that runs `reki scan` + `reki publish` on every push to `main`. The workflow commits changes to `docs/wiki/` back to the repo automatically. Set `REKIPEDIA_API_KEY` as a repository secret for LLM-enriched pages; omit it and the workflow falls back to `--no-llm` at zero cost.
|
|
251
306
|
|
|
252
307
|
---
|
|
253
308
|
|
|
254
|
-
|
|
309
|
+
**Q: How does team sync work for distributed teams?**
|
|
255
310
|
|
|
256
|
-
rekipedia
|
|
311
|
+
rekipedia uses a multi-layer, conflict-free collaboration system:
|
|
257
312
|
|
|
258
|
-
1. **Bundle** — `reki export --format bundle` creates a deterministic, content-addressed snapshot
|
|
259
|
-
2. **Merge** — `reki merge bundle-A bundle-B --base bundle-base` performs a three-way merge
|
|
260
|
-
3. **Git merge driver** — `reki init --with-merge-driver` registers a
|
|
261
|
-
4. **Live sync** — `reki watch . --publish` publishes the wiki after every incremental update
|
|
262
|
-
5. **Remote pull** — `reki pull <url>` fetches a bundle from HTTPS, S3, or GCS and merges it locally.
|
|
313
|
+
1. **Bundle** — `reki export --format bundle` creates a deterministic, content-addressed snapshot.
|
|
314
|
+
2. **Merge** — `reki merge bundle-A bundle-B --base bundle-base` performs a three-way merge with automatic resolution for non-conflicting changes.
|
|
315
|
+
3. **Git merge driver** — `reki init --with-merge-driver` registers a custom driver so `git merge` and `git pull` use rekipedia's logic — no `<<<<<<` conflicts in generated wiki files.
|
|
316
|
+
4. **Live sync** — `reki watch . --publish` publishes the wiki after every incremental update.
|
|
317
|
+
5. **Remote pull** — `reki pull <url>` fetches a bundle from HTTPS, S3, or GCS and merges it locally.
|
|
263
318
|
|
|
264
319
|
---
|
|
265
320
|
|
|
266
|
-
|
|
321
|
+
**Q: How does `reki ask` work under the hood?**
|
|
322
|
+
|
|
323
|
+
A hybrid retrieval pipeline:
|
|
267
324
|
|
|
268
|
-
|
|
325
|
+
1. **BM25 keyword search** against the SQLite store for exact and near-exact matches.
|
|
326
|
+
2. **Vector similarity search** against FAISS/Qdrant/Chroma for semantic matches.
|
|
327
|
+
3. **Merge & re-rank** the two result sets by relevance score.
|
|
328
|
+
4. **LLM synthesis** — top chunks passed to your configured LLM with file:line citations.
|
|
329
|
+
|
|
330
|
+
With `--no-llm`, retrieval results are returned directly without synthesis.
|
|
269
331
|
|
|
270
332
|
---
|
|
271
333
|
|
|
272
|
-
|
|
334
|
+
**Q: How large does `store.db` / the FAISS index get on a large repo?**
|
|
335
|
+
|
|
336
|
+
For a typical mid-size repo (50k–200k LOC):
|
|
273
337
|
|
|
274
|
-
|
|
338
|
+
| Storage | Typical Size |
|
|
339
|
+
|---|---|
|
|
340
|
+
| `store.db` | 10–80 MB |
|
|
341
|
+
| FAISS index | 50–500 MB |
|
|
342
|
+
|
|
343
|
+
On very large monorepos (1M+ LOC), the FAISS index can exceed 1 GB; switching to a server-backed Qdrant instance is recommended.
|
|
275
344
|
|
|
276
345
|
---
|
|
277
346
|
|
|
278
|
-
|
|
347
|
+
**Q: Can rekipedia scan private or fully offline repos?**
|
|
279
348
|
|
|
280
|
-
Yes, fully. `reki scan` is pure static analysis — it never sends your source code anywhere. With `--no-llm`, the entire pipeline is offline and air-gap safe.
|
|
349
|
+
Yes, fully. `reki scan` is pure static analysis — it never sends your source code anywhere. With `--no-llm`, the entire pipeline is offline and air-gap safe. There are no telemetry calls, no license checks against a remote server, and no internet requirement beyond your chosen LLM endpoint.
|
|
281
350
|
|
|
282
351
|
---
|
|
283
352
|
|
|
284
|
-
## Coming Soon
|
|
353
|
+
## 🔮 Coming Soon
|
|
285
354
|
|
|
286
355
|
- **Hosted wiki** — share your knowledge base with a link, no self-hosting required
|
|
287
356
|
- **VS Code extension** — inline `reki ask` from your editor
|
|
288
357
|
|
|
289
358
|
---
|
|
290
359
|
|
|
291
|
-
## Contributing
|
|
292
|
-
|
|
293
|
-
rekipedia is going MIT open source. Contributions welcome.
|
|
360
|
+
## 🤝 Contributing
|
|
294
361
|
|
|
295
362
|
```bash
|
|
296
363
|
git clone https://github.com/unrealandychan/rekipedia.git
|
package/package.json
CHANGED