SuperAPI AI 工具集

codebase-text-report

通用与其它

查看项目

更新于 10-16 05:00

技能介绍

用途:把整个代码库(本地目录或远程 Git URL)以纯文本分块方式摄入,读完每个分块后写出基于实际内容的报告。它是 codebase-vision-report 的纯文本版本,后者用图片方式阅读,本技能不使用图片管线。

主要能力:

  • 接收目标与提示词,按 :: 分割。调用方式:/codebase-text-report <target> :: <prompt>,或 Skill(skill="codebase-text-report", args="<target> :: <prompt>")。
  • 无 :: 时,整串作为 target,默认提示词为“Summarize this codebase's architecture and key components.”。
  • 支持可重复的 --exclude-pattern <glob> 与 --include-pattern <glob>,用于缩小大型代码库范围;文本模式没有图片配置等价项。

使用方式:

  1. 用 npx 运行 gitoutput 并带 --json(不带 --images),输出到新的基础名: npx github:AnEntrypoint/gitoutput "<target>" --json --output "./codebase-text-<slug>-<suffix>.txt" [--exclude-pattern <p> ...] [--include-pattern <p> ...] 解析 stdout JSON:{outDir, chunkFiles, chunkCount}。非零退出或 JSON 含 error 表示失败,应直接报告错误,不继续。真实目标的 chunkCount 不会为 0;若内容极少(如 Files analyzed: 0),应如实说明而非编造。
  2. 按顺序逐块读取 chunkFiles 的纯文本 .txt 文件。大代码库可分批次读取并记录覆盖内容,避免只抽样却当成全量。文本模式没有 factsheet.txt。
  3. 撰写报告:先一段直接回答提示词,再按代码库实际结构给出支撑细节,引用具体文件、函数与模式。写入 <outDir>/<slug>-report.md,同时在回复中呈现,并保留分块文件供复查,不要删除。

适用场景:需要基于真实读取内容回答代码库架构、组件或特定问题(如安全、某功能是否正确处理)时使用。

限制:报告质量依赖实际读取的内容;失败时不得继续;不适合用图片管线阅读的场景,应改用 codebase-vision-report。具体定价与平台细节暂未提供。