Code2Prompt 工具介绍
你是否遇到过这样的场景:想用 AI 辅助分析一个庞大的本地项目,却苦于代码文件太多、结构太复杂,不知道如何高效地把所有内容喂给 AI?Code2Prompt 是一款能将你的代码项目(Code),打包成一个适合 AI 处理的提示(Prompt)的终极工具。
它会递归扫描你的项目目录,将整个项目结构和代码内容,智能整合成一个清爽、易读的 Markdown 文本文件。这种格式正是 AI(如 ChatGPT、Claude、Copilot 等)的最爱,理解起来毫无压力,让你的分析、调试或代码生成任务变得前所未有的高效。
安装方法
安装 code2prompt 非常简单,只需要你的电脑上有 Python 环境。
打开终端(Terminal)、CMD 或 Anaconda Prompt,输入:
pip install code2prompt
如果从官方源下载速度慢,可以使用镜像源加速:
pip install code2prompt -i https://pypi.tuna.tsinghua.edu.cn/simple
使用方法
假设你的项目代码放在 D:/my_project 文件夹里,你想把打包后的 Markdown 文件输出到 D:/目录下,并命名为 my_project_prompt.md。
操作步骤:
- 打开命令行工具(CMD、PowerShell、Terminal 等)。
- 输入以下命令:
code2prompt -p D:/my_project -o D:/my_project_prompt.md --line-number -e "*.json,*.log,*.jsonl,*.csv"
- 敲下回车,等待进度条读完。
命令参数详解
code2prompt: 核心命令。-p D:/my_project(或--path): 指定项目根目录路径。-o D:/my_project_prompt.md(或--output): 指定输出文件的完整路径和文件名。--line-number: 在生成的代码块中自动加上行号,方便后续沟通。-e "*.json,*.log,*.jsonl,*.csv"(或--exclude): 指定需要排除的文件类型,节省 Token。
优势
- 极致效率:告别手动复制粘贴多个文件,一键生成完整项目上下文。
- AI 友好:标准的 Markdown 格式是大型语言模型的最佳食粮,分析更准确。
- 精准定位:
--line-number参数让后续的代码讨论可以精确到行。 - 干净简洁:排除无用文件,节省宝贵的 Token,让 AI 专注于核心逻辑代码。

