AlmanacCode/codealmanac

A codebase wiki for AI coding agents. Captures what the code can't say: decisions, flows, invariants, gotchas.

它解决了什么问题

CodeAlmanac 解决了软件开发中的「上下文鸿沟」问题,即仅靠代码本身无法解释架构决策背后的理由、历史失败、系统不变量或复杂的跨服务工作流。它提供了一种维护「动态维基」的方法,以捕捉这些高层次的上下文信息,而这些信息通常在提交消息中丢失,或分散在各种文档中。

它如何工作

该工具创建了一个由纯 Markdown 文件组成的维基,这些文件直接存储在仓库的 almanac/ 目录下。它利用 AI 编码代理(通过 Codex 或 Claude Code)通过三种主要流程自动维护此维基:

  • 摄入:AI 代理扫描文件、Git 差异、PR、问题和代理对话记录,将新知识整合到维基中。
  • 园艺:定期由 AI 驱动的审查,清理过时页面、修复损坏链接并删除重复信息。
  • 同步:后台进程扫描最近的 AI 代理对话,提取并排队有用的知识以更新维基。

用户可以通过 CLI 搜索和查看页面,或通过本地网页查看器与维基交互。

适合谁

希望维护由 AI 代理自动更新并经由标准 Git 工作流审查的最新项目文档的开发者和团队。

特色

  • 原生 Git:维基以 Markdown 形式存储在仓库中,因此更改通过拉取请求进行审查。
  • 自动化维护:在 macOS 上使用后台 launchd 任务自动同步和「园艺」维基,无需手动操作。
  • 代理集成:直接集成 Codex 和 Claude Code,将对话记录转化为持久化文档。
  • 本地优先:所有维基操作和索引都在用户的本地机器上完成。
  • 网页查看器:包含一个只读的本地网页界面,用于浏览维基图谱。

相关

  • 项目
  • Dispatch
  • 项目
  • 项目
  • 项目