@pcircle/memesh 4.0.2 → 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.
package/README.ko.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는 세션이 바뀌면 맥락을 잃기 쉽습니다. 아키텍처 결정, 버그를 고친 과정, 이미 배운 교훈, 프로젝트 제약을 계속 다시 설명해야 합니다.
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
- ### 1단계: 설치
23
+ ### 1. 설치
30
24
 
31
25
  ```bash
32
26
  npm install -g @pcircle/memesh
33
27
  ```
34
28
 
35
- ### 2단계: 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
- ### 3단계: AI가 떠올리기
35
+ ### 3. 나중에 다시 찾기
42
36
 
43
37
  ```bash
44
38
  memesh recall "login security"
45
- # → 다른 단어로 검색해도 "OAuth 2.0 with PKCE"를 찾아냅니다
39
+ # → 표현이 달라도 "OAuth 2.0 with PKCE"를 찾을 수 있습니다
46
40
  ```
47
41
 
48
- **끝입니다.** MeMesh가 세션을 넘나들며 기억하고 떠올리기 시작했습니다.
49
-
50
- 대시보드를 열어 메모리를 탐색해보세요:
42
+ 대시보드 열기:
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 에이전트 개발자** | MCP, HTTP API, Python SDK를 통해 에이전트에 지속 메모리 부여 |
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를 쓰면서 세션 사이에도 프로젝트 맥락을 유지하고 싶은 개발자
51
+ - 같은 로컬 메모리를 여러 MCP coding agents에서 함께 쓰고 싶은 고급 사용자
52
+ - export / import로 지식을 공유하려는 소규모 AI-native 개발팀
53
+ - CLI, HTTP, MCP 흐름에 로컬 메모리를 붙이고 싶은 agent 개발자
131
54
 
132
- **MeMesh의 트레이드오프:** 엔터프라이즈급 멀티테넌트 기능을 포기하는 대신 **즉시 설치, 제로 인프라, 100% 프라이버시**를 얻습니다.
55
+ ## MeMesh인가?
133
56
 
134
- ---
57
+ - 로컬 우선: 데이터가 내 SQLite 파일에 저장됨
58
+ - 가벼운 설치: `npm install -g` 후 바로 사용 가능
59
+ - 연결 방식이 명확함: CLI, HTTP, MCP 지원
60
+ - Claude Code 친화적: hooks로 작업 중 관련 메모리를 쉽게 불러옴
61
+ - 확인과 정리가 쉬움: dashboard가 있어 블랙박스가 아님
62
+ - import 안전 경계: import한 메모리는 검색되더라도, 검토하거나 다시 저장하기 전에는 Claude hooks에 자동 주입되지 않음
135
63
 
136
- ## 자동으로 일어나는 일들
64
+ ## Claude Code에서 자동으로 하는
137
65
 
138
- 모든 것을 직접 기억할 필요가 없습니다. MeMesh에는 **4개의 훅**이 있어 아무것도 하지 않아도 지식을 자동으로 포착합니다:
66
+ MeMesh 현재 다음 5가지 시점에 도움을 줍니다.
139
67
 
140
- | 언제 | MeMesh가 하는 |
141
- |------|------------------|
142
- | **모든 세션 시작 시** | 가장 관련성 높은 메모리를 로드 + 과거 교훈으로부터의 사전 경고 |
143
- | **모든 `git commit` 후** | 변경 내용과 diff 통계를 기록 |
144
- | **Claude 종료 시** | 편집한 파일, 수정한 오류를 포착하고 실패로부터 구조화된 교훈을 자동 생성 |
145
- | **컨텍스트 압축 전** | 컨텍스트 한계로 사라지기 전에 지식을 저장 |
68
+ - 세션 시작 관련 메모리와 이미 배운 교훈을 불러옴
69
+ - 파일 편집 전에 그 파일이나 프로젝트와 관련된 메모리를 먼저 찾음
70
+ - `git commit` 변경 내용을 기록함
71
+ - 세션 종료 이번 수정, 오류, 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
+ API key가 없어도 핵심 기능은 그대로 사용할 수 있습니다.
168
95
 
169
- **🧠 스마트 검색** — "login security"를 검색하면 "OAuth PKCE"에 관한 메모리를 찾아냅니다. 설정한 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>
package/README.md CHANGED
@@ -260,7 +260,7 @@ Core is framework-agnostic. Same logic runs from terminal, HTTP, or MCP.
260
260
  ```bash
261
261
  git clone https://github.com/PCIRCLE-AI/memesh-llm-memory
262
262
  cd memesh-llm-memory && npm install && npm run build
263
- npm test # 463 tests
263
+ npm test # 484 tests
264
264
  npm run test:e2e-dashboard
265
265
  ```
266
266
 
package/README.pt.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>A camada de memória de IA universal mais leve.</strong><br />
7
- Um único arquivo SQLite. Qualquer LLM. Zero nuvem.
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>Camada de memória local para Claude Code e agentes de código compatíveis com MCP.</strong><br />
7
+ Um arquivo SQLite. Sem Docker. Sem depender de nuvem.
14
8
  </p>
15
9
  </p>
16
10
 
17
- ---
11
+ > Este README em português é uma versão resumida. Para a documentação mais completa e atualizada, use o [English README](README.md).
18
12
 
19
- ## O Problema
13
+ ## Qual problema ele resolve?
20
14
 
21
- Seu AI esquece tudo entre sessões. Cada decisão, cada correção de bug, cada lição aprendida tudo some. Você explica o mesmo contexto de novo e de novo, o Claude redescobre os mesmos padrões, e o conhecimento de IA da sua equipe volta ao zero toda vez.
15
+ Agentes de código costumam perder o contexto entre sessões. Decisões de arquitetura, correções importantes, erros resolvidos e restrições do projeto acabam sendo explicados de novo e de novo.
22
16
 
23
- **O MeMesh a cada AI uma memória persistente, pesquisável e em constante evolução.**
17
+ **O MeMesh mantém esse conhecimento no seu ambiente local, com busca, inspeção e reaproveitamento ao longo do trabalho.**
24
18
 
25
- ---
19
+ Este pacote npm é a versão local do plugin / package do MeMesh. Ele não é o produto de workspace em nuvem nem uma plataforma enterprise completa.
26
20
 
27
- ## Comece em 60 Segundos
21
+ ## Comece em 60 segundos
28
22
 
29
- ### Passo 1: Instale
23
+ ### 1. Instale
30
24
 
31
25
  ```bash
32
26
  npm install -g @pcircle/memesh
33
27
  ```
34
28
 
35
- ### Passo 2: Seu AI lembra
29
+ ### 2. Salve uma decisão
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
- ### Passo 3: Seu AI recupera
35
+ ### 3. Recupere depois
42
36
 
43
37
  ```bash
44
38
  memesh recall "login security"
45
- # → Encontra "OAuth 2.0 with PKCE" mesmo com palavras diferentes
39
+ # → encontra "OAuth 2.0 with PKCE" mesmo com palavras diferentes
46
40
  ```
47
41
 
48
- **Pronto.** O MeMesh já está lembrando e recuperando memórias entre sessões.
49
-
50
- Abra o painel para explorar sua memória:
42
+ Abra o 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 — encontre qualquer memória instantaneamente" width="100%" />
58
- </p>
59
-
60
- <p align="center">
61
- <img src="docs/images/dashboard-analytics.png" alt="MeMesh Analytics — entenda o conhecimento do seu AI" width="100%" />
62
- </p>
63
-
64
- <p align="center">
65
- <img src="docs/images/dashboard-graph.png" alt="MeMesh Graph — grafo de conhecimento interativo com filtros de tipo e modo ego" width="100%" />
66
- </p>
67
-
68
- ---
69
-
70
- ## Para Quem É Isso?
71
-
72
- | Se você é... | O MeMesh ajuda você a... |
73
- |---------------|---------------------|
74
- | **Desenvolvedor usando Claude Code** | Lembrar decisões, padrões e lições entre sessões automaticamente |
75
- | **Equipe construindo com LLMs** | Compartilhar conhecimento da equipe via exportação/importação, mantendo o contexto de todos alinhado |
76
- | **Desenvolvedor de agentes de IA** | Dar aos seus agentes memória persistente via MCP, HTTP API ou Python SDK |
77
- | **Usuário avançado com múltiplas ferramentas de IA** | Uma camada de memória que funciona com Claude, GPT, LLaMA, Ollama ou qualquer cliente MCP |
78
-
79
- ---
80
-
81
- ## Funciona com Tudo
82
-
83
- <table>
84
- <tr>
85
- <td width="33%" align="center">
86
-
87
- **Claude Code / Desktop**
88
- ```bash
89
- memesh-mcp
90
- ```
91
- Protocolo MCP (configurado automaticamente)
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
- **Qualquer LLM (formato OpenAI)**
108
- ```bash
109
- memesh export-schema \
110
- --format openai
111
- ```
112
- Cole as ferramentas em qualquer chamada de API
113
-
114
- </td>
115
- </tr>
116
- </table>
117
-
118
- ---
119
-
120
- ## Por que Não Usar Mem0 / Zep?
48
+ ## Para quem ele foi feito?
121
49
 
122
- | | **MeMesh** | Mem0 | Zep |
123
- |---|---|---|---|
124
- | **Tempo de instalação** | 5 segundos | 30–60 minutos | 30+ minutos |
125
- | **Configuração** | `npm i -g` pronto | Neo4j + VectorDB + chaves de API | Neo4j + config |
126
- | **Armazenamento** | Arquivo SQLite único | Neo4j + Qdrant | Neo4j |
127
- | **Funciona offline** | Sim, sempre | Não | Não |
128
- | **Painel** | Integrado (7 abas + analytics) | Nenhum | Nenhum |
129
- | **Dependências** | 6 | 20+ | 10+ |
130
- | **Preço** | Grátis para sempre | Plano gratuito / Pago | Plano gratuito / Pago |
50
+ - Desenvolvedores que usam Claude Code e querem manter contexto entre sessões
51
+ - Usuários avançados que querem compartilhar a mesma memória local entre agentes MCP
52
+ - Pequenas equipes AI-native que querem trocar conhecimento via export / import
53
+ - Desenvolvedores de agents que querem integrar memória local via CLI, HTTP ou MCP
131
54
 
132
- **O MeMesh abre mão de:** recursos empresariais multi-inquilino em troca de **configuração instantânea, zero infraestrutura e 100% de privacidade**.
55
+ ## Por que usar o MeMesh?
133
56
 
134
- ---
57
+ - Local-first: os dados ficam no seu próprio arquivo SQLite
58
+ - Instalação leve: `npm install -g` e pronto
59
+ - Integração direta: suporta CLI, HTTP e MCP
60
+ - Bom encaixe com Claude Code: hooks ajudam a trazer contexto no fluxo de trabalho
61
+ - Transparência: o dashboard permite ver e organizar a memória
62
+ - Limite de confiança mais seguro: memórias importadas continuam pesquisáveis, mas não entram automaticamente nos hooks do Claude sem revisão ou novo salvamento local
135
63
 
136
- ## O que Acontece Automaticamente
64
+ ## O que ele faz automaticamente no Claude Code?
137
65
 
138
- Você não precisa lembrar de tudo manualmente. O MeMesh possui **4 hooks** que capturam conhecimento sem que você precise fazer nada:
66
+ Hoje o MeMesh ajuda em 5 momentos:
139
67
 
140
- | Quando | O que o MeMesh faz |
141
- |------|------------------|
142
- | **Início de cada sessão** | Carrega suas memórias mais relevantes + avisos proativos de lições passadas |
143
- | **Após cada `git commit`** | Registra o que você alterou, com estatísticas do diff |
144
- | **Quando o Claude para** | Captura arquivos editados, erros corrigidos e gera automaticamente lições estruturadas a partir de falhas |
145
- | **Antes da compactação de contexto** | Salva o conhecimento antes que se perca por limite de contexto |
68
+ - no início da sessão, carrega memórias relevantes e lições já conhecidas
69
+ - antes de editar arquivos, busca memórias relacionadas ao arquivo ou ao projeto
70
+ - depois de `git commit`, registra o que foi alterado
71
+ - no fim da sessão, organiza correções, erros e lessons learned
72
+ - antes do compact de contexto, salva o que não deveria se perder
146
73
 
147
- > **Desative quando quiser:** `export MEMESH_AUTO_CAPTURE=false`
74
+ ## O que existe no dashboard?
148
75
 
149
- ---
76
+ O dashboard tem 7 abas e suporte a 11 idiomas:
150
77
 
151
- ## Painel
78
+ - Search: buscar memórias
79
+ - Browse: listar memórias
80
+ - Analytics: acompanhar saúde e tendências
81
+ - Graph: ver relações de conhecimento
82
+ - Lessons: revisar lições aprendidas
83
+ - Manage: arquivar e restaurar memórias
84
+ - Settings: configurar provedor de LLM e idioma
152
85
 
153
- 7 abas, 11 idiomas, zero dependências externas. Acesse em `http://localhost:3737/dashboard` quando o servidor estiver rodando.
86
+ ## O que é o Smart Mode?
154
87
 
155
- | Aba | O que você |
156
- |-----|---------------|
157
- | **Search** | Busca full-text + similaridade vetorial em todas as memórias |
158
- | **Browse** | Lista paginada de todas as entidades com arquivamento/restauração |
159
- | **Analytics** | Pontuação de Saúde da Memória (0-100), timeline de 30 dias, métricas de valor, cobertura de conhecimento, sugestões de limpeza, seus padrões de trabalho |
160
- | **Graph** | Grafo de conhecimento interativo dirigido por força com filtros de tipo, busca, modo ego, heatmap de recência |
161
- | **Lessons** | Lições estruturadas de falhas passadas (erro, causa raiz, correção, prevenção) |
162
- | **Manage** | Arquivar e restaurar entidades |
163
- | **Settings** | Configuração do provedor LLM, seletor de idioma |
88
+ O MeMesh funciona offline por padrão. Se você configurar uma API key de LLM, pode habilitar recursos extras, como:
164
89
 
165
- ---
90
+ - query expansion
91
+ - extração automática mais útil
92
+ - organização e compressão mais inteligentes
166
93
 
167
- ## Funcionalidades Inteligentes
94
+ Sem API key, o núcleo do produto continua funcionando normalmente.
168
95
 
169
- **🧠 Busca Inteligente** — Pesquise "login security" e encontre memórias sobre "OAuth PKCE". O MeMesh expande consultas com termos relacionados usando o LLM configurado.
96
+ ## Leia mais
170
97
 
171
- **📊 Classificação por Pontuação** Resultados classificados por relevância (35%) + recência de uso (25%) + frequência (20%) + confiança (15%) + se a informação ainda é atual (5%).
98
+ - Funcionalidades completas, comparações, API e release notes: [English README](README.md)
99
+ - Guia de integrações: [docs/platforms/README.md](docs/platforms/README.md)
100
+ - Referência de API: [docs/api/API_REFERENCE.md](docs/api/API_REFERENCE.md)
172
101
 
173
- **🔄 Evolução do Conhecimento** — As decisões mudam. `forget` arquiva memórias antigas (nunca deleta). Relações `supersedes` conectam o antigo ao novo. Seu AI sempre vê a versão mais recente.
174
-
175
- **⚠️ Detecção de Conflitos** — Se você tiver duas memórias que se contradizem, o MeMesh avisa.
176
-
177
- **📦 Compartilhamento em Equipe** — `memesh export > team-knowledge.json` → compartilhe com sua equipe → `memesh import team-knowledge.json`
178
-
179
- ---
180
-
181
- ## Ative o Modo Inteligente (Opcional)
182
-
183
- O MeMesh funciona completamente offline por padrão. Adicione uma chave de API de LLM para desbloquear buscas mais inteligentes:
184
-
185
- ```bash
186
- memesh config set llm.provider anthropic
187
- memesh config set llm.api-key sk-ant-...
188
- ```
189
-
190
- Ou use a aba Configurações do painel (configuração visual):
191
-
192
- ```bash
193
- memesh # abre o painel → aba Configurações
194
- ```
195
-
196
- | | Nível 0 (padrão) | Nível 1 (Modo Inteligente) |
197
- |---|---|---|
198
- | **Busca** | Correspondência de palavras-chave FTS5 | + Expansão de consulta por LLM (~97% de recall) |
199
- | **Captura automática** | Padrões baseados em regras | + LLM extrai decisões e lições |
200
- | **Compressão** | Não disponível | `consolidate` comprime memórias longas |
201
- | **Custo** | Grátis, sem chave de API | ~$0,0001 por busca (Haiku) |
202
-
203
- ---
204
-
205
- ## Todas as 8 Ferramentas de Memória
206
-
207
- | Ferramenta | O que faz |
208
- |------|-------------|
209
- | `remember` | Armazena conhecimento com observações, relações e tags |
210
- | `recall` | Busca inteligente com pontuação multifatorial e expansão de consulta por LLM |
211
- | `forget` | Arquivamento suave (nunca deleta) ou remoção de observações específicas |
212
- | `consolidate` | Compressão de memórias longas com auxílio de LLM |
213
- | `export` | Compartilha memórias como JSON entre projetos ou membros da equipe |
214
- | `import` | Importa memórias com estratégias de mesclagem (pular / sobrescrever / anexar) |
215
- | `learn` | Registra lições estruturadas a partir de erros (erro, causa raiz, correção, prevenção) |
216
- | `user_patterns` | Analisa seus padrões de trabalho — agenda, ferramentas, pontos fortes, áreas de aprendizado |
217
-
218
- ---
219
-
220
- ## Arquitetura
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
- O núcleo é independente de framework. A mesma lógica é executada a partir do terminal, HTTP ou MCP.
238
-
239
- ---
240
-
241
- ## Contribuindo
102
+ ## Desenvolvimento e verificação
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
- Painel: `cd dashboard && npm install && npm run dev`
250
-
251
- ---
252
-
253
- <p align="center">
254
- <strong>MIT</strong> — Feito por <a href="https://pcircle.ai">PCIRCLE AI</a>
255
- </p>