【工具推荐】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 文档。文档需要包括:项目简介、主要功能、技术栈、如何安装运行、核心模块代码逻辑解读等。

相关推荐
2501_944521599 小时前
Ramda 跨端三方库仓颉适配全流程
开发语言·javascript·flutter·php
行思理9 小时前
go语言学习难度及适合学习的人群
开发语言·学习·golang
wangchunyu11411 小时前
JAVA CompletableFuture异步编程实战
java·开发语言·python
程序 代码狂人12 小时前
切片表与分区表的区别(数据开发面试版)
java·大数据·开发语言·数据仓库·算法
meiying883813 小时前
快递单号批量查询Python脚本:从手动到自动化的完整实现
开发语言·python·自动化
@大迁世界14 小时前
告别 Go,拥抱 Rust
开发语言·golang·rust
SEO_juper14 小时前
Node.js 重定向链检测工具:301 跳了几跳、有没有成环,一次看清
xml·开发语言·python·node.js·json·bash
学逆向的14 小时前
C 指针常量与常量指针
c语言·开发语言·网络安全
低调滴开发15 小时前
3 行代码写崩一个函数?切片才是 Rust 字符串处理的正确姿势
开发语言·后端·rust
CodeYp201915 小时前
第15讲:二叉搜索树
开发语言·c++·二叉搜索树