🚀 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 文件。