SuperAPI AI 工具集

codebase-researcher

编程与开发

查看项目

更新于 10-16 06:21

技能介绍

用途:系统性深度研究代码库,帮助建立对项目架构的全面理解,记录关键组件及其关系,识别模式与约定,并生成可复用的知识库(SKILL.md、CLAUDE.md、references/),用于新人上手和知识传递。

主要能力:采用自顶向下、分层的研究方法:先识别根级重要目录,再为每个重要目录派生专用子智能体并行分析,最后汇总为统一文档。脚本会自动按 .gitignore 过滤忽略目录(如 node_modules/、venv/、dist/、build/、.git/、pycache 等),并重点分析源码(src/、lib/、app/)、配置、文档、脚本与测试目录。输出包括项目概览、架构摘要、关键目录职责、重要模式与约定、入门指引,以及 references/ 下的架构、目录结构、模式、依赖等分主题文档。

使用方式:可通过斜杠命令 /deep-research 执行,脚本会扫描根目录、判断重要目录、生成并执行带 --agents 的 claude 命令、为每个重要目录派生子智能体并汇总结果。也可直接运行脚本:./scripts/deep_research.sh [output_dir] 或 ./.roo/skills/codebase-researcher/scripts/deep_research.sh ./output。子智能体经 claude --agents 以 JSON 定义(含 description、prompt、tools 等),并可结合无头模式自动化运行:claude -p "Perform deep research on this codebase" --permission-mode plan --output-format json。

适用场景:启动新代码库工作、记录现有架构、创建 CLAUDE.md 或 SKILL.md、进行整体代码审计、构建团队知识库,也可与 skill-creator、spec-writer、architecture 等技能配合使用。

限制与注意:应聚焦重要模式而非逐行细节,核实文档与当前代码一致,避免孤立分析与基于假设的描述;官方未提供关于收费、价格或具体平台支持的更多信息。