🌐 這是自動翻譯。歡迎社群貢獻修正!
🇨🇳 中文 •
🇹🇼 繁體中文 •
🇯🇵 日本語 •
🇵🇹 Português •
🇧🇷 Português •
🇰🇷 한국어 •
🇪🇸 Español •
🇩🇪 Deutsch •
🇫🇷 Français •
🇮🇱 עברית •
🇸🇦 العربية •
🇷🇺 Русский •
🇵🇱 Polski •
🇨🇿 Čeština •
🇳🇱 Nederlands •
🇹🇷 Türkçe •
🇺🇦 Українська •
🇻🇳 Tiếng Việt •
🇵🇭 Tagalog •
🇮🇩 Indonesia •
🇹🇭 ไทย •
🇮🇳 हिन्दी •
🇧🇩 বাংলা •
🇵🇰 اردو •
🇷🇴 Română •
🇸🇪 Svenska •
🇮🇹 Italiano •
🇬🇷 Ελληνικά •
🇭🇺 Magyar •
🇫🇮 Suomi •
🇩🇰 Dansk •
🇳🇴 Norsk
快速開始 •
運作原理 •
搜尋工具 •
文件 •
設定 •
疑難排解 •
授權條款
Claude-Mem 透過自動擷取工具使用觀察、產生語意摘要並在未來的工作階段中提供使用,無縫保留跨工作階段的脈絡。這使 Claude 即使在工作階段結束或重新連線後,仍能維持對專案的知識連續性。
---
## 快速開始
使用單一指令安裝:
```bash
npx claude-mem install
```
或為 OpenCode 安裝:
```bash
npx claude-mem install --ide opencode
```
或為 Antigravity CLI 安裝([設定指南](https://docs.claude-mem.ai/antigravity-cli/setup)):
```bash
npx claude-mem install --ide antigravity
```
或在 Claude Code 內從外掛市集安裝:
```bash
/plugin marketplace add thedotmack/claude-mem
/plugin install claude-mem
```
重新啟動 Claude Code。先前工作階段的脈絡將自動出現在新的工作階段中。
> **注意:** Claude-Mem 也發布於 npm,但 `npm install -g claude-mem` 僅安裝 **SDK/函式庫**——它不會註冊外掛掛鉤或設定 Worker 服務。請務必透過 `npx claude-mem install` 或上述 `/plugin` 指令安裝。
### 🦞 OpenClaw Gateway
只需一個指令,即可在 [OpenClaw](https://openclaw.ai) 閘道上安裝 claude-mem 作為持久記憶外掛:
```bash
curl -fsSL https://install.cmem.ai/openclaw.sh | bash
```
安裝程式會處理相依性、外掛設定、AI 提供者設定、Worker 啟動,以及選用的即時觀察推播至 Telegram、Discord、Slack 等平台。詳情請參閱 [OpenClaw 整合指南](https://docs.claude-mem.ai/openclaw-integration)。
**主要功能:**
- 🧠 **持久記憶** - 脈絡跨工作階段保留
- 📊 **漸進式揭露** - 具有 Token 成本可見性的分層記憶擷取
- 🔍 **技能式搜尋** - 使用 mem-search 技能查詢專案歷史
- 🖥️ **網頁檢視介面** - 在啟動時顯示的 Worker URL 即時檢視記憶串流
- 💻 **Claude Desktop 技能** - 從 Claude Desktop 對話中搜尋記憶
- 🔒 **隱私控制** - 使用 `` 標籤排除敏感內容的儲存
- ⚙️ **脈絡設定** - 精細控制注入哪些脈絡
- 🤖 **自動運作** - 無需手動介入
- 🔗 **引用** - 透過 Worker API 使用 ID 參考過去的觀察,或在網頁檢視器中檢視全部
---
## 文件
📚 **[檢視完整文件](https://docs.claude-mem.ai/)** - 於官方網站瀏覽
### 入門指南
- **[安裝指南](https://docs.claude-mem.ai/installation)** - 快速開始與進階安裝
- **[使用指南](https://docs.claude-mem.ai/usage/getting-started)** - Claude-Mem 如何自動運作
- **[搜尋工具](https://docs.claude-mem.ai/usage/search-tools)** - 使用自然語言查詢專案歷史
### 最佳實務
- **[脈絡工程](https://docs.claude-mem.ai/context-engineering)** - AI 代理脈絡最佳化原則
- **[漸進式揭露](https://docs.claude-mem.ai/progressive-disclosure)** - Claude-Mem 脈絡啟動策略背後的理念
### 架構
- **[概覽](https://docs.claude-mem.ai/architecture/overview)** - 系統元件與資料流程
- **[架構演進](https://docs.claude-mem.ai/architecture-evolution)** - 從 v3 到 v5 的旅程
- **[Hooks 架構](https://docs.claude-mem.ai/hooks-architecture)** - Claude-Mem 如何使用生命週期掛鉤
- **[Hooks 參考](https://docs.claude-mem.ai/architecture/hooks)** - 7 個掛鉤腳本說明
- **[Worker 服務](https://docs.claude-mem.ai/architecture/worker-service)** - HTTP API 與 Bun 管理
- **[資料庫](https://docs.claude-mem.ai/architecture/database)** - SQLite 結構描述與 FTS5 搜尋
- **[搜尋架構](https://docs.claude-mem.ai/architecture/search-architecture)** - 使用 Chroma 向量資料庫的混合搜尋
### 設定與開發
- **[設定](https://docs.claude-mem.ai/configuration)** - 環境變數與設定
- **[開發](https://docs.claude-mem.ai/development)** - 建置、測試、貢獻
- **[發布分支](https://docs.claude-mem.ai/branches)** - Stable、core-dev 與 community-edge 分支流程
- **[疑難排解](https://docs.claude-mem.ai/troubleshooting)** - 常見問題與解決方案
---
## 運作原理
**核心元件:**
1. **5 個生命週期掛鉤** - SessionStart、UserPromptSubmit、PostToolUse、Stop、SessionEnd(6 個掛鉤腳本)
2. **智慧安裝** - 快取的相依性檢查器(pre-hook 腳本,非生命週期掛鉤)
3. **Worker 服務** - 具備網頁檢視介面與搜尋端點的本機 HTTP API,由 Bun 管理
4. **SQLite 資料庫** - 儲存工作階段、觀察、摘要
5. **mem-search 技能** - 具有漸進式揭露的自然語言查詢
6. **Chroma 向量資料庫** - 用於智慧脈絡擷取的混合語意 + 關鍵字搜尋
詳情請參閱[架構概覽](https://docs.claude-mem.ai/architecture/overview)。
---
## MCP 搜尋工具
Claude-Mem 透過遵循 Token 高效的 **3 層工作流程模式**,以 **4 個 MCP 工具**提供智慧記憶搜尋:
**3 層工作流程:**
1. **`search`** - 取得精簡索引與 ID(每筆結果約 50-100 tokens)
2. **`timeline`** - 取得有趣結果周圍的時間脈絡
3. **`get_observations`** - 僅為過濾後的 ID 擷取完整詳情(每筆結果約 500-1,000 tokens)
**運作方式:**
- Claude 使用 MCP 工具搜尋您的記憶
- 從 `search` 開始取得結果索引
- 使用 `timeline` 檢視特定觀察周圍發生的事情
- 使用 `get_observations` 擷取相關 ID 的完整詳情
- 透過在擷取詳情前過濾,**節省約 10 倍 token**
**可用的 MCP 工具:**
1. **`search`** - 使用全文查詢搜尋記憶索引,依類型/日期/專案過濾
2. **`timeline`** - 取得特定觀察或查詢周圍的時間脈絡
3. **`get_observations`** - 依 ID 擷取完整觀察詳情(務必批次處理多個 ID)
**使用範例:**
```typescript
// Step 1: Search for index
search(query="authentication bug", type="bugfix", limit=10)
// Step 2: Review index, identify relevant IDs (e.g., #123, #456)
// Step 3: Fetch full details
get_observations(ids=[123, 456])
```
詳細範例請參閱[搜尋工具指南](https://docs.claude-mem.ai/usage/search-tools)。
---
## 發布分支
穩定版發布來自 `main` 分支並發布至 npm。`core-dev` 與
`community-edge` 是用於早期可靠性修復與社群整合的原始碼執行分支。分支流程與非穩定版執行說明請參閱
**[發布分支](https://docs.claude-mem.ai/branches)**。
---
## 系統需求
- **Node.js**:20.0.0 或更高版本
- **Claude Code**:具有外掛支援的最新版本
- **Bun**:JavaScript 執行環境與程序管理員(如缺少將自動安裝)
- **uv**:用於向量搜尋的 Python 套件管理員(如缺少將自動安裝)
- **SQLite 3**:用於持久儲存(已內建)
---
### Windows 設定注意事項
若您看到如下錯誤訊息:
```powershell
npm : The term 'npm' is not recognized as the name of a cmdlet
```
請確認 Node.js 和 npm 已安裝並加入您的 PATH。請從 https://nodejs.org 下載最新版 Node.js 安裝程式,並在安裝後重新啟動終端機。
---
## 設定
設定在 `~/.claude-mem/settings.json` 中管理(首次執行時自動以預設值建立)。設定 AI 模型、Worker 連接埠、資料目錄、日誌層級與脈絡注入設定。
所有可用設定與範例請參閱 **[設定指南](https://docs.claude-mem.ai/configuration)**。
### 模式與語言設定
Claude-Mem 透過 `CLAUDE_MEM_MODE` 設定支援多種工作流程模式與語言。
此選項控制以下兩者:
- 工作流程行為(例如 code、chill、investigation)
- 產生觀察時使用的語言
#### 如何設定
編輯您位於 `~/.claude-mem/settings.json` 的設定檔:
```json
{
"CLAUDE_MEM_MODE": "code--zh"
}
```
模式定義於 `plugin/modes/` 中。若要在本機檢視所有可用模式:
```bash
ls ~/.claude/plugins/marketplaces/thedotmack/plugin/modes/
```
#### 可用模式
| 模式 | 說明 |
|------------|-------------------------|
| `code` | 預設英文模式 |
| `code--zh` | 簡體中文模式 |
| `code--ja` | 日文模式 |
特定語言模式遵循 `code--[lang]` 的模式,其中 `[lang]` 為 ISO 639-1 語言代碼(例如中文為 `zh`、日文為 `ja`、西班牙文為 `es`)。
> 注意:`code--zh`(簡體中文)已內建——無需額外安裝或更新外掛。
#### 變更模式後
重新啟動 Claude Code 以套用新的模式設定。
---
## 開發
建置說明、測試與貢獻工作流程請參閱 **[開發指南](https://docs.claude-mem.ai/development)**。
---
## 疑難排解
如遇問題,向 Claude 描述問題,troubleshoot 技能將自動診斷並提供修正。
常見問題與解決方案請參閱 **[疑難排解指南](https://docs.claude-mem.ai/troubleshooting)**。
---
## 錯誤回報
使用自動產生器建立完整的錯誤回報:
```bash
cd ~/.claude/plugins/marketplaces/thedotmack
npm run bug-report
```
## 貢獻
歡迎貢獻!請依照以下步驟:
1. Fork 儲存庫
2. 建立功能分支
3. 加入測試並進行變更
4. 更新文件
5. 提交 Pull Request
Claude-Mem 從三個分支發布:`main`(穩定版)、`core-dev` 與
`community-edge`。僅 `main` 會發布至 npm;其他分支則從原始碼執行。策略與本機執行說明請參閱
[發布分支](https://docs.claude-mem.ai/branches)。
貢獻工作流程請參閱[開發指南](https://docs.claude-mem.ai/development)。
---
## 授權條款
Claude-Mem 採用 Apache License 2.0 授權。
我們選擇 Apache-2.0 是因為持久的代理記憶應該易於嵌入至
開發工具、本機代理、MCP 伺服器、企業系統、機器人技術堆疊,
以及生產環境代理框架中。
完整詳情請參閱 [LICENSE](LICENSE) 檔案。授權範圍與開源/商業界線
請參閱 [docs/license.md](docs/license.md) 與 [docs/ip-boundary.md](docs/ip-boundary.md)。
**關於 Ragtime 的說明**:`ragtime/` 目錄採用 **Apache License 2.0** 授權。詳情請參閱 [ragtime/LICENSE](ragtime/LICENSE)。
---
## 支援
- **文件**:[docs/](docs/)
- **Issues**:[GitHub Issues](https://github.com/thedotmack/claude-mem/issues)
- **儲存庫**:[github.com/thedotmack/claude-mem](https://github.com/thedotmack/claude-mem)
- **官方 X 帳號**:[@Claude_Memory](https://x.com/Claude_Memory)
- **官方 Discord**:[加入 Discord](https://discord.com/invite/J4wttp9vDu)
- **作者**:Alex Newman ([@thedotmack](https://github.com/thedotmack))
---
**使用 Claude Agent SDK 建置** | **由 Claude Code 驅動** | **以 TypeScript 開發**
---
### CMEM 是什麼?
CMEM 是由第三方創建的代幣,但獲得 Claude-Mem 創作者(Alex Newman,@thedotmack)的正式支持。該代幣作為社群成長的催化劑,也是將 CMEM 帶給最需要它的開發者與知識工作者的媒介。
官方 BASE 合約地址:0x76b1967eec0ccaeb001bbbb2b40dc4badba31ba3