代码转提示

<div align="center"> <a href="https://code2prompt.dev"> <img align="center" width="550px" src=".assets/logo_dark_v0.0.2.svg" alt="Code2prompt"/> </a> <p align="center"> <b>将你的代码库转换成一个单一的LLM提示！</b> </p> </div> <h1 align="center"> <a href="https://code2prompt.dev"><img src=".assets/demo.gif" alt="code2prompt"></a> </h1> <hr />

<hr /> <p align="center"> 想要与我们互动吗？加入我们的<a href="https://discord.com/invite/ZZyBbsHTwH">Discord</a>频道！<br> <i>获取新功能更新</i> 📢<br> <i>提供您的见解和建议</i> 💬<br> <i>获得配置和使用帮助</i> 🛠️<br> <i>报告Bug</i> 🐛<br> </p>

快速安装 ⚡

Cargo

cargo install code2prompt 

为了启用可选的Wayland支持（例如，在基于Wayland的系统上集成剪贴板），使用wayland特性标志：

cargo install --features wayland code2prompt

Homebrew

brew install code2prompt

SDK与pip 🐍

pip install code2prompt-rs

它有什么用？

核心

code2prompt是一个代码摄入工具，它简化了创建用于代码分析、生成和其他任务的LLM提示的过程。它通过遍历目录、构建树结构并收集每个文件的信息来工作。核心库可以轻松地集成到其他应用程序中。

命令行界面 (CLI)

code2prompt命令行界面 (CLI) 是为人类设计的，可以直接从你的代码库生成提示。生成的提示会自动复制到你的剪贴板，并且也可以保存到输出文件中。此外，你可以使用Handlebars模板自定义提示生成。查看提供的示例提示！

软件开发套件 (SDK)

code2prompt软件开发套件 (SDK) 提供了Python绑定到核心库。这对于希望无缝交互代码库的AI代理或自动化脚本来说是完美的。SDK托管在Pypi上，可以通过pip安装。

MCP

code2prompt也作为模型上下文协议 (MCP) 服务器可用，这允许你将其作为一个本地服务运行。这通过提供一种工具来自动收集代码库的良好结构化上下文，使LLMs更加强大。

文档 📚

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

特性

Code2Prompt将整个代码库转换成大型语言模型的良好结构化的提示。关键特性包括：

• 自动代码处理：将任何大小的代码库转换成可读的、格式化的提示
• 智能过滤：使用glob模式包含/排除文件，并遵守.gitignore规则
• 灵活的模板：使用Handlebars模板自定义不同用途的提示
• 令牌跟踪：跟踪令牌使用情况，以保持在LLM上下文限制内
• Git集成：在提示中包含差异、日志和分支比较
• 开发者体验：自动剪贴板复制、行号和文件组织选项

停止手动复制文件和格式化代码给LLMs。Code2Prompt处理繁琐的工作，让你专注于从AI模型中获取洞察和解决方案。

替代安装

参考文档获取详细的安装说明。

二进制发布

从发布页面下载适用于您操作系统的最新二进制文件。

源码编译

需要：

• Git，Rust 和 Cargo。

git clone https://github.com/mufeedvh/code2prompt.git
cd code2prompt/
cargo install --path crates/code2prompt

星标历史

许可证

根据MIT许可证授权，详情见<a href="https://github.com/mufeedvh/code2prompt/blob/master/LICENSE">LICENSE</a>。

喜欢这个项目吗？

如果你喜欢这个项目并且觉得它有用，请给它一个 :star:！

贡献

贡献方式：

• 建议一个功能
• 报告一个bug
• 修复一些东西并打开一个拉取请求
• 帮助我记录代码
• 传播消息