rekipedia 0.21.1 → 0.22.0
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 +22 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -28,7 +28,8 @@ pip install rekipedia
|
|
|
28
28
|
### With LLM (richer wiki + Q&A)
|
|
29
29
|
|
|
30
30
|
```bash
|
|
31
|
-
export
|
|
31
|
+
export REKIPEDIA_MODEL=gemini/gemini-2.5-flash
|
|
32
|
+
export GOOGLE_API_KEY=...
|
|
32
33
|
reki scan .
|
|
33
34
|
reki ask "how does authentication work?"
|
|
34
35
|
```
|
|
@@ -48,7 +49,7 @@ reki scan . --no-llm # zero config, no API key required
|
|
|
48
49
|
|
|
49
50
|
### 💬 `reki ask` — Q&A grounded in your code
|
|
50
51
|
|
|
51
|
-
Answers questions with file:line citations
|
|
52
|
+
Answers questions with file:line citations **and real code examples**. No hallucinations — every answer is backed by indexed source, with actual function bodies quoted inline.
|
|
52
53
|
|
|
53
54
|
```bash
|
|
54
55
|
reki ask "what is the entry point?"
|
|
@@ -57,9 +58,19 @@ reki ask "which modules handle payments?" --brief
|
|
|
57
58
|
|
|
58
59
|
```
|
|
59
60
|
Answer: The entry point is src/main.py:12 — `App.run()` bootstraps the server.
|
|
61
|
+
|
|
62
|
+
```python
|
|
63
|
+
# src/main.py:12
|
|
64
|
+
def run(self):
|
|
65
|
+
server = HTTPServer(self.config)
|
|
66
|
+
server.start()
|
|
67
|
+
```
|
|
68
|
+
|
|
60
69
|
Sources: src/main.py:12, src/server.py:34
|
|
61
70
|
```
|
|
62
71
|
|
|
72
|
+
**How it works:** rekipedia extracts the 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 instead for even higher precision.
|
|
73
|
+
|
|
63
74
|
### 🤖 `reki mcp` — MCP server for AI agents
|
|
64
75
|
|
|
65
76
|
Plug rekipedia directly into Claude Code, Cursor, or any MCP-aware agent.
|
|
@@ -155,8 +166,15 @@ Once configured, each tool automatically gets access to these rekipedia MCP tool
|
|
|
155
166
|
rekipedia works without an LLM (`--no-llm`). To enable richer summaries and Q&A:
|
|
156
167
|
|
|
157
168
|
```bash
|
|
158
|
-
export
|
|
159
|
-
export
|
|
169
|
+
export REKIPEDIA_MODEL=gemini/gemini-2.5-pro
|
|
170
|
+
export GOOGLE_API_KEY=...
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
Or use a provider-agnostic key:
|
|
174
|
+
|
|
175
|
+
```bash
|
|
176
|
+
export REKIPEDIA_MODEL=openai/gpt-4o
|
|
177
|
+
export REKIPEDIA_API_KEY=sk-...
|
|
160
178
|
```
|
|
161
179
|
|
|
162
180
|
Any OpenAI-compatible endpoint works:
|
package/package.json
CHANGED