rekipedia 0.17.17 → 0.17.18
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 +35 -2
- package/README.zh-CN.md +35 -0
- package/README.zh-TW.md +35 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -27,6 +27,24 @@ pip install "rekipedia[rag]" # + semantic search (FAISS)
|
|
|
27
27
|
|
|
28
28
|
---
|
|
29
29
|
|
|
30
|
+
## Quick Start — No API Key Needed
|
|
31
|
+
|
|
32
|
+
Run a full static analysis without any LLM API key:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
pip install rekipedia
|
|
36
|
+
reki scan . --no-llm # ~5-10s, zero API calls
|
|
37
|
+
reki onboard . # architecture overview
|
|
38
|
+
reki tour . # guided walkthrough by dependency depth
|
|
39
|
+
reki domain . # business domain layer map
|
|
40
|
+
reki diff . # impact analysis on changed files
|
|
41
|
+
reki export . --format md # export full wiki to markdown
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
> **Note:** `reki ask` (AI Q&A) requires an LLM API key. See [LLM Setup](#llm-setup) below.
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
30
48
|
## Core commands
|
|
31
49
|
|
|
32
50
|
| Command | What it does |
|
|
@@ -50,7 +68,18 @@ pip install "rekipedia[rag]" # + semantic search (FAISS)
|
|
|
50
68
|
|
|
51
69
|
---
|
|
52
70
|
|
|
53
|
-
## LLM
|
|
71
|
+
## LLM Setup
|
|
72
|
+
|
|
73
|
+
rekipedia uses [litellm](https://github.com/BerriAI/litellm) and supports any provider:
|
|
74
|
+
|
|
75
|
+
| Provider | Example |
|
|
76
|
+
|---|---|
|
|
77
|
+
| OpenAI | `OPENAI_API_KEY=sk-... reki scan .` |
|
|
78
|
+
| Anthropic Claude | `REKIPEDIA_MODEL=claude-3-5-sonnet-20241022 REKIPEDIA_API_KEY=sk-ant-... reki scan .` |
|
|
79
|
+
| Google Gemini | `REKIPEDIA_MODEL=gemini/gemini-2.0-flash REKIPEDIA_API_KEY=AIza... reki scan .` |
|
|
80
|
+
| OpenRouter | `REKIPEDIA_MODEL=openrouter/anthropic/claude-3.5-sonnet REKIPEDIA_API_KEY=sk-or-... reki scan .` |
|
|
81
|
+
| Local Ollama (default) | `REKIPEDIA_MODEL=ollama/llama4 reki scan .` |
|
|
82
|
+
| Azure OpenAI | `REKIPEDIA_MODEL=azure/gpt-4o REKIPEDIA_BASE_URL=https://your-resource.openai.azure.com REKIPEDIA_API_KEY=... reki scan .` |
|
|
54
83
|
|
|
55
84
|
After `reki init`, edit `.rekipedia/config.yml`:
|
|
56
85
|
|
|
@@ -64,7 +93,11 @@ llm:
|
|
|
64
93
|
|
|
65
94
|
Supported providers: Ollama, OpenAI, Anthropic, Gemini, any OpenAI-compatible endpoint.
|
|
66
95
|
|
|
67
|
-
|
|
96
|
+
Environment variables:
|
|
97
|
+
- `REKIPEDIA_MODEL` — litellm model string (default: `ollama/llama4`)
|
|
98
|
+
- `REKIPEDIA_API_KEY` — API key for the chosen provider
|
|
99
|
+
- `REKIPEDIA_BASE_URL` — custom base URL (for Azure, Ollama, proxies)
|
|
100
|
+
- `REKIPEDIA_TIMEOUT` — LLM call timeout in seconds (default: 180)
|
|
68
101
|
|
|
69
102
|
---
|
|
70
103
|
|
package/README.zh-CN.md
CHANGED
|
@@ -62,6 +62,24 @@ brew install rekipedia
|
|
|
62
62
|
|
|
63
63
|
---
|
|
64
64
|
|
|
65
|
+
## 快速开始——无需 API 密钥
|
|
66
|
+
|
|
67
|
+
无需任何 LLM API 密钥即可执行完整静态分析：
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
pip install rekipedia
|
|
71
|
+
reki scan . --no-llm # ~5-10 秒，零 API 调用
|
|
72
|
+
reki onboard . # 架构总览
|
|
73
|
+
reki tour . # 依赖深度导览
|
|
74
|
+
reki domain . # 业务领域层次图
|
|
75
|
+
reki diff . # 变更影响分析
|
|
76
|
+
reki export . --format md # 导出完整 wiki 为 Markdown
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
> **注意：** `reki ask`（AI 问答）需要 LLM API 密钥。请参阅下方 [LLM 配置](#llm-配置)。
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
65
83
|
## Python API
|
|
66
84
|
|
|
67
85
|
在 Jupyter Notebook、CI 流水线或任意 Python 应用中以编程方式使用 rekipedia：
|
|
@@ -121,6 +139,23 @@ answer = await rekipedia.ask_async("/path/to/repo", "What is the entry point?")
|
|
|
121
139
|
|
|
122
140
|
## LLM 配置
|
|
123
141
|
|
|
142
|
+
rekipedia 使用 [litellm](https://github.com/BerriAI/litellm)，支持任何提供商：
|
|
143
|
+
|
|
144
|
+
| 提供商 | 示例 |
|
|
145
|
+
|---|---|
|
|
146
|
+
| OpenAI | `OPENAI_API_KEY=sk-... reki scan .` |
|
|
147
|
+
| Anthropic Claude | `REKIPEDIA_MODEL=claude-3-5-sonnet-20241022 REKIPEDIA_API_KEY=sk-ant-... reki scan .` |
|
|
148
|
+
| Google Gemini | `REKIPEDIA_MODEL=gemini/gemini-2.0-flash REKIPEDIA_API_KEY=AIza... reki scan .` |
|
|
149
|
+
| OpenRouter | `REKIPEDIA_MODEL=openrouter/anthropic/claude-3.5-sonnet REKIPEDIA_API_KEY=sk-or-... reki scan .` |
|
|
150
|
+
| 本地 Ollama（默认） | `REKIPEDIA_MODEL=ollama/llama4 reki scan .` |
|
|
151
|
+
| Azure OpenAI | `REKIPEDIA_MODEL=azure/gpt-4o REKIPEDIA_BASE_URL=https://your-resource.openai.azure.com REKIPEDIA_API_KEY=... reki scan .` |
|
|
152
|
+
|
|
153
|
+
环境变量：
|
|
154
|
+
- `REKIPEDIA_MODEL` — litellm 模型字符串（默认：`ollama/llama4`）
|
|
155
|
+
- `REKIPEDIA_API_KEY` — 所选提供商的 API 密钥
|
|
156
|
+
- `REKIPEDIA_BASE_URL` — 自定义基础 URL（用于 Azure、Ollama、代理）
|
|
157
|
+
- `REKIPEDIA_TIMEOUT` — LLM 调用超时秒数（默认：180）
|
|
158
|
+
|
|
124
159
|
运行 `rekipedia init` 后，编辑 `.rekipedia/config.yml`：
|
|
125
160
|
|
|
126
161
|
```yaml
|
package/README.zh-TW.md
CHANGED
|
@@ -62,6 +62,24 @@ brew install rekipedia
|
|
|
62
62
|
|
|
63
63
|
---
|
|
64
64
|
|
|
65
|
+
## 快速開始——無需 API 金鑰
|
|
66
|
+
|
|
67
|
+
無需任何 LLM API 金鑰即可執行完整靜態分析：
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
pip install rekipedia
|
|
71
|
+
reki scan . --no-llm # ~5-10 秒，零 API 呼叫
|
|
72
|
+
reki onboard . # 架構總覽
|
|
73
|
+
reki tour . # 依賴深度導覽
|
|
74
|
+
reki domain . # 業務領域層次圖
|
|
75
|
+
reki diff . # 變更影響分析
|
|
76
|
+
reki export . --format md # 匯出完整 wiki 為 Markdown
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
> **注意：** `reki ask`（AI 問答）需要 LLM API 金鑰。請參閱下方 [LLM 設定](#llm-設定)。
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
65
83
|
## Python API
|
|
66
84
|
|
|
67
85
|
在 Jupyter 筆記本、CI 流水線或任何 Python 應用程式中以程式化方式使用 rekipedia：
|
|
@@ -121,6 +139,23 @@ answer = await rekipedia.ask_async("/path/to/repo", "What is the entry point?")
|
|
|
121
139
|
|
|
122
140
|
## LLM 設定
|
|
123
141
|
|
|
142
|
+
rekipedia 使用 [litellm](https://github.com/BerriAI/litellm)，支援任何提供者：
|
|
143
|
+
|
|
144
|
+
| 提供者 | 範例 |
|
|
145
|
+
|---|---|
|
|
146
|
+
| OpenAI | `OPENAI_API_KEY=sk-... reki scan .` |
|
|
147
|
+
| Anthropic Claude | `REKIPEDIA_MODEL=claude-3-5-sonnet-20241022 REKIPEDIA_API_KEY=sk-ant-... reki scan .` |
|
|
148
|
+
| Google Gemini | `REKIPEDIA_MODEL=gemini/gemini-2.0-flash REKIPEDIA_API_KEY=AIza... reki scan .` |
|
|
149
|
+
| OpenRouter | `REKIPEDIA_MODEL=openrouter/anthropic/claude-3.5-sonnet REKIPEDIA_API_KEY=sk-or-... reki scan .` |
|
|
150
|
+
| 本地 Ollama（預設） | `REKIPEDIA_MODEL=ollama/llama4 reki scan .` |
|
|
151
|
+
| Azure OpenAI | `REKIPEDIA_MODEL=azure/gpt-4o REKIPEDIA_BASE_URL=https://your-resource.openai.azure.com REKIPEDIA_API_KEY=... reki scan .` |
|
|
152
|
+
|
|
153
|
+
環境變數：
|
|
154
|
+
- `REKIPEDIA_MODEL` — litellm 模型字串（預設：`ollama/llama4`）
|
|
155
|
+
- `REKIPEDIA_API_KEY` — 所選提供者的 API 金鑰
|
|
156
|
+
- `REKIPEDIA_BASE_URL` — 自訂基礎 URL（用於 Azure、Ollama、代理）
|
|
157
|
+
- `REKIPEDIA_TIMEOUT` — LLM 呼叫逾時秒數（預設：180）
|
|
158
|
+
|
|
124
159
|
執行 `rekipedia init` 後，編輯 `.rekipedia/config.yml`：
|
|
125
160
|
|
|
126
161
|
```yaml
|
package/package.json
CHANGED