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 许可证的许可。