AI coding memory generator

把代码库变成 AI 可读的 Skill 记忆

coding-memory 扫描项目文件,抽取确定性 Evidence,再让大模型提炼架构约定、设计决策、实现模式和反模式,生成可被 AI 编码助手直接加载的 SKILL.md

npm install -g coding-memory

# configure your LLM
coding-memory config

# verify connection
coding-memory test

# learn this repository
coding-memory learn -p .

它记住的不是代码文本,而是项目里的判断方式

让 AI 编码助手进入项目时,不再从零猜测目录、命名、状态管理、错误处理和工程化约定。

认知模式

提炼模块边界、组合方式、类型习惯和跨层协作方式,形成可复用的项目记忆。

确定性证据

先用本地规则抽取 Evidence,再把证据作为事实地板注入 LLM,减少无依据推断。

可审计产物

同时输出 SKILL.md、分层 reference、EVIDENCE 和质量报告,方便人和 AI 一起检查。

实现原理

一条“扫描代码库 → 抽取证据 → LLM 提炼 → 本地治理 → 质量报告”的流水线。

扫描项目

按配置读取源文件,识别语言、项目类型、关键目录和可学习的代码样本。

抽取 Evidence

用可测试规则覆盖 Vue2/Vue3、React/Next、Node/NestJS、Java/Spring、Python、Go、Rust、.NET、PHP、Ruby、CI、容器和环境配置。

逐层生成

SYNTHESIZE 阶段按 L1-L8 逐层生成,每层注入相关样本和前序层摘要,降低长输出截断风险。

治理产物

拆分层级、过滤推测性内容、降级不安全模板,把待验证内容归入 Gaps。

生成报告

输出顶层 Skill、Evidence 明细和质量报告,让 AI 能读,也让维护者能审计。

生成产物

顶层文件给 AI 快速加载,reference 文件保留细节证据。

~/.coding-memory/<skillName>/
├── SKILL.md
├── QUALITY.md
└── reference/
    └── <projectType>/
        ├── OVERVIEW.md
        ├── EVIDENCE.md
        ├── EVIDENCE.json
        ├── MANIFEST.json
        ├── TRACE.json
        ├── VERIFY.json
        ├── RUNS.md
        ├── L1-项目骨架.md
        ├── L2-模块与接口.md
        ├── L3-命名与类型.md
        ├── L4-实现模式.md
        ├── L5-数据与状态.md
        ├── L6-质量保障.md
        ├── L7-横切关注点.md
        └── L8-工程化与启动.md

给 AI 的入口

SKILL.md 是压缩后的调用入口,包含 Hard Rules、Type Rules、模板索引、反模式和场景指南。

给人的审计面

QUALITY.mdEVIDENCE.md/jsonTRACE.jsonRUNS.md 记录证据覆盖、低置信度项、待验证 Gaps、规则追踪和每轮 LLM 调用统计。

模型配置保持开放

内置常用模型服务预设,也支持代理网关、私有服务和第三方兼容接口。高级参数会原样传递给模型。

  • 官方直连
  • 中国主流
  • 聚合与高速推理
  • 本地/自托管
  • 自定义连接

默认列表优先提供配置项较少、拿到 API key 后就容易跑通的服务。企业云、私有部署和网关服务通常有自己的地址、模型名和账号规则,可以通过自定义连接填写;豆包这类需要控制台模型或 endpoint ID 的服务,也会在配置时提示手动填写。

准备给你的项目建立记忆

安装 CLI,配置模型,然后在代码库中运行 coding-memory learn -p .。 实现原理细节见 docs/dev/IMPLEMENTATION.md