【工具推荐】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 小时前
LLM系列:1.python入门:15.JSON 数据处理与操作
开发语言·python·json·aigc
handler013 小时前
从源码到二进制:深度拆解 Linux 下 C 程序的编译与链接全流程
linux·c语言·开发语言·c++·笔记·学习
小白学大数据4 小时前
现代Python爬虫开发范式:基于Asyncio的高可用架构实战
开发语言·爬虫·python·架构
渔舟小调4 小时前
P19 | 前端加密通信层 pikachuNetwork.js 完整实现
开发语言·前端·javascript
不爱吃炸鸡柳4 小时前
数据结构精讲:树 → 二叉树 → 堆 从入门到实战
开发语言·数据结构
网络安全许木4 小时前
自学渗透测试第21天(基础命令复盘与DVWA熟悉)
开发语言·网络安全·渗透测试·php
t***5444 小时前
如何在Dev-C++中使用Clang编译器
开发语言·c++
码界筑梦坊4 小时前
93-基于Python的中药药材数据可视化分析系统
开发语言·python·信息可视化
Cosmoshhhyyy5 小时前
《Effective Java》解读第49条:检查参数的有效性
java·开发语言
棋子入局5 小时前
C语言制作消消乐游戏(2)
c语言·开发语言·游戏