mufeedvh/code2prompt · 文件 下载 ZIP
文件最后提交记录最后更新时间
README.md
以下内容由 AI 翻译，如有问题请点此提交 issue 反馈
将您的代码库转换为单个 LLM 提示。
Code2Prompt 是一款强大的上下文工程工具，旨在摄取代码库并将其格式化为大语言模型（LLM）所需的格式。无论您是手动为 ChatGPT 复制上下文、通过 Python 构建 AI 智能体，还是运行 MCP 服务器，Code2Prompt 都能简化上下文准备流程。
⚡ 快速安装
Cargo
cargo install code2prompt 要启用可选的 Wayland 支持（例如，在基于 Wayland 的系统上实现剪贴板集成），请使用 wayland 特性标志：
cargo install --features wayland code2promptHomebrew
brew install code2prompt使用 pip 的 SDK 🐍
pip install code2prompt-rs🚀 快速开始
安装完成后，从代码库生成提示词只需将工具指向你的目录即可。
基本用法：从当前目录生成提示词并将其复制到剪贴板。
code2prompt .保存到文件：
code2prompt path/to/project --output-file prompt.txt🌐 生态系统
Code2Prompt 不仅仅是一个 CLI 工具。它是一个完整的代码库上下文生态系统。
🧱 核心库  | 💻 CLI 工具  | 🐍 Python SDK  | 🤖 MCP 服务器  |
|---|---|---|---|
负责安全文件遍历、遵守 .gitignore 规则并结构化 Git 元数据的内部高速库。 | 专为人类设计，兼具极简 CLI 和交互式 TUI。生成格式化提示词，跟踪 token 使用情况，并将结果输出到剪贴板或 stdout。 | 提供 Rust 核心的快速 Python 绑定。适用于 AI 智能体、自动化脚本或深度集成到 RAG 流水线中。可在 PyPI 上获取。 | 将 Code2Prompt 作为本地服务运行，使智能体应用能够高效读取本地代码库，而不会使上下文窗口膨胀。 |
📚 文档
查看我们的在线 文档 以获取详细说明
✨ 功能
Code2Prompt 将整个代码库转换为面向大型语言模型的结构化提示词。主要功能包括：
- 终端用户界面 (TUI): 用于配置和生成提示词的交互式终端界面
- 智能过滤: 使用 glob 模式包含/排除文件，并遵守
.gitignore规则 - 灵活模板: 使用 Handlebars 模板为不同用例定制提示词
- 自动代码处理: 将任意规模的代码库转换为可读、格式化的提示词
- Token 跟踪: 跟踪 token 使用情况以保持在 LLM 上下文限制内
- 智能文件读取: 简化 LLM 读取各种文件格式（CSV、Notebooks、JSONL 等）
- Git 集成: 在提示词中包含差异、日志和分支比较
- 极速性能: 使用 Rust 构建，具有高性能和低资源占用
停止手动复制文件和为 LLM 格式化代码。Code2Prompt 处理繁琐的工作，让你专注于从 AI 模型中获取洞察和解决方案。
替代安装方式
请参阅 文档 获取详细的安装说明。
二进制发布
从 Releases 下载适用于你操作系统的最新二进制文件。
源码构建
需要：
git clone https://github.com/mufeedvh/code2prompt.git
cd code2prompt/
cargo install --path crates/code2prompt⭐ 观星
📜 许可证
本项目采用 MIT 许可证，详见 LICENSE 以获取更多信息。
喜欢这个项目？
如果你喜欢这个项目并觉得它有用，请给它一个 :star: ！
👥 贡献
贡献方式：
- 建议一个功能
- 报告一个 bug
- 修复问题并发起一个 pull request
- 帮助我编写代码文档
- 传播消息