README
记忆
在每个会话开始时:
- 在 Vestige 中搜索用户偏好和项目上下文
- 自动保存 bug 修复、决策和模式
- 当用户提及截止日期时创建提醒
| 你说 | AI 操作 |
|---------|---------|
| "Remember this" | 立即保存 |
| "I prefer..." / "I always..." | 保存为偏好 |
| "Remind me..." | 创建未来触发器 |
| "This is important" | 保存并提升 |
[完整 CLAUDE.md 模板 ->](docs/CLAUDE-SETUP.md)
## 📦 安装指南
见快速开始部分,包含不同平台的安装方法。
## 💻 使用示例
### 基础用法
```bash
# 安装 Vestige(macOS Apple Silicon)
curl -L https://github.com/samvallad33/vestige/releases/latest/download/vestige-mcp-aarch64-apple-darwin.tar.gz | tar -xz
sudo mv vestige-mcp vestige vestige-restore /usr/local/bin/
# 连接到 Claude Code
claude mcp add vestige vestige-mcp -s user
# 测试
# "Remember that I prefer TypeScript over JavaScript"
# ...新会话...
# "What are my coding preferences?"
# → "You prefer TypeScript over JavaScript."
高级用法
# Metal GPU 加速(Apple Silicon — 更快的嵌入推理)
cargo build --release -p vestige-mcp --features metal
# Nomic Embed Text v2 MoE(475M 参数,305M 活跃,8 个专家)
cargo build --release -p vestige-mcp --features nomic-v2
# Qwen3 重排器(Candle 后端,高精度交叉编码器)
cargo build --release -p vestige-mcp --features qwen3-reranker
# SQLCipher 加密
cargo build --release -p vestige-mcp --no-default-features --features encryption,embeddings,vector-search
📚 详细文档
| 文档 | 内容 | |----------|----------| | FAQ | 30 + 个常见问题解答 | | Science | 每个功能背后的神经科学原理 | | Storage Modes | 全局、按项目、多实例存储模式 | | CLAUDE.md Setup | 主动记忆的模板 | | Configuration | CLI 命令、环境变量 | | Integrations | Xcode、Cursor、VS Code、JetBrains、Windsurf 的集成指南 | | Changelog | 版本历史 |
🔧 技术细节
| 指标 | 值 | |--------|-------| | 语言 | Rust 2024 版(MSRV 1.91) | | 代码库 | 79600 + 行,1238 个测试 | | 二进制大小 | ~20MB | | 嵌入 | Nomic Embed Text v1.5(768d → 256d Matryoshka,8192 上下文) | | 向量搜索 | USearch HNSW(比 FAISS 快 20 倍) | | 重排器 | Jina Reranker v1 Turbo(38M 参数,精度提高 15 - 20%) | | 存储 | SQLite + FTS5(可选 SQLCipher 加密) | | 仪表盘 | SvelteKit 2 + Svelte 5 + Three.js + Tailwind CSS 4 | | 传输 | MCP stdio(JSON - RPC 2.0)+ WebSocket | | 认知模块 | 29 个有状态模块(16 个神经科学模块,11 个高级模块,2 个搜索模块) | | 首次运行 | 下载嵌入模型(~130MB),之后完全离线 | | 平台 | macOS(ARM/Intel),Linux(x86_64),Windows |
可选特性
# Metal GPU 加速(Apple Silicon — 更快的嵌入推理)
cargo build --release -p vestige-mcp --features metal
# Nomic Embed Text v2 MoE(475M 参数,305M 活跃,8 个专家)
cargo build --release -p vestige-mcp --features nomic-v2
# Qwen3 重排器(Candle 后端,高精度交叉编码器)
cargo build --release -p vestige-mcp --features qwen3-reranker
# SQLCipher 加密
cargo build --release -p vestige-mcp --no-default-features --features encryption,embeddings,vector-search
📄 许可证
本项目采用 AGPL - 3.0 许可证,可免费使用、修改和自托管。如果将 Vestige 作为网络服务提供,则必须开源修改内容。
🔧 CLI 命令
vestige stats # 记忆统计
vestige stats --tagging # 保留分布
vestige stats --states # 认知状态分解
vestige health # 系统健康检查
vestige consolidate # 运行记忆维护
vestige restore <file> # 从备份恢复
vestige dashboard # 在浏览器中打开 3D 仪表盘
🛠 故障排除
安装后出现 "Command not found" 错误
确保 vestige-mcp 在你的 PATH 中:
which vestige-mcp
# 或者使用完整路径:
claude mcp add vestige /usr/local/bin/vestige-mcp -s user
嵌入模型下载失败
首次运行时会从 Hugging Face 下载 ~130MB 的文件。如果使用代理:
export HTTPS_PROXY=your-proxy:port
缓存路径:macOS ~/Library/Caches/com.vestige.core/fastembed | Linux ~/.cache/vestige/fastembed
仪表盘无法加载
MCP 服务器运行时,仪表盘会自动在端口 3927 启动。检查:
curl http://localhost:3927/api/health
# 应返回 {"status":"healthy",...}
Scan to join WeChat group