码转提示

快速安装 ⚡

通过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 还可用作Model Context Protocol (MCP)服务器，允许你将其作为本地服务运行。这通过提供一个工具来自动收集代码库的良好结构化上下文，从而增强了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

星标历史

许可证

本项目根据 MIT 许可证许可，详见 LICENSE 获取更多信息。

喜欢这个项目？

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

贡献

贡献方式包括：

• 提议一个功能
• 报告一个 bug
• 修复某些问题并发起拉取请求
• 帮助我编写文档
• 宣传这个项目