Convert your codebase into a single LLM prompt.
Website •
Documentation •
Discord
代码2提示 是一个强大的上下文工程工具，旨在摄取代码库并将其格式化为大型语言模型。无论您是手动复制ChatGPT的上下文，通过Python构建AI代理，还是运行MCP服务器，Code2Prompt都能简化上下文准备过程。
⚡ 快速安装
货物```bash
cargo install code2prompt
要启用可选的Wayland支持（例如，用于基于Wayland的系统上的剪贴板集成），请使用 `wayland` 特征标志：```bash
cargo install --features wayland code2prompt
家酿```bash
brew install code2prompt
### 带pip的SDK🐍```bash
pip install code2prompt-rs
🚀 快速开始
安装后，从代码库生成提示就像将工具指向您的目录一样简单。
基本用法：从当前目录生成提示并将其复制到剪贴板。```sh
code2prompt .
**保存到文件**:```sh
code2prompt path/to/project --output-file prompt.txt
🌐 生态系统
Code2Prompt不仅仅是一个CLI工具。它是一个完整的代码库上下文生态系统。
| 🧱 核心库
| 💻 CLI工具
| 🐍 开发包
🤖 MCP 服务器
负责安全文件遍历的内部高速库，尊重 .gitignore 规则和结构化Git元数据。 · 专为人类设计，具有最小的CLI和交互式TUI。生成格式化的提示，跟踪令牌使用情况，并将结果输出到剪贴板或stdout。 · 提供到Rust Core的快速Python绑定。非常适合AI代理、自动化脚本或深度集成到RAG管道中。在PyPI上可用。 · 将Code2Prompt作为本地服务运行，使代理应用程序能够高效地读取本地代码库，而不会使上下文窗口膨胀。
📚 文档
查看我们的在线 文档 详细说明
✨ 特性
Code2Prompt将您的整个代码库转换为用于大型语言模型的结构良好的提示。主要特征包括：
- 终端用户界面（TUI）：用于配置和生成提示的交互式终端界面
- 智能过滤：使用glob模式和尊重来包含/排除文件
.gitignore规则 - 灵活的模板：使用Handlebars模板为不同用例自定义提示
- 自动代码处理：将任何大小的代码库转换为可读、格式化的提示
- 令牌跟踪：跟踪令牌使用情况以保持在LLM上下文限制范围内
- 智能文件读取：简化读取LLM的各种文件格式（CSV、笔记本、JSONL等）
- Git集成：在提示中包含差异、日志和分支比较
- 快速燃烧：内置Rust以实现高性能和低资源使用
停止手动复制LLM的文件和格式化代码。Code2Prompt处理繁琐的工作，因此您可以专注于从AI模型中获得见解和解决方案。
替代安装
请参阅 文档 了解详细的安装说明。
二进制版本
从下载适用于您操作系统的最新二进制文件 发布.
源代码构建
要求：
- Git, 锈 和
Cargo.sh git clone https://github.com/mufeedvh/code2prompt.git cd code2prompt/ cargo install --path crates/code2prompt
⭐ 凝视星空
📜 许可证
根据MIT许可证获得许可，请参阅 许可证 了解更多信息。
喜欢这个项目吗？
如果你喜欢这个项目，觉得它很有用，请给它一个：星：！
👥 贡献
贡献方式：
- 建议一个功能
- 报告错误
- 修复一些问题并打开pull请求
- 帮我记录代码
- 广而告之
