【工具推荐】Code2Prompt

DeepWiki工具可以帮我们快速理解 GitHub 项目,简直是理解陌生开源项目的利器!

但是,它有个小小的"遗憾"------只能解析在线的 GitHub 项目。

如果是本地项目怎么办,还要特意上传,no,code2prompt 就是一款能把你的代码(Code)项目,打包成一个适合喂给 AI 的提示(Prompt)的工具。

它会把整个项目结构和代码内容,整合成一个单独的、清爽的 Markdown 文本文件。这个格式 AI 可太喜欢了,理解起来毫无压力!

安装

复制代码
pip install code2prompt

或用清华源:

复制代码
pip install code2prompt -i https://pypi.tuna.tsinghua.edu.cn/simple

使用就三步

code2prompt

-p 项目代码的根文件夹路径

-o 输出的 Markdown 文件的完整路径+文件名

--line-number (必写)

-e "*.json,*.log,*.jsonl,*.csv" (你希望排除的文件类型)
-e:我们通常不希望把日志文件、大型 JSON 数据文件、CSV 数据表等打包进去,因为它们对 AI 理解代码逻辑帮助不大,反而会占用大量 Token。你可以根据自己的项目情况增删。

假设你的项目代码放在 D:/my_project 文件夹里,你想把打包后的 Markdown 文件输出到 D:/ 目录下,并命名为 my_project_prompt.md

code2prompt -p D:/my_project -o D:/my_project_prompt.md --line-number -e "*.json,*.log,*.jsonl,*.csv"

这样给ai,ai一定开心:

这是一个代码项目的完整内容。请基于这些代码,为我生成一份极其详尽的中文 README.md 文档。文档需要包括:项目简介、主要功能、技术栈、如何安装运行、核心模块代码逻辑解读等。

相关推荐
测试员周周3 小时前
【Appium 系列】第16节-WebView-H5上下文切换 — 混合应用的自动化难点
运维·开发语言·人工智能·功能测试·appium·自动化·测试用例
杜子不疼.6 小时前
【C++ AI 大模型接入 SDK】 - DeepSeek 模型接入(上)
开发语言·c++·chatgpt
加号36 小时前
【C#】 串口通信技术深度解析及实现
开发语言·c#
sycmancia6 小时前
Qt——编辑交互功能的实现
开发语言·qt
石山代码7 小时前
C++ 内存分区 堆区
java·开发语言·c++
无风听海7 小时前
C# 隐式转换深度解析
java·开发语言·c#
一只大袋鼠8 小时前
Git 进阶(二):分支管理、暂存栈、远程仓库与多人协作
java·开发语言·git
LuminousCPP9 小时前
数据结构 - 线性表第四篇:C 语言通讯录优化升级全记录(踩坑 + 思考)
c语言·开发语言·数据结构·经验分享·笔记·学习
web3.08889999 小时前
1688 图搜接口(item_search_img / 拍立淘) 接入方法
开发语言·python
один but you9 小时前
从可变参数到 emplace:现代 C++ 性能优化的核心组合
java·开发语言