一、项目介绍

给大模型看代码是常态:问 bug、写文档、做重构建议。但手动把几十个文件拼进对话既费时又容易漏。有人用剪贴板硬凑,有人写一次性脚本,结果每个人都在重复造把仓库喂给模型的小轮子。
code2prompt 是个 Rust 写的小工具,专门干这一件事:按你给的路径和过滤规则,把一个代码库整理成结构清晰、格式统一的提示词,还能带上 git diff、模板和敏感文件过滤。它快、跨平台、可脚本化,是 AI 编程工作流里一个不起眼但高频的零件。

二、项目基本信息

信息项详情
项目名称code2prompt
GitHub地址https://github.com/mufeedvh/code2prompt
项目描述
作者mufeedvh
开源协议MIT License
开源状态公开
LanguagesRust
支持平台Windows / macOS / Linux
最后更新2026-10-16

三、核心优势

  • 智能过滤:用 glob 包含/排除文件,自动尊重 .gitignore
  • 灵活模板:用 Handlebars 定制不同场景的提示词
  • 自动处理:任意规模代码库都能整理成可读格式
  • Git 集成:可附带 diff、日志与分支对比
  • 多格式读取:对 CSV、Notebook、JSONL 等做友好转换

四、适用场景

适合在让 AI 审代码、写文档、做迁移或回答仓库问题时,快速生成带上下文的提示词;也可嵌入自动化脚本。

五、安装教程

当前最新版本 latest。按下方命令安装(如遇网络问题可切换镜像源):

cargo install code2prompt

常见报错:依赖缺失时先升级运行环境(如 Node、Python、.NET、JDK)到项目要求版本;网络超时多为镜像或代理问题,可重试或换源。

六、使用示例

下面是一段可直接运行或参考的真实示例:

code2prompt ./my-project --output prompt.txt
# 仅包含 src 目录、排除测试
code2prompt ./my-project -i "src/**" -e "**/*.test.ts" --output p.txt

七、常见问题

问:除了 cargo 还有其他装法吗?答:提供 brew、pip 等多种安装方式。问:会泄露密钥吗?答:默认尊重 .gitignore,并用过滤规则排除敏感文件,生成前建议预览包含列表。

八、总结

code2prompt 用一个清晰的设计,把把高频小事自动化这件事从重复劳动变成了可复用、可维护的工程能力。它不追求大而全,而是把核心痛点解决得足够扎实,这正是日常开发与团队落地时最需要的那种工具。如果你也在被同类问题困扰,不妨按上面的安装与使用步骤试一试,把它接进自己的工作流。