面向 AI 编码代理的分层记忆系统与文档治理框架,提供标准化文档模板、Git 过期检测和 Guardian 语义验证,确保项目知识的一致性与新鲜度。
项目概述#
Cortex TMS(Tiered Memory System)是专为 AI 编码代理设计的文档治理框架。它通过三大支柱解决 AI 辅助开发中的核心痛点:
- 📋 一致性:生成 AI 代理可读的治理文档模板,包括
PATTERNS.md(代码模式)、CLAUDE.md(代理工作流规则)、ARCHITECTURE.md(系统设计)、DOMAIN-LOGIC.md(业务规则) - 🔍 新鲜度检测:基于 Git 的文档过期检测,比较文档修改日期 vs 代码提交活动,可配置阈值(天数 + 提交次数)
- 🛡️ 安全监督:
CLAUDE.md治理规则要求关键操作需人工审批,Git 提交/推送需审批
核心能力#
CLI 命令#
| 命令 | 功能 |
|---|---|
cortex-tms init | 交互式脚手架初始化文档结构 |
cortex-tms validate | 验证项目 TMS 健康状态(含过期检测) |
cortex-tms status | 文本摘要:项目健康 + Sprint 进度 |
cortex-tms dashboard | 全屏交互式终端 UI(v4.0 新增) |
cortex-tms review | Guardian: AI 驱动的语义验证 |
cortex-tms hooks | 管理 Git 钩子(pre-commit 验证) |
Guardian 语义验证#
- 基于 Zod 的语义验证
- Safe Mode:只读分析,≥80% 置信度
- 捕获 grep 无法检测的模式漂移
- 使用用户自己的 OpenAI/Anthropic API Key
分层文档体系#
| 层级 | 文件 | 用途 |
|---|---|---|
| HOT | NEXT-TASKS.md | 活动 Sprint 和当前焦点 |
| HOT | CLAUDE.md | CLI 命令 & 工作流配置 |
| WARM | docs/core/ARCHITECTURE.md | 系统设计 & 技术栈 |
| WARM | docs/core/PATTERNS.md | 规范代码示例 |
| COLD | docs/archive/ | 历史变更日志 |
快速开始#
# 初始化治理文档
npx cortex-tms@latest init
# 验证文档健康
npx cortex-tms@latest validate
# 严格模式(CI 用)
npx cortex-tms@latest validate --strict
配置示例#
{
"version": "4.0.0",
"staleness": {
"enabled": true,
"thresholdDays": 30,
"minCommits": 3,
"docs": {
"docs/core/PATTERNS.md": ["src/"]
}
}
}
适用场景#
- ✅ 多文件复杂项目
- ✅ 团队协作项目
- ✅ 长期维护项目
- ✅ AI 密集工作流(Claude Code / Cursor / Copilot)
系统要求#
- Node.js ≥ 18.0.0
- Git(用于过期检测)