Myai Memory

🚀 MyAI 項目文檔

MyAI 是一個可在本地運行的 AI 代理系統，能為用戶提供高效、安全且私密的 AI 服務，有效滿足用戶在本地使用 AI 服務的需求。

🚀 快速開始

開發模式運行

npm run dev

帶 HTTP 服務器的開發模式

npm run dev:http

監控 TypeScript 編譯

npm run build:watch

運行測試

npm test

指定測試用例

npm test -- -t "platformSync"

格式化代碼

npm run lint

類型檢查

npm run typecheck

✨ 主要特性

核心組件優勢

• MCP（MyAI Control Protocol）服務器：負責協調和管理所有平臺的同步，還提供 HTTP 和 SSE 運輸支持，保障平臺間的高效協作。
• 命令行界面 (CLI)：提供多種命令用於操作 MyAI，如 --help、--remember 等，方便用戶對系統進行靈活控制。
• 自然語言處理模塊：支持通過自然語言指令控制 AI 代理，並且是直接從主文件同步所有平臺的最可靠方法，提升了用戶與系統交互的便捷性。
• 緩存系統：提供顯著的性能提升，內存查詢時間從 ~2000ms 優化到 ~1ms（2000x 改善），平臺同步時間從 ~850ms 優化到 ~350ms（2.4x 改善），大大提高了系統的運行效率。

安全與隱私保障

• 所有數據均存儲在本地設備上，確保用戶數據的隱私性。
• 自動將 CLAUDE.md 文件添加到 .gitignore 中，避免意外提交到版本控制系統，防止敏感信息洩露。
• 支持加密文件系統以確保最大安全性，為用戶數據保駕護航。

🔧 技術細節

項目架構

核心組件

1. MCP（MyAI Control Protocol）服務器
   • 負責協調和管理所有平臺的同步，確保各個平臺之間的數據和操作能夠即時、準確地同步。
   • 提供 HTTP 和 SSE 運輸支持，為數據的傳輸提供了高效、穩定的通道。
2. 命令行界面 (CLI)
   • 提供多種命令用於操作 MyAI，用戶可以通過輸入不同的命令，如 --help、--remember 等，來實現對系統的各種操作。
3. 自然語言處理模塊
   • 支持通過自然語言指令控制 AI 代理，用戶可以使用日常的自然語言與系統進行交互，無需編寫複雜的代碼。
   • 直接從主文件同步所有平臺的最可靠方法，保證了各個平臺之間的數據一致性。
4. 緩存系統
   • 提供顯著的性能提升，通過緩存技術，將內存查詢時間從 ~2000ms 優化到 ~1ms（2000x 改善），平臺同步時間從 ~850ms 優化到 ~350ms（2.4x 改善），大大提高了系統的響應速度和運行效率。

開發流程

# 開發模式運行
npm run dev

# 帶 HTTP 服務器的開發模式
npm run dev:http

# 監控 TypeScript 編譯
npm run build:watch

# 運行測試
npm test

# 指定測試用例
npm test -- -t "platformSync"

# 格式化代碼
npm run lint

# 類型檢查
npm run typecheck

📚 詳細文檔

安全與隱私

• 所有數據均存儲在本地設備上，避免了數據在網絡傳輸過程中的風險，保障了用戶數據的隱私性。
• 自動將 CLAUDE.md 文件添加到 .gitignore 中，防止該文件被意外提交到版本控制系統，避免了敏感信息的洩露。
• 支持加密文件系統以確保最大安全性，對存儲在本地設備上的數據進行加密處理，進一步增強了數據的安全性。

常見問題解決

1. CLAUDE.md 更新失敗

• 檢查文件權限：使用命令 ls -la CLAUDE.md，確保用戶對該文件具有足夠的操作權限。
• 執行緊急同步：運行腳本 ./emergency-sync.sh，嘗試通過緊急同步的方式解決文件更新失敗的問題。

2. MCP 連接故障

• 確保 MCP 服務器正在運行，檢查進程：ps aux | grep myai-memory，如果服務器未運行，需要啟動服務器。
• 查看 Claude Desktop 日誌中的 MCP 錯誤信息，根據錯誤信息進行針對性的排查和解決。

3. 緩存問題

• 使用命令 node dist/cli.js --clear-cache 清除緩存，解決因緩存數據異常導致的問題。
• 驗證Anthropic API 密鑰是否配置正確，確保 API 密鑰的有效性。

手動同步方法

# 直接同步（最可靠）
cd /path/to/myAImemory
node sync-memory.js

# 緊急同步（權限問題時使用）
cd /path/to/myAImemory
./safe-memory.sh sync

日誌與調試

• 啟用調試模式：DEBUG=true npm run start，通過啟用調試模式，可以獲取更多的系統運行信息，方便進行問題排查。
• 日誌文件路徑：
  • Linux/macOS: ~/.local/share/myai-memory/logs/
  • Windows: %APPDATA%\myai-memory\logs\，用戶可以通過查看日誌文件，瞭解系統的運行狀態和出現的問題。

貢獻指南

歡迎貢獻！請按照以下步驟提交 Pull Request：

1. Fork 倉庫。
2. 創建功能分支：git checkout -b feature/amazing-feature。
3. 提交更改：git commit -m 'Add some amazing feature'。
4. 推送到分支：git push origin feature/amazing-feature。
5. 創建 Pull Request。

文檔說明

詳細文檔請參考項目的 Wiki。 API 文檔位於 /docs 目錄中，可使用以下命令生成 API 文檔：

# 生成 API 文檔
npm run docs

📄 許可證

該項目在 MIT 協議下開源，具體信息見 LICENSE 文件。