Skip to main content
Glama

crates.io 执照 欢迎 PR 代码行数 不和谐

快速安装⚡

# Cargo $ cargo install code2prompt # Homebrew $ brew install code2prompt

带有 pip 的 SDK 🐍

pip install code2prompt-rs

Related MCP server: promptz.dev MCP Server

它有何用处?

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

命令行界面

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

SDK

code2prompt软件开发工具包 (SDK) 提供 Python 绑定到核心库的功能。这对于希望与代码库无缝交互的 AI 代理或自动化脚本来说非常理想。该 SDK 托管在 Pypi 上,可通过 pip 安装。

微胶囊钙

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

文档📚

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

特征

Code2Prompt 可将您的整个代码库转换为适用于大型语言模型的结构良好的提示。主要功能包括:

  • 自动代码处理:将任意大小的代码库转换为可读的格式化提示

  • 智能过滤:使用 glob 模式包含/排除文件并遵守.gitignore规则

  • 灵活的模板:使用 Handlebars 模板针对不同用例自定义提示

  • 令牌跟踪:跟踪令牌使用情况以保持在 LLM 上下文限制内

  • Git 集成:在提示中包含差异、日志和分支比较

  • 开发人员体验:自动剪贴板复制、行号和文件组织选项

告别手动复制文件和格式化 LLM 代码的烦恼。Code2Prompt 帮您处理这些繁琐的工作,让您专注于从 AI 模型中获取洞察和解决方案。

替代安装

请参阅文档以获取详细的安装说明。

二进制版本

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

源代码构建

要求:

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

星史

星空历史图

执照

根据 MIT 许可证授权,请参阅 LICENSE 了解更多信息。

喜欢这个项目吗?

如果您喜欢该项目并发现它有用,请给它一个:star:!

贡献

贡献方式:

  • 建议一项功能

  • 报告错误

  • 修复某些问题并打开拉取请求

  • 帮我记录代码

  • 传播信息

-
security - not tested
A
license - permissive license
-
quality - not tested

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mufeedvh/code2prompt'

If you have feedback or need assistance with the MCP directory API, please join our Discord server