thedotmack/learn-codebase

learn-codebase 是做什麼的？

透過完整讀取每個原始碼檔案來初始化程式碼庫。適合在開始處理新專案或不熟悉的專案時使用，或當使用者要求「學習程式碼庫」、「讀取程式碼庫」、「初始化」或「跟上進度」時。

使用方法

當您需要快速了解一個專案時，只需告訴 AI 代理：

• 「學習這個程式碼庫」
• 「讀取程式碼庫」
• 「初始化」
• 「讓我跟上進度」

AI 代理將會掃描專案目錄，忽略常見的建置產物和第三方相依項目（依據 .gitignore 規則），並依序讀取每個原始碼檔案的完整內容。

支援的平台

• Claude Code
• Cursor
• Codex
• 其他相容的 AI 代理工具

運作方式

1. 掃描專案根目錄以取得所有檔案和資料夾。
2. 根據 .gitignore、node_modules、vendor 等常見排除規則過濾不必要的檔案。
3. 依序讀取每個相關的原始碼檔案，並將其內容提供給 AI 代理。
4. AI 代理便能理解程式碼庫的整體結構、實作細節和相依關係。

注意事項

• 對於大型專案，可能需要幾秒鐘才能完成初始化。
• 只會讀取純文字檔案；二進位檔案（如圖片、壓縮檔）會被跳過。
• 如果專案中包含敏感資訊（如 API 金鑰），請確保這些資訊已透過 .gitignore 排除。