AlmanacCode/codealmanac
A codebase wiki for AI coding agents. Captures what the code can't say: decisions, flows, invariants, gotchas.
它解決的問題
CodeAlmanac 解決了軟體開發中的「背景差距」問題，即僅靠程式碼本身無法解釋架構決策背後的原因、歷史上的失敗、系統不變量，或複雜的跨服務工作流程。它提供了一種方式來維護一個「活的維基」，以捕捉這些高階背景資訊，這些資訊通常會在提交訊息中遺失，或分散在各處的文件中。
如何運作
該工具會在倉儲的 almanac/ 目錄下建立一個由純 Markdown 檔案組成的維基。它利用 AI 程式碼代理（透過 Codex 或 Claude Code）透過三個主要流程自動維護此維基：
- 匯入：AI 代理掃描檔案、Git 差異、PR、問題和代理對話記錄，將新知識納入維基。
- 修整：定期由 AI 驅動的審查，清理過時的頁面、修復損壞的連結，並移除重複資訊。
- 同步：背景程序掃描近期的 AI 代理對話，提取並排隊有用的知識以更新維基。
使用者可透過 CLI 搜尋和檢視頁面，或透過本地網頁檢視器與維基互動。
適用對象
希望維護由 AI 代理自動更新，並透過標準 Git 工作流程審查的最新專案文件的開發者與團隊。
特色
- 原生 Git：維基以 Markdown 格式儲存在倉儲中，因此變更會透過拉取請求進行審查。
- 自動維護：在 macOS 上使用背景
launchd作業來同步與「修整」維基，無需手動操作。 - 與代理整合：直接整合 Codex 和 Claude Code，將對話記錄轉換為持久的文件。
- 本地優先：所有維基工作與索引都在使用者的機器上本地進行。
- 網頁檢視器：內建只讀的本地網頁介面，用於瀏覽維基圖。
相關
- 專案
- Dispatch
- 專案
- 專案
- 專案