code2prompt

🚀 代码2提示工具（Code2Prompt）

Code2Prompt 是一款强大的代码转换工具，能将代码库转换为适合大型语言模型（LLM）的提示，极大简化代码分析、生成等任务。它支持多种安装方式，核心库可集成到其他应用，CLI、SDK和MCP服务也为不同场景提供了便利。

🚀 快速开始

想要与我们互动吗？加入我们的Discord频道！

• 获取新功能的更新 📢
• 提供你的见解和建议 💬
• 获得帮助配置和使用 🛠️
• 报告Bug 🐛

📦 安装指南

命令行工具安装

# Cargo
$ cargo install code2prompt

# Homebrew
$ brew install code2prompt

SDK安装

SDK通过pip安装 🐍

pip install code2prompt-rs

✨ 主要特性

Code2Prompt 将整个代码库转换为适合大型语言模型阅读和理解的有条理提示。关键功能包括：

• 自动代码处理：将任何大小的代码库转换为可读格式
• 智能过滤：使用glob模式包含/排除文件并尊重.gitignore规则
• 灵活模板：使用Handlebars模板根据不同的用例自定义提示
• 上下文提供：在生成的提示中添加上下文信息
• 语言支持：支持多种编程语言

📚 详细文档

查看我们的在线文档获取详细说明。

📄 许可证

根据 MIT License，查看 LICENSE 以获取更多信息。

喜欢这个项目？

如果你喜欢这个项目并发现它很有用，请给它一个 :star: !

贡献

贡献方式：

• 提议一个功能
• 报告一个bug
• 修复一些内容并提交Pull Request
• 帮助我文档化代码
• 传播消息