code2prompt

<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/CLI.png" alt="code2prompt"></a> </h1>

<hr />

<hr />

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

快速安装 ⚡

使用 cargo 的 CLI 🦀

cargo install code2prompt

使用 pip 的 SDK 🐍

pip install code2prompt-rs

它有什么用？

核心

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

CLI

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

SDK

code2prompt 软件开发工具包 (SDK) 提供核心库的 python 绑定。这非常适合希望与代码库无缝交互的 AI 代理或自动化脚本。该 SDK 托管在 Pypi 上，可以通过 pip 安装。

MCP

code2prompt 也可用作模型上下文协议 (MCP) 服务器，允许您将其作为本地服务运行。这通过为 LLM 提供自动收集代码库的结构化上下文的工具，从而增强了 LLM 的能力。

文档 📚

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

特性

Code2Prompt 将您的整个代码库转换为大型语言模型的结构化提示。主要功能包括：

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

停止手动复制文件和格式化 LLM 代码。Code2Prompt 处理繁琐的工作，因此您可以专注于从 AI 模型中获得见解和解决方案。

其他安装方式

有关详细的安装说明，请参阅文档。

二进制版本

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

源码构建

需要：

• Git、Rust 和 Cargo。

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

Star 历史

许可证

在 MIT 许可证下获得许可，有关更多信息，请参阅 <a href="https://github.com/mufeedvh/code2prompt/blob/master/LICENSE">LICENSE</a>。

喜欢这个项目吗？

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

贡献

贡献方式：

• 建议一个功能
• 报告一个错误
• 修复一些东西并打开一个 pull request
• 帮助我记录代码
• 传播这个消息