@pcircle/memesh 4.0.1 → 4.0.3

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.
Files changed (54) hide show
  1. package/README.de.md +56 -201
  2. package/README.es.md +56 -201
  3. package/README.fr.md +56 -201
  4. package/README.ja.md +55 -200
  5. package/README.ko.md +56 -201
  6. package/README.md +36 -30
  7. package/README.pt.md +56 -201
  8. package/README.th.md +56 -201
  9. package/README.vi.md +56 -201
  10. package/README.zh-CN.md +56 -201
  11. package/README.zh-TW.md +56 -201
  12. package/dashboard/dist/index.html +4 -4
  13. package/dist/core/config.d.ts.map +1 -1
  14. package/dist/core/config.js +17 -7
  15. package/dist/core/config.js.map +1 -1
  16. package/dist/core/embedder.d.ts +2 -0
  17. package/dist/core/embedder.d.ts.map +1 -1
  18. package/dist/core/embedder.js +51 -8
  19. package/dist/core/embedder.js.map +1 -1
  20. package/dist/core/install-channel.d.ts +30 -0
  21. package/dist/core/install-channel.d.ts.map +1 -0
  22. package/dist/core/install-channel.js +83 -0
  23. package/dist/core/install-channel.js.map +1 -0
  24. package/dist/core/operations.d.ts.map +1 -1
  25. package/dist/core/operations.js +26 -8
  26. package/dist/core/operations.js.map +1 -1
  27. package/dist/core/serializer.d.ts.map +1 -1
  28. package/dist/core/serializer.js +24 -0
  29. package/dist/core/serializer.js.map +1 -1
  30. package/dist/core/updater.d.ts +11 -0
  31. package/dist/core/updater.d.ts.map +1 -0
  32. package/dist/core/updater.js +28 -0
  33. package/dist/core/updater.js.map +1 -0
  34. package/dist/core/version-check.d.ts +28 -4
  35. package/dist/core/version-check.d.ts.map +1 -1
  36. package/dist/core/version-check.js +167 -21
  37. package/dist/core/version-check.js.map +1 -1
  38. package/dist/knowledge-graph.d.ts +3 -0
  39. package/dist/knowledge-graph.d.ts.map +1 -1
  40. package/dist/knowledge-graph.js +28 -3
  41. package/dist/knowledge-graph.js.map +1 -1
  42. package/dist/transports/cli/cli.js +44 -13
  43. package/dist/transports/cli/cli.js.map +1 -1
  44. package/dist/transports/http/server.d.ts +3 -1
  45. package/dist/transports/http/server.d.ts.map +1 -1
  46. package/dist/transports/http/server.js +53 -2
  47. package/dist/transports/http/server.js.map +1 -1
  48. package/package.json +5 -6
  49. package/plugin.json +2 -2
  50. package/scripts/hooks/_shared.js +62 -0
  51. package/scripts/hooks/pre-edit-recall.js +22 -15
  52. package/scripts/hooks/session-start.js +30 -21
  53. package/scripts/hooks/session-summary.js +4 -5
  54. package/skills/memesh/SKILL.md +8 -0
package/README.vi.md CHANGED
@@ -3,253 +3,108 @@
3
3
  <p align="center">
4
4
  <h1 align="center">MeMesh LLM Memory</h1>
5
5
  <p align="center">
6
- <strong>Lớp bộ nhớ AI phổ quát nhẹ nhất.</strong><br />
7
- Một file SQLite. Mọi LLM. Không cần đám mây.
8
- </p>
9
- <p align="center">
10
- <a href="https://www.npmjs.com/package/@pcircle/memesh"><img src="https://img.shields.io/npm/v/@pcircle/memesh?style=flat-square&color=3b82f6&label=npm" alt="npm" /></a>
11
- <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-22c55e?style=flat-square" alt="MIT" /></a>
12
- <a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%3E%3D20-22c55e?style=flat-square" alt="Node" /></a>
13
- <a href="https://modelcontextprotocol.io"><img src="https://img.shields.io/badge/MCP-compatible-a855f7?style=flat-square" alt="MCP" /></a>
6
+ <strong>Lớp bộ nhớ cục bộ cho Claude Code và các coding agent tương thích MCP.</strong><br />
7
+ Một tệp SQLite. Không cần Docker. Không cần phụ thuộc vào cloud.
14
8
  </p>
15
9
  </p>
16
10
 
17
- ---
11
+ > README tiếng Việt này là bản giới thiệu rút gọn. Để xem nội dung đầy đủ và mới nhất, hãy dùng [English README](README.md) làm bản tham chiếu chính.
18
12
 
19
- ## Vấn Đề
13
+ ## MeMesh giải quyết vấn đề gì?
20
14
 
21
- AI của bạn quên sạch mọi thứ sau mỗi phiên làm việc. Mọi quyết định, mọi lần sửa lỗi, mọi bài học rút ra — biến mất. Bạn phải giải thích lại cùng một bối cảnh, Claude lại khám phá lại cùng một pattern, kiến thức AI của cả nhóm cứ reset về không mỗi lần.
15
+ Coding agent thường mất ngữ cảnh giữa các session. Quyết định kiến trúc, lỗi đã sửa, bài học đã rút ra và các ràng buộc của dự án cứ phải giải thích lại nhiều lần.
22
16
 
23
- **MeMesh trao cho mọi AI bộ nhớ bền vững, thể tìm kiếm và không ngừng phát triển.**
17
+ **MeMesh giữ lại phần kiến thức đó trên máy cục bộ, cho phép tìm kiếm, xem lại dùng lại khi cần.**
24
18
 
25
- ---
19
+ Gói npm này là phiên bản plugin / package chạy cục bộ của MeMesh. Nó không phải sản phẩm workspace trên cloud hay toàn bộ nền tảng enterprise.
26
20
 
27
- ## Bắt Đầu Trong 60 Giây
21
+ ## Bắt đầu trong 60 giây
28
22
 
29
- ### Bước 1: Cài đặt
23
+ ### 1. Cài đặt
30
24
 
31
25
  ```bash
32
26
  npm install -g @pcircle/memesh
33
27
  ```
34
28
 
35
- ### Bước 2: AI của bạn ghi nhớ
29
+ ### 2. Lưu một quyết định
36
30
 
37
31
  ```bash
38
32
  memesh remember --name "auth-decision" --type "decision" --obs "Use OAuth 2.0 with PKCE"
39
33
  ```
40
34
 
41
- ### Bước 3: AI của bạn gợi nhớ
35
+ ### 3. Gọi lại sau này
42
36
 
43
37
  ```bash
44
38
  memesh recall "login security"
45
- # → Tìm thấy "OAuth 2.0 with PKCE" dù tìm bằng từ khác
39
+ # → vẫn tìm được "OAuth 2.0 with PKCE" dù dùng cách diễn đạt khác
46
40
  ```
47
41
 
48
- **Vậy là xong.** MeMesh đã bắt đầu ghi nhớ và gợi nhớ xuyên suốt các phiên làm việc.
49
-
50
- Mở dashboard để khám phá bộ nhớ của bạn:
42
+ Mở dashboard:
51
43
 
52
44
  ```bash
53
45
  memesh
54
46
  ```
55
47
 
56
- <p align="center">
57
- <img src="docs/images/dashboard-search.png" alt="MeMesh Search — tìm bất kỳ ký ức nào ngay lập tức" width="100%" />
58
- </p>
59
-
60
- <p align="center">
61
- <img src="docs/images/dashboard-analytics.png" alt="MeMesh Analytics — hiểu rõ tri thức của AI bạn" width="100%" />
62
- </p>
63
-
64
- <p align="center">
65
- <img src="docs/images/dashboard-graph.png" alt="MeMesh Graph — đồ thị tri thức tương tác với bộ lọc loại và chế độ ego" width="100%" />
66
- </p>
67
-
68
- ---
69
-
70
- ## Dành Cho Ai?
71
-
72
- | Nếu bạn là... | MeMesh giúp bạn... |
73
- |---------------|---------------------|
74
- | **Lập trình viên dùng Claude Code** | Tự động ghi nhớ quyết định, pattern và bài học qua các phiên làm việc |
75
- | **Nhóm xây dựng sản phẩm với LLM** | Chia sẻ kiến thức nhóm qua xuất/nhập, giữ ngữ cảnh AI của mọi người đồng bộ |
76
- | **Nhà phát triển AI agent** | Trao cho agent bộ nhớ bền vững qua MCP, HTTP API hoặc Python SDK |
77
- | **Người dùng nặng với nhiều công cụ AI** | Một lớp bộ nhớ dùng được với Claude, GPT, LLaMA, Ollama hoặc bất kỳ MCP client nào |
78
-
79
- ---
80
-
81
- ## Tương Thích Với Tất Cả
82
-
83
- <table>
84
- <tr>
85
- <td width="33%" align="center">
86
-
87
- **Claude Code / Desktop**
88
- ```bash
89
- memesh-mcp
90
- ```
91
- Giao thức MCP (tự động cấu hình)
92
-
93
- </td>
94
- <td width="33%" align="center">
95
-
96
- **Python / LangChain**
97
- ```python
98
- from memesh import MeMesh
99
- m = MeMesh()
100
- m.recall("auth")
101
- ```
102
- `pip install memesh`
103
-
104
- </td>
105
- <td width="33%" align="center">
106
-
107
- **Mọi LLM (định dạng OpenAI)**
108
- ```bash
109
- memesh export-schema \
110
- --format openai
111
- ```
112
- Dán tools vào bất kỳ API call nào
113
-
114
- </td>
115
- </tr>
116
- </table>
117
-
118
- ---
119
-
120
- ## Tại Sao Không Dùng Mem0 / Zep?
48
+ ## Dành cho ai?
121
49
 
122
- | | **MeMesh** | Mem0 | Zep |
123
- |---|---|---|---|
124
- | **Thời gian cài đặt** | 5 giây | 30–60 phút | 30+ phút |
125
- | **Cấu hình** | `npm i -g` xong | Neo4j + VectorDB + API key | Neo4j + config |
126
- | **Lưu trữ** | Một file SQLite | Neo4j + Qdrant | Neo4j |
127
- | **Hoạt động offline** | Có, luôn luôn | Không | Không |
128
- | **Dashboard** | Tích hợp sẵn (7 tab + phân tích) | Không có | Không có |
129
- | **Phụ thuộc** | 6 | 20+ | 10+ |
130
- | **Giá** | Miễn phí mãi mãi | Gói miễn phí / Trả phí | Gói miễn phí / Trả phí |
50
+ - Nhà phát triển dùng Claude Code và muốn giữ ngữ cảnh dự án giữa các session
51
+ - Người dùng nâng cao muốn dùng chung một bộ nhớ cục bộ cho nhiều MCP coding agents
52
+ - Nhóm AI-native nhỏ muốn chia sẻ kiến thức dự án qua export / import
53
+ - Nhà phát triển agent muốn tích hợp bộ nhớ cục bộ qua CLI, HTTP hoặc MCP
131
54
 
132
- **MeMesh đánh đổi:** tính năng multi-tenant cấp doanh nghiệp để lấy **cài đặt tức thì, không hạ tầng, bảo mật 100%**.
55
+ ## sao chọn MeMesh?
133
56
 
134
- ---
57
+ - Local-first: dữ liệu nằm trong tệp SQLite của chính bạn
58
+ - Cài đặt gọn nhẹ: `npm install -g` là có thể dùng
59
+ - Tích hợp rõ ràng: hỗ trợ CLI, HTTP và MCP
60
+ - Hợp với Claude Code: hooks giúp kéo đúng ngữ cảnh vào lúc làm việc
61
+ - Dễ kiểm tra và dọn dẹp: dashboard giúp nhìn thấy bộ nhớ, không phải hộp đen
62
+ - Ranh giới tin cậy an toàn hơn: bộ nhớ import vẫn tìm kiếm được, nhưng không tự động inject vào Claude hooks nếu chưa được rà soát hoặc lưu lại tại máy cục bộ
135
63
 
136
- ## Những Xảy Ra Tự Động
64
+ ## MeMesh tự động làm trong Claude Code?
137
65
 
138
- Bạn không cần phải tự ghi nhớ mọi thứ. MeMesh **4 hook** tự động thu thập kiến thức mà không cần bạn làm gì:
66
+ Hiện tại, MeMesh hỗ trợ 5 thời điểm:
139
67
 
140
- | Khi nào | MeMesh làm |
141
- |------|------------------|
142
- | **Mỗi khi bắt đầu phiên** | Tải các ức liên quan nhất + cảnh báo chủ động từ bài học trước đó |
143
- | **Sau mỗi `git commit`** | Ghi lại những gì bạn thay đổi, kèm thống diff |
144
- | **Khi Claude kết thúc** | Thu thập file đã sửa, lỗi đã fix tự động tạo bài học cấu trúc từ các lỗi |
145
- | **Trước khi nén context** | Lưu kiến thức trước khi mất do giới hạn context |
68
+ - khi bắt đầu session, nạp các memory liên quan và bài học đã biết
69
+ - trước khi sửa file, gọi lại memory liên quan đến file hoặc dự án
70
+ - sau `git commit`, ghi lại thay đổi vừa thực hiện
71
+ - khi kết thúc session, tổng hợp lỗi, bản sửa lessons learned
72
+ - trước khi compact context, lưu lại những quan trọng vào bộ nhớ cục bộ
146
73
 
147
- > **Tắt bất cứ lúc nào:** `export MEMESH_AUTO_CAPTURE=false`
74
+ ## Dashboard gì?
148
75
 
149
- ---
76
+ Dashboard hiện có 7 tab và hỗ trợ 11 ngôn ngữ:
150
77
 
151
- ## Dashboard
78
+ - Search: tìm memory
79
+ - Browse: xem toàn bộ memory
80
+ - Analytics: theo dõi độ khỏe và xu hướng
81
+ - Graph: xem quan hệ kiến thức
82
+ - Lessons: xem lại bài học
83
+ - Manage: lưu trữ và khôi phục
84
+ - Settings: cấu hình LLM provider và ngôn ngữ
152
85
 
153
- 7 tab, 11 ngôn ngữ, không phụ thuộc bên ngoài. Truy cập tại `http://localhost:3737/dashboard` khi server đang chạy.
86
+ ## Smart Mode gì?
154
87
 
155
- | Tab | Nội dung |
156
- |-----|----------|
157
- | **Search** | Tìm kiếm toàn văn + tương tự vector trên tất cả ký ức |
158
- | **Browse** | Danh sách phân trang của tất cả thực thể với lưu trữ/khôi phục |
159
- | **Analytics** | Điểm Sức khỏe Bộ nhớ (0-100), timeline 30 ngày, chỉ số giá trị, phạm vi kiến thức, đề xuất dọn dẹp, pattern làm việc |
160
- | **Graph** | Đồ thị tri thức tương tác dạng lực với bộ lọc loại, tìm kiếm, chế độ ego, heatmap mức độ mới |
161
- | **Lessons** | Bài học có cấu trúc từ các lỗi trước đó (lỗi, nguyên nhân gốc, cách sửa, phòng ngừa) |
162
- | **Manage** | Lưu trữ và khôi phục thực thể |
163
- | **Settings** | Cấu hình nhà cung cấp LLM, chọn ngôn ngữ |
88
+ Mặc định MeMesh chạy offline. Nếu bạn thêm LLM API key, bạn có thể bật thêm các khả năng như:
164
89
 
165
- ---
90
+ - query expansion
91
+ - tự động trích xuất tốt hơn
92
+ - sắp xếp và nén thông minh hơn
166
93
 
167
- ## Tính Năng Thông Minh
94
+ Ngay cả khi không có API key, phần cốt lõi vẫn hoạt động bình thường.
168
95
 
169
- **🧠 Tìm kiếm thông minh** — Tìm "login security" là ra ký ức về "OAuth PKCE". MeMesh mở rộng truy vấn bằng các thuật ngữ liên quan qua LLM đã cấu hình.
96
+ ## Tìm hiểu thêm
170
97
 
171
- **📊 Xếp hạng theo điểm** Kết quả được xếp hạng theo mức liên quan (35%) + thời gian sử dụng gần nhất (25%) + tần suất (20%) + độ tin cậy (15%) + thông tin còn hiệu lực không (5%).
98
+ - Tính năng đầy đủ, so sánh, API thông tin release: [English README](README.md)
99
+ - Hướng dẫn tích hợp: [docs/platforms/README.md](docs/platforms/README.md)
100
+ - Tài liệu API: [docs/api/API_REFERENCE.md](docs/api/API_REFERENCE.md)
172
101
 
173
- **🔄 Tiến hóa kiến thức** — Quyết định thay đổi. `forget` lưu trữ ký ức cũ (không bao giờ xóa thật sự). Quan hệ `supersedes` nối cũ với mới. AI của bạn luôn thấy phiên bản mới nhất.
174
-
175
- **⚠️ Phát hiện mâu thuẫn** — Nếu có hai ký ức mâu thuẫn nhau, MeMesh sẽ cảnh báo.
176
-
177
- **📦 Chia sẻ nhóm** — `memesh export > team-knowledge.json` → chia sẻ với nhóm → `memesh import team-knowledge.json`
178
-
179
- ---
180
-
181
- ## Mở Khóa Chế Độ Thông Minh (Tùy Chọn)
182
-
183
- MeMesh hoạt động hoàn toàn offline theo mặc định. Thêm API key của LLM để mở khóa tìm kiếm thông minh hơn:
184
-
185
- ```bash
186
- memesh config set llm.provider anthropic
187
- memesh config set llm.api-key sk-ant-...
188
- ```
189
-
190
- Hoặc dùng tab Cài đặt trong dashboard (cấu hình trực quan):
191
-
192
- ```bash
193
- memesh # mở dashboard → tab Cài đặt
194
- ```
195
-
196
- | | Cấp 0 (mặc định) | Cấp 1 (Chế độ thông minh) |
197
- |---|---|---|
198
- | **Tìm kiếm** | Khớp từ khóa FTS5 | + Mở rộng truy vấn bằng LLM (~97% recall) |
199
- | **Tự động thu thập** | Pattern dựa trên quy tắc | + LLM trích xuất quyết định & bài học |
200
- | **Nén** | Không có | `consolidate` nén ký ức dài dòng |
201
- | **Chi phí** | Miễn phí, không cần API key | ~$0.0001 mỗi tìm kiếm (Haiku) |
202
-
203
- ---
204
-
205
- ## Tất Cả 8 Công Cụ Bộ Nhớ
206
-
207
- | Công cụ | Chức năng |
208
- |------|-------------|
209
- | `remember` | Lưu kiến thức kèm quan sát, quan hệ và thẻ nhãn |
210
- | `recall` | Tìm kiếm thông minh với scoring đa nhân tố và mở rộng truy vấn bằng LLM |
211
- | `forget` | Lưu trữ mềm (không bao giờ xóa thật) hoặc xóa quan sát cụ thể |
212
- | `consolidate` | Nén ký ức dài dòng bằng LLM |
213
- | `export` | Chia sẻ ký ức dạng JSON giữa dự án hoặc thành viên nhóm |
214
- | `import` | Nhập ký ức với chiến lược gộp (bỏ qua / ghi đè / nối thêm) |
215
- | `learn` | Ghi lại bài học có cấu trúc từ sai lầm (lỗi, nguyên nhân gốc, cách sửa, phòng ngừa) |
216
- | `user_patterns` | Phân tích pattern làm việc — lịch trình, công cụ, điểm mạnh, lĩnh vực cần học |
217
-
218
- ---
219
-
220
- ## Kiến Trúc
221
-
222
- ```
223
- ┌─────────────────┐
224
- │ Core Engine │
225
- │ (8 operations) │
226
- └────────┬────────┘
227
- ┌─────────────────┼─────────────────┐
228
- │ │ │
229
- CLI (memesh) HTTP API (serve) MCP (memesh-mcp)
230
- │ │ │
231
- └─────────────────┼─────────────────┘
232
-
233
- SQLite + FTS5 + sqlite-vec
234
- (~/.memesh/knowledge-graph.db)
235
- ```
236
-
237
- Core độc lập với framework. Logic giống nhau chạy từ terminal, HTTP hoặc MCP.
238
-
239
- ---
240
-
241
- ## Đóng Góp
102
+ ## Phát triển kiểm thử
242
103
 
243
104
  ```bash
244
105
  git clone https://github.com/PCIRCLE-AI/memesh-llm-memory
245
- cd memesh-llm-memory && npm install && npm run build
246
- npm test -- --run # 413 tests
106
+ cd memesh-llm-memory
107
+ npm install
108
+ npm run build
109
+ npm test
247
110
  ```
248
-
249
- Dashboard: `cd dashboard && npm install && npm run dev`
250
-
251
- ---
252
-
253
- <p align="center">
254
- <strong>MIT</strong> — Được tạo bởi <a href="https://pcircle.ai">PCIRCLE AI</a>
255
- </p>
package/README.zh-CN.md CHANGED
@@ -3,253 +3,108 @@
3
3
  <p align="center">
4
4
  <h1 align="center">MeMesh LLM Memory</h1>
5
5
  <p align="center">
6
- <strong>最轻量的通用 AI 记忆层。</strong><br />
7
- 一个 SQLite 文件。任何 LLM。零云端依赖。
8
- </p>
9
- <p align="center">
10
- <a href="https://www.npmjs.com/package/@pcircle/memesh"><img src="https://img.shields.io/npm/v/@pcircle/memesh?style=flat-square&color=3b82f6&label=npm" alt="npm" /></a>
11
- <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-22c55e?style=flat-square" alt="MIT" /></a>
12
- <a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%3E%3D20-22c55e?style=flat-square" alt="Node" /></a>
13
- <a href="https://modelcontextprotocol.io"><img src="https://img.shields.io/badge/MCP-compatible-a855f7?style=flat-square" alt="MCP" /></a>
6
+ <strong>给 Claude Code 和 MCP coding agents 用的本地记忆层。</strong><br />
7
+ 一个 SQLite 文件。不需要 Docker。不需要云端。
14
8
  </p>
15
9
  </p>
16
10
 
17
- ---
11
+ > 这份简体中文版 README 是精简导览。最新、最完整的内容请以 [English README](README.md) 为准。
18
12
 
19
- ## 问题所在
13
+ ## 它解决什么问题?
20
14
 
21
- 你的 AI 在每次对话结束后都会忘记一切。每一个决策、每一次修复、每一个学到的教训——全部归零。你不断重新解释相同的背景,Claude 反复重新发现相同的模式,而你的 AI 知识库每次都从零开始。
15
+ coding agent 很容易在不同 session 之间丢失上下文。架构决策、修 bug 的过程、踩过的坑、项目限制,常常要反复解释。
22
16
 
23
- **MeMesh 让每个 AI 都能拥有持久、可搜索、持续进化的记忆。**
17
+ **MeMesh 把这些知识保存在本地,可搜索、可查看,也能在后续工作里再次被召回。**
24
18
 
25
- ---
19
+ 这个 npm package 是 MeMesh 的本地 plugin / package 版本,重点是本地记忆,不是云端工作台,也不是企业平台。
26
20
 
27
- ## 60 秒快速上手
21
+ ## 60 秒上手
28
22
 
29
- ### 第一步:安装
23
+ ### 1. 安装
30
24
 
31
25
  ```bash
32
26
  npm install -g @pcircle/memesh
33
27
  ```
34
28
 
35
- ### 第二步:AI 开始记忆
29
+ ### 2. 记下一条决策
36
30
 
37
31
  ```bash
38
32
  memesh remember --name "auth-decision" --type "decision" --obs "Use OAuth 2.0 with PKCE"
39
33
  ```
40
34
 
41
- ### 第三步:AI 召回记忆
35
+ ### 3. 之后再找回来
42
36
 
43
37
  ```bash
44
38
  memesh recall "login security"
45
- # → 搜索「login security」也能找到「OAuth 2.0 with PKCE
39
+ # → 即使换种说法,也能找到 "OAuth 2.0 with PKCE"
46
40
  ```
47
41
 
48
- **就这样。** MeMesh 已开始在不同对话之间记忆与召回。
49
-
50
- 运行以下命令探索你的记忆库:
42
+ 打开 dashboard:
51
43
 
52
44
  ```bash
53
45
  memesh
54
46
  ```
55
47
 
56
- <p align="center">
57
- <img src="docs/images/dashboard-search.png" alt="MeMesh Search — 瞬间找到任何记忆" width="100%" />
58
- </p>
59
-
60
- <p align="center">
61
- <img src="docs/images/dashboard-analytics.png" alt="MeMesh Analytics — 深入了解 AI 的知识" width="100%" />
62
- </p>
63
-
64
- <p align="center">
65
- <img src="docs/images/dashboard-graph.png" alt="MeMesh Graph — 交互式知识图谱,支持类型筛选与自我模式" width="100%" />
66
- </p>
67
-
68
- ---
69
-
70
- ## 这是为谁设计的?
71
-
72
- | 如果你是… | MeMesh 能帮你… |
73
- |---------------|---------------------|
74
- | **使用 Claude Code 的开发者** | 自动记忆决策、模式与每次对话中的心得 |
75
- | **以 LLM 打造产品的团队** | 通过导出/导入共享团队知识,让每个人的 AI 上下文保持一致 |
76
- | **AI Agent 开发者** | 通过 MCP、HTTP API 或 Python SDK 赋予 Agent 持久记忆 |
77
- | **同时使用多款 AI 工具的重度用户** | 一个记忆层,兼容 Claude、GPT、LLaMA、Ollama 或任何 MCP 客户端 |
78
-
79
- ---
80
-
81
- ## 与所有工具兼容
82
-
83
- <table>
84
- <tr>
85
- <td width="33%" align="center">
86
-
87
- **Claude Code / Desktop**
88
- ```bash
89
- memesh-mcp
90
- ```
91
- MCP 协议(自动配置)
92
-
93
- </td>
94
- <td width="33%" align="center">
95
-
96
- **Python / LangChain**
97
- ```python
98
- from memesh import MeMesh
99
- m = MeMesh()
100
- m.recall("auth")
101
- ```
102
- `pip install memesh`
103
-
104
- </td>
105
- <td width="33%" align="center">
106
-
107
- **任何 LLM(OpenAI 格式)**
108
- ```bash
109
- memesh export-schema \
110
- --format openai
111
- ```
112
- 粘贴到任何 API 调用
113
-
114
- </td>
115
- </tr>
116
- </table>
117
-
118
- ---
119
-
120
- ## 为何不用 Mem0 / Zep?
48
+ ## 适合谁?
121
49
 
122
- | | **MeMesh** | Mem0 | Zep |
123
- |---|---|---|---|
124
- | **安装时间** | 5 | 30–60 分钟 | 30+ 分钟 |
125
- | **配置方式** | `npm i -g` 完成 | Neo4j + VectorDB + API 密钥 | Neo4j + 配置 |
126
- | **存储方式** | 单一 SQLite 文件 | Neo4j + Qdrant | Neo4j |
127
- | **离线使用** | 支持,始终如此 | 不支持 | 不支持 |
128
- | **仪表板** | 内置(7 个标签页 + 分析) | 无 | 无 |
129
- | **依赖包** | 6 | 20+ | 10+ |
130
- | **价格** | 永久免费 | 免费方案/付费 | 免费方案/付费 |
50
+ - 使用 Claude Code,希望跨 session 保留项目上下文的开发者
51
+ - 使用 MCP coding agents,希望共用同一份本地记忆的高级用户
52
+ - 小型 AI-native 开发团队,希望通过 export / import 共享项目知识
53
+ - 想把本地记忆接入 CLI、HTTP MCP 工作流的 agent 开发者
131
54
 
132
- **MeMesh 的取舍:** 放弃企业级多租户功能,换来**即时安装、零基础设施、百分之百隐私**。
55
+ ## 为什么选 MeMesh?
133
56
 
134
- ---
57
+ - 本地优先:数据保存在你自己的 SQLite 文件里
58
+ - 安装轻量:`npm install -g` 后即可使用
59
+ - 接入直接:同时支持 CLI、HTTP、MCP
60
+ - 对 Claude Code 友好:提供 hooks,可在工作流里自动带入相关记忆
61
+ - 可查看可清理:内建 dashboard,不是黑盒
62
+ - 更安全的导入边界:导入的记忆默认可搜索,但不会直接自动注入到 Claude hooks,除非你重新审核或在本地重新保存
135
63
 
136
- ## 自动运作的功能
64
+ ## 在 Claude Code 里会自动做什么?
137
65
 
138
- 你不需要手动记忆每一件事。MeMesh **4 个 Hook**,在你不做任何事的情况下自动捕获知识:
66
+ MeMesh 目前会在 5 个时机帮你:
139
67
 
140
- | 时机 | MeMesh 做了什么 |
141
- |------|------------------|
142
- | **每次会话开始** | 加载最相关的记忆 + 来自过去教训的主动警告 |
143
- | **每次 `git commit` 后** | 记录你的变更内容与差异统计 |
144
- | **Claude 结束时** | 捕获已编辑的文件、已修复的错误,并自动从失败中生成结构化教训 |
145
- | **上下文压缩前** | 在知识因上下文限制消失前保存起来 |
68
+ - session 开始时,加载项目相关记忆和已知教训
69
+ - 编辑文件前,先召回与该文件或项目相关的记忆
70
+ - `git commit` 后,记录你做了哪些改动
71
+ - session 结束时,整理本次修复、错误和 lesson learned
72
+ - context compact 之前,先把重要内容写回本地记忆
146
73
 
147
- > **随时退出:** `export MEMESH_AUTO_CAPTURE=false`
74
+ ## Dashboard 里有什么?
148
75
 
149
- ---
76
+ Dashboard 目前有 7 个标签页,并支持 11 种语言:
150
77
 
151
- ## 仪表板
78
+ - Search:搜索记忆
79
+ - Browse:浏览全部记忆
80
+ - Analytics:查看健康度、趋势和使用情况
81
+ - Graph:查看知识关系图
82
+ - Lessons:查看过往经验教训
83
+ - Manage:归档或恢复记忆
84
+ - Settings:设置 LLM provider 和语言
152
85
 
153
- 7 个标签页、11 种语言、零外部依赖。服务器运行后在 `http://localhost:3737/dashboard` 访问。
86
+ ## Smart Mode 是什么?
154
87
 
155
- | 标签页 | 内容 |
156
- |--------|------|
157
- | **Search** | 跨所有记忆的全文搜索 + 向量相似度搜索 |
158
- | **Browse** | 所有实体的分页列表,支持归档/恢复 |
159
- | **Analytics** | 记忆健康分数(0-100)、30 天时间轴、价值指标、知识覆盖率、清理建议、你的工作模式 |
160
- | **Graph** | 交互式力导向知识图谱,支持类型筛选、搜索、自我模式、时间热力图 |
161
- | **Lessons** | 从过去失败中生成的结构化教训(错误、根因、修复方法、预防措施) |
162
- | **Manage** | 归档与恢复实体 |
163
- | **Settings** | LLM 提供者配置、语言选择 |
88
+ MeMesh 默认就能离线使用。若你额外配置 LLM API key,可以启用更智能的能力,例如:
164
89
 
165
- ---
90
+ - query expansion
91
+ - 更好的自动提取
92
+ - 更智能的记忆整理与压缩
166
93
 
167
- ## 智能功能
94
+ 不配置也可以正常使用核心功能。
168
95
 
169
- **🧠 智能搜索** — 搜索「login security」就能找到关于「OAuth PKCE」的记忆。MeMesh 使用你配置的 LLM 将查询扩展为相关词汇。
96
+ ## 更多信息
170
97
 
171
- **📊 评分排名** 结果依相关性(35%)+ 最近使用时间(25%)+ 使用频率(20%)+ 可信度(15%)+ 信息时效性(5%)排序。
98
+ - 完整功能、对比、API release 细节:请看 [English README](README.md)
99
+ - 平台集成方式:请看 [docs/platforms/README.md](docs/platforms/README.md)
100
+ - API 参考:请看 [docs/api/API_REFERENCE.md](docs/api/API_REFERENCE.md)
172
101
 
173
- **🔄 知识演进** — 决策会改变。`forget` 是归档旧记忆(从不真正删除)。`supersedes` 关系将旧记忆与新记忆链接。你的 AI 始终看到最新版本。
174
-
175
- **⚠️ 冲突检测** — 若有两条记忆相互矛盾,MeMesh 会发出警告。
176
-
177
- **📦 团队共享** — `memesh export > team-knowledge.json` → 分享给团队 → `memesh import team-knowledge.json`
178
-
179
- ---
180
-
181
- ## 启用智能模式(可选)
182
-
183
- MeMesh 默认完全离线运作。加入 LLM API 密钥即可解锁更聪明的搜索:
184
-
185
- ```bash
186
- memesh config set llm.provider anthropic
187
- memesh config set llm.api-key sk-ant-...
188
- ```
189
-
190
- 或使用仪表板的设置标签页(可视化配置):
191
-
192
- ```bash
193
- memesh # 打开仪表板 → 设置标签页
194
- ```
195
-
196
- | | 第 0 级(默认) | 第 1 级(智能模式) |
197
- |---|---|---|
198
- | **搜索** | FTS5 关键字匹配 | + LLM 查询扩展(约 97% 召回率) |
199
- | **自动捕获** | 规则式模式 | + LLM 提取决策与心得 |
200
- | **压缩** | 不支持 | `consolidate` 压缩冗长记忆 |
201
- | **费用** | 免费,无需 API 密钥 | 约 $0.0001 每次搜索(Haiku) |
202
-
203
- ---
204
-
205
- ## 全部 8 个记忆工具
206
-
207
- | 工具 | 功能说明 |
208
- |------|-------------|
209
- | `remember` | 存储知识,支持观察记录、关联关系与标签 |
210
- | `recall` | 智能搜索,结合多因子评分与 LLM 查询扩展 |
211
- | `forget` | 软归档(从不真正删除)或移除特定观察记录 |
212
- | `consolidate` | LLM 驱动的冗长记忆压缩 |
213
- | `export` | 将记忆以 JSON 格式分享给其他项目或团队成员 |
214
- | `import` | 导入记忆,支持合并策略(跳过 / 覆盖 / 追加) |
215
- | `learn` | 记录来自错误的结构化教训(错误、根因、修复方法、预防措施) |
216
- | `user_patterns` | 分析你的工作模式 — 时间安排、工具、优势、学习方向 |
217
-
218
- ---
219
-
220
- ## 架构
221
-
222
- ```
223
- ┌─────────────────┐
224
- │ Core Engine │
225
- │ (8 operations) │
226
- └────────┬────────┘
227
- ┌─────────────────┼─────────────────┐
228
- │ │ │
229
- CLI (memesh) HTTP API (serve) MCP (memesh-mcp)
230
- │ │ │
231
- └─────────────────┼─────────────────┘
232
-
233
- SQLite + FTS5 + sqlite-vec
234
- (~/.memesh/knowledge-graph.db)
235
- ```
236
-
237
- 核心引擎与框架无关。无论从终端、HTTP 还是 MCP 调用,逻辑完全相同。
238
-
239
- ---
240
-
241
- ## 贡献
102
+ ## 开发与验证
242
103
 
243
104
  ```bash
244
105
  git clone https://github.com/PCIRCLE-AI/memesh-llm-memory
245
- cd memesh-llm-memory && npm install && npm run build
246
- npm test -- --run # 413 tests
106
+ cd memesh-llm-memory
107
+ npm install
108
+ npm run build
109
+ npm test
247
110
  ```
248
-
249
- 仪表板:`cd dashboard && npm install && npm run dev`
250
-
251
- ---
252
-
253
- <p align="center">
254
- <strong>MIT</strong> — 由 <a href="https://pcircle.ai">PCIRCLE AI</a> 开发
255
- </p>