code2prompt

code2prompt

将代码库转换为LLM提示的命令行工具,支持模板自定义和令牌计数

code2prompt是一个命令行工具,可以快速将代码库转换为LLM提示。它支持通过Handlebars模板自定义提示,显示令牌数量,并可排除指定文件或文件夹。该工具自动整合和格式化多个源代码文件,简化了创建适用于代码分析和生成任务的LLM提示的过程。

code2prompt命令行工具生成LLM提示代码库模板自定义Github开源项目

code2prompt 项目介绍

code2prompt 是一个强大的命令行工具,专门用于将代码库转换成单个大语言模型(LLM)提示。这个工具的主要目标是简化开发者与 AI 模型交互的过程,特别是在处理大型代码库时。

主要特性

该工具具有以下突出特性:

  1. 快速生成:能够从任何规模的代码库快速生成 LLM 提示。
  2. 模板定制:使用 Handlebars 模板来自定义提示生成过程。
  3. 版本控制兼容:尊重 .gitignore 文件的设置。
  4. 文件过滤:通过 glob 模式过滤和排除文件。
  5. 令牌计数:显示生成提示的令牌数量。
  6. Git 集成:可选择包含 Git 差异输出(已暂存文件)在生成的提示中。
  7. 自动复制:自动将生成的提示复制到剪贴板。
  8. 输出保存:可以将生成的提示保存到输出文件。
  9. 文件排除:按名称或路径排除文件和文件夹。
  10. 代码行号:为源代码块添加行号。

工作原理

code2prompt 遍历整个代码库,生成一个格式良好的 Markdown 提示,详细说明源代码树结构和所有代码。用户可以将这个文档上传到具有更大上下文窗口的 GPT 或 Claude 模型,然后要求模型执行各种任务,如重写代码、查找 bug、编写文档或实现新功能。

使用场景

这个工具在多种场景下都能发挥作用:

  1. 代码文档生成:自动为代码库生成全面的文档。
  2. 安全审计:查找潜在的安全漏洞。
  3. 代码优化:清理和改进代码质量。
  4. Bug 修复:诊断问题并提供修复建议。
  5. 性能提升:寻找优化机会并提供具体建议。
  6. GitHub 集成:生成高质量的 README 文件或 Pull Request 描述。
  7. Git 提交:根据暂存文件生成有意义的提交信息。

安装与使用

用户可以通过多种方式安装 code2prompt,包括下载二进制文件、从源代码构建、使用 cargo 安装或通过包管理器如 AUR 和 Nix 安装。

使用时,只需在命令行中指定代码库路径即可生成提示:

code2prompt path/to/codebase

用户还可以使用各种选项来自定义输出,如使用自定义模板、过滤文件、显示令牌计数等。

模板系统

code2prompt 提供了一套内置模板,用于常见用例,如文档生成、安全漏洞检测、代码清理等。用户还可以创建自定义模板,进一步扩展工具的功能。

结语

code2prompt 是一个非常实用的工具,它简化了开发者与 AI 模型的交互过程,特别是在处理大型代码库时。无论是进行代码审查、重构还是文档生成,code2prompt 都能提供有力的支持,提高开发效率。

编辑推荐精选

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

下拉加载更多