Repolode
mufeedvh

mufeedvh/code2prompt

一款 Rust 命令行工具,把代码库打包成单个 LLM 提示词,附带目录树、模板和 token 估算。

Star
7,748
Fork
458
未关闭 Issue
19
最近提交
15小时前

这是什么?

Code2Prompt 可以把项目目录转换成一份结构化的提示词,方便直接粘贴到 ChatGPT、Claude 等大模型中,或交给智能体使用。输出内容包含目录树以及所选文件的内容,无需手动逐个复制文件。

工具支持用 glob 模式指定包含或排除的文件,并遵循 .gitignore 规则过滤。提示词通过 Handlebars 模板渲染,还可以加入 git diff、提交日志和分支对比信息。对于 CSV、Jupyter Notebook、JSONL 等非代码文件,也提供简化的读取方式。

项目包含 Rust 核心库、带交互式 TUI 的命令行工具、发布在 PyPI 上的 Python SDK,以及用于本地智能体应用的 MCP 服务。token 数量按文件逐个估算,而不是对完整渲染后的提示词重新分词计算。

核心功能

  • 01将目录树和文件内容合并为一份提示词。
  • 02支持用 glob 模式筛选文件,并遵循 .gitignore 规则。
  • 03通过 Handlebars 模板自定义输出格式。
  • 04按文件估算 token 数量,可选显示行号。
  • 05可加入 git diff、提交日志和分支对比。
  • 06提供命令行工具、Python SDK 和 MCP 服务三种使用方式。

适用场景

  • 将项目上下文粘贴到聊天大模型中进行代码审查或调试。
  • 通过 Python SDK 或 MCP 服务把代码仓库提供给 AI 智能体。
  • 只把相关文件和最近的代码差异发送给模型。
  • 在发送前预估整个代码库会消耗多少 token。

快速上手

  1. 1

    使用 Cargo 安装命令行工具

    cargo install code2prompt
  2. 2

    或使用 Homebrew 安装

    brew install code2prompt
  3. 3

    为当前目录生成提示词

    code2prompt .
  4. 4

    将提示词保存到文件

    code2prompt path/to/project --output-file prompt.txt

使用前须知

  • 若通过 Cargo 安装或从源码构建,需要 Rust 工具链。

收录于专题

标签

常见问题

code2prompt 是什么?
一款 Rust 命令行工具,把代码库打包成单个 LLM 提示词,附带目录树、模板和 token 估算。 Code2Prompt 可以把项目目录转换成一份结构化的提示词,方便直接粘贴到 ChatGPT、Claude 等大模型中,或交给智能体使用。输出内容包含目录树以及所选文件的内容,无需手动逐个复制文件。
code2prompt 可以免费使用吗?用的什么许可证?
code2prompt 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
code2prompt 还在维护吗?
活跃维护中。code2prompt 最近一次提交是在 2026年11月6日。
code2prompt 适合用来做什么?
将项目上下文粘贴到聊天大模型中进行代码审查或调试。 通过 Python SDK 或 MCP 服务把代码仓库提供给 AI 智能体。 只把相关文件和最近的代码差异发送给模型。 在发送前预估整个代码库会消耗多少 token。
code2prompt 怎么安装和运行?
使用 Cargo 安装命令行工具: cargo install code2prompt 或使用 Homebrew 安装: brew install code2prompt 为当前目录生成提示词: code2prompt . 将提示词保存到文件: code2prompt path/to/project --output-file prompt.txt
在哪里获取 code2prompt?
源代码和安装说明在 GitHub 上:https://github.com/mufeedvh/code2prompt

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目