ai digest

愛文摘

一個 CLI 工具，可將您的程式碼庫聚合到單一 Markdown 文件中，以便與 Claude 專案或自訂 ChatGPT 一起使用。

特徵

• 聚合指定目錄及子目錄中的所有文件

• 忽略常見的建置工件和配置文件

• 輸出包含整個程式碼庫的單一 Markdown 文件

• 提供空白刪除和自訂忽略模式的選項

如何使用

首先在專案目錄中執行 CLI 工具：

 npx ai文摘

這將使用您的程式碼庫產生一個codebase.md檔案。

產生包含程式碼庫的 Markdown 檔案後，您可以將其與 ChatGPT 和 Claude 等 AI 模型一起使用，以進行程式碼分析和協助。

使用 ChatGPT：

1. 建立自訂 GPT

2. 將產生的Markdown檔案上傳到GPT的知識庫

與克勞德：

1. 建立一個新項目

2. 將 Markdown 檔案加入專案的知識中

為了獲得最佳結果，請在開始新的聊天會話之前重新上傳 Markdown 文件，以確保 AI 擁有最新版本的程式碼庫。

選項

• -i, --input : 指定輸入目錄（預設：目前目錄）

• -o, --output ：指定輸出檔（預設：codebase.md）

• --no-default-ignores ：停用預設忽略模式

• --whitespace-removal : 啟用空白刪除

• --show-output-files ：顯示輸出中包含的檔案列表

• --ignore-file ：指定自訂忽略檔案（預設值：.aidigestignore）

• --help : 顯示幫助

範例

1. 基本用法：

    npx ai文摘

2. 指定輸入和輸出：

    npx ai-digest -i /path/to/your/project -o project_summary.md

3. 啟用空白刪除：

    npx ai-digest --空白刪除

4. 顯示包含文件的清單：

    npx ai-digest --顯示輸出文件

5. 組合多個選項：

    npx ai-digest -i /path/to/your/project -o project_summary.md --whitespace-removal --show-output-files

自訂忽略模式

ai-digest 使用專案根目錄中的.aidigestignore檔案支援自訂忽略模式。該檔案的工作方式與.gitignore類似，可讓您指定應從聚合中排除的檔案和目錄。

使用--show-output-files標誌查看包含哪些文件，從而更容易識別要排除的候選文件。

空白刪除

當使用--whitespace-removal標誌時，ai-digest 會從檔案中刪除多餘的空格，以減少與 AI 模型一起使用時的標記計數。對於 Python 和 YAML 等依賴空格的語言，此功能會停用。

二進制和 SVG 檔案處理

輸出中包含二進位檔案和 SVG，並附有有關其檔案類型的註解。這使得人工智慧模型能夠了解這些文件，而無需包含其完整內容。

本地發展

運行npm run start在本地專案上運行 CLI 工具。 （非常元！）

運行npm test來運行測試。

若要將標誌傳遞給 CLI，請使用--標誌，如下所示： npm run start -- --whitespace-removal 。

部署新版本

npm publish

貢獻

歡迎貢獻！請隨時提交 Pull 請求。

執照

該項目已獲得 MIT 許可證的許可。