我用AI小助手自动生成代码的README文件

作为一个开发者，每当需要为项目创建吸引人且结构良好的README文件时，我总是觉得很懒。相信很多人都有同感。写一个好的README虽然令人厌烦，但却是必不可少的。我不会深入解释为什么——反正大家都明白它的重要性。

所以我做了一个叫“Readme生成器”的AI助手来处理这项繁琐的任务。这个AI助手会分析你整个代码库，深入了解每个实体（函数、文件、模块、包等等）的工作原理，并生成一个结构良好的README文件，格式为Markdown格式。

我使用Potpie创建了这个AI助手。

来看看我们的GitHub仓库并给它⭐

提示：为您的代码库创建自定义工程助手

App | 文档页面 | API 文档 | 在 🥧 仓库聊天室聊天

[ ](https://twitter.com/intent/tweet?text=我在几分钟内用 potpie.ai 为我的代码库创建了自定义工程代理！快来试试吧！@potpiedotai%F0%9F%A5%A7)

提示-代理：为您的代码创建自定义代理程序

Potpie 是一个开源平台，生成专门针对你代码库的 AI 代理，能自动进行代码分析、测试和开发任务。通过构建你代码库的全面知识图谱，Potpie 的代理可以理解复杂的代码间关系，并从调试到功能开发都能提供帮助。

• 🥧 为什么是 Potpie？
• 🤖 我们的预构建模型
• 🛠️ 工具箱
• 🚀 开始使用指南
• 💡 应用场景
• 🛠️ 自定义代理
• 🗝️ 通过 API 密钥访问
• 🎨 让 Potpie 适应你
• 🤝 贡献指南
• 📜 许可证
• 💪 感谢所有贡献者！

为什么选择锅贴派？

• 🧠 深入理解代码：内置知识图谱捕捉代码各部分之间的关系
• 🤖 预构建及自定义代理：适用于常见任务的现成的代理 + 构建您自己的代理程序
• 🔄 无缝集成：无缝集成到您的现有开发流程中
• 📈 灵活：灵活应对不同规模的代码库

查看 GitHub 上的内容

我只是给Potpie提供了一个简要的描述，说明我想要AI代理做什么任务，应该遵循的步骤，期望的结果和其他需要的细节。于是Potpie根据我的要求生成了一个定制的AI代理。

我用的提示是：

我想要一个AI代理，它能全面理解整个代码库，以MDX格式生成高质量且吸引人的README。它应该：

首先，理解项目结构

• 识别关键文件和文件夹的位置。
• 从package.json、requirements.txt、Dockerfile等文件中确定依赖和配置信息。
• 分析使用的框架和库。

分析代码的功能

• 解析源代码，理解其核心逻辑。
• 检测入口、API接口和关键函数或类。

创建一个吸引人的README

• 写一个吸引人的简介，介绍项目的目的。
• 提供清晰的安装和设置说明。
• 描述文件夹结构及其含义。
• 强调主要功能并提供使用示例。
• 包括贡献指南和许可信息。
• 使用MDX格式化所有内容，包括代码片段、注释和互动元素。

MDX 格式和样式的使用

• 使用 MDX 语法来提高可读性和交互性。
• 自动生成表格、折叠节和语法高亮代码块。

根据这个描述性的提示，Potpie 生成了关于系统输入、角色、任务描述和预期输出的提示，为我们的 README 生成器代理奠定了基础。

这个Agent的工作方式是这样的：

• 理解代码上下文 - AI代理程序首先构建一个基于Neo4j的知识图谱，将整个代码库中的关键组件表示为节点和关系。这就让代理能够捕捉到依赖关系、函数调用、数据流以及架构模式，从而实现深层次的代码上下文理解，而不仅仅是关键词匹配。

• 使用CrewAI动态生成代理 - 当用户给出提示后，AI会动态生成一个检索增强生成（RAG）代理。CrewAI用来创建这个RAG代理

• 查询处理 - RAG代理与知识图谱交互，检索相关上下文。这确保了精确且具有代码意识的响应，而不是由大语言模型生成的一般文本。

• 生成响应 - 最后，生成的响应会被存储在历史记录管理器中，以便处理未来的提示信息，然后作为最终输出显示。

这种架构确保AI代理不仅仅停留在表面分析层面，而是能深入理解代码的结构、逻辑及意图，同时在多次交互中持续更新上下文。

生成的README文件包括每个README都应有的所有关键部分。

• 标题页
• 目录
• 引言
• 主要特点
• 安装指南
• 使用指南
• API
• 环境变量
• 贡献指南
• 支持与联系方式

此外，AI足够聪明，可以根据代码库的整体结构和功能添加或删除相关部分。

有了这个AI代理，你的代码库终于有了它应有的README，你无需为此编写任何代码。

这里显示输出结果