code2prompt

code2prompt

用于将代码库转换为AI友好提示的开源的命令行工具

Code2Prompt是一个开源的命令行工具,用于将代码库转换为AI友好提示,以便LLMs进行代码分析、文档生成和优化。支持生成结构化Markdown、智能令牌管理、自定义Jinja2模板和与Gitignore集成。它还提供灵活的文件处理和多种输出选项,帮助开发人员更有效地进行代码分析和文档生成。

Code2Prompt命令行工具代码分析AI提示开源Github开源项目

项目介绍:Code2Prompt

Code2Prompt 是一个强大的命令行工具,旨在将代码库转化为适合人工智能模型(特别是大型语言模型,如LLMs)的全面提示。其主要功能包括代码分析、文档生成和代码改进,为开发者与AI的互动提供了便利。

为什么选择 Code2Prompt?

Code2Prompt 的诞生是为了让开发者更加轻松地与大型语言模型进行互动。通过生成全面、结构化的提示,Code2Prompt 提供了项目上下文的完整视图,帮助AI提供更准确的建议和分析。这使得代码风格和惯例的维护变得更加简单,提升代码质量,并且能够支持更高效的重构和改进。

主要功能

  • 整体代码库表示:通过生成结构化的Markdown提示,帮助AI更好地理解项目上下文。
  • 智能源码树生成:创建代码库结构的层次视图,帮助用户更好地导航和理解项目。
  • 可定制的提示模板:利用Jinja2模板,根据具体AI任务进行输出定制。
  • 智能标记管理:优化标记以确保与各种LLM标记限制的兼容性。
  • Gitignore 集成:遵循项目的 .gitignore 规则,确保不相关文件被排除。
  • 灵活的文件处理:通过过滤和排除模式,用户可以控制包含哪些文件。
  • 自定义语法高亮:通过 --syntax-map 选项指定文件扩展名与语法高亮之间的映射。
  • 快捷剪贴板功能:快速复制生成的提示到剪贴板,优化工作流程。
  • 多种输出选项:提供控制台显示或保存为文件的灵活输出方式。
  • 代码可读性增强:为源代码块添加行号,便于特定部分讨论。
  • 文件包含支持:支持模板导入,实现模块化设计。
  • 输入变量支持:模板中支持输入变量,基于用户输入生成动态提示。

安装方法

用户可以通过下面的方法安装 Code2Prompt:

使用 pip

pip install code2prompt

使用 pipx (推荐)

pipx install code2prompt

快速开始

  1. 生成Python文件的提示:

    code2prompt --path /path/to/your/script.py
  2. 处理整个项目目录并保存输出:

    code2prompt --path /path/to/your/project --output project_summary.md
  3. 为多个文件生成提示并排除测试文件:

    code2prompt --path /path/to/src --path /path/to/lib --exclude "*/tests/*" --output codebase_summary.md

案例示例

  1. 为Python库生成文档:

    code2prompt --path /path/to/library --output library_docs.md --suppress-comments --line-number --filter "*.py"
  2. 为代码审查准备代码库摘要,专注于JavaScript和TypeScript文件:

    code2prompt --path /path/to/project --filter "*.js,*.ts" --exclude "node_modules/*,dist/*" --template code_review.j2 --output code_review.md

基于Token的价格估算

Code2Prompt 提供了强大的token价格估算功能,支持多种AI提供商和模型。使用 --price 选项与 --tokens,可以展示全面的成本估算,使开发人员能够了解AI模型使用的潜在开销。比如:

code2prompt --path /your/project --tokens --price --provider openai --model gpt-4

项目集成

Code2Prompt 可与多种工具和服务集成,包括GitHub Actions、Simon Willison的 llm CLI工具等,使其在开发流程中更为高效。

贡献和许可证

Code2Prompt 开放源代码,遵循 MIT 许可证进行发布。欢迎任何对该项目感兴趣的人进行贡献,具体细节请查看我们的贡献指南

欢迎加入 Code2Prompt 的大家庭,与我们一起体验AI辅助开发的强大功能。

编辑推荐精选

Vora

Vora

免费创建高清无水印Sora视频

Vora是一个免费创建高清无水印Sora视频的AI工具

Refly.AI

Refly.AI

最适合小白的AI自动化工作流平台

无需编码,轻松生成可复用、可变现的AI自动化工作流

酷表ChatExcel

酷表ChatExcel

大模型驱动的Excel数据处理工具

基于大模型交互的表格处理系统,允许用户通过对话方式完成数据整理和可视化分析。系统采用机器学习算法解析用户指令,自动执行排序、公式计算和数据透视等操作,支持多种文件格式导入导出。数据处理响应速度保持在0.8秒以内,支持超过100万行数据的即时分析。

AI工具酷表ChatExcelAI智能客服AI营销产品使用教程
TRAE编程

TRAE编程

AI辅助编程,代码自动修复

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

AI工具TraeAI IDE协作生产力转型热门
AIWritePaper论文写作

AIWritePaper论文写作

AI论文写作指导平台

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

AI辅助写作AI工具AI论文工具论文写作智能生成大纲数据安全AI助手热门
博思AIPPT

博思AIPPT

AI一键生成PPT,就用博思AIPPT!

博思AIPPT,新一代的AI生成PPT平台,支持智能生成PPT、AI美化PPT、文本&链接生成PPT、导入Word/PDF/Markdown文档生成PPT等,内置海量精美PPT模板,涵盖商务、教育、科技等不同风格,同时针对每个页面提供多种版式,一键自适应切换,完美适配各种办公场景。

AI办公办公工具AI工具博思AIPPTAI生成PPT智能排版海量精品模板AI创作热门
潮际好麦

潮际好麦

AI赋能电商视觉革命,一站式智能商拍平台

潮际好麦深耕服装行业,是国内AI试衣效果最好的软件。使用先进AIGC能力为电商卖家批量提供优质的、低成本的商拍图。合作品牌有Shein、Lazada、安踏、百丽等65个国内外头部品牌,以及国内10万+淘宝、天猫、京东等主流平台的品牌商家,为卖家节省将近85%的出图成本,提升约3倍出图效率,让品牌能够快速上架。

iTerms

iTerms

企业专属的AI法律顾问

iTerms是法大大集团旗下法律子品牌,基于最先进的大语言模型(LLM)、专业的法律知识库和强大的智能体架构,帮助企业扫清合规障碍,筑牢风控防线,成为您企业专属的AI法律顾问。

SimilarWeb流量提升

SimilarWeb流量提升

稳定高效的流量提升解决方案,助力品牌曝光

稳定高效的流量提升解决方案,助力品牌曝光

Sora2视频免费生成

Sora2视频免费生成

最新版Sora2模型免费使用,一键生成无水印视频

最新版Sora2模型免费使用,一键生成无水印视频

下拉加载更多