SuperAPI AI 工具集

codebase-search

通用与其它

查看项目

更新于 10-15 17:32

技能介绍

用途:面向大型代码库的搜索与导航技能,帮助查找特定函数或类、追踪函数调用与依赖、理解代码结构与架构、查找用法示例、识别代码模式、定位缺陷及进行改动前的影响分析。常见场景包括定位功能实现、排查错误来源、了解 API 用法、查找配置定义、学习陌生代码库、为重构做准备、添加新功能以及理解遗留代码。

主要能力:提供三类搜索策略。语义搜索适合概念性问题,如“用户认证是如何实现的”,可按含义查找相关代码,适合不熟悉的代码库与探索式搜索;grep 适合已知确切文本或模式,如函数名“def authenticate”、类名“class UserManager”、错误信息或特定字符串,支持正则表达式,快速精确;glob 适合按文件模式发现文件,如“/*.test.js”“/config*.yaml”“src/**/*Controller.py”,便于定位同类或相关文件。技能还给出常用搜索模式,包括按语言查找函数定义、类定义、调用与导入,如 grep -n "def function_name" --type py、grep -n "class ClassName" --type js,ts、grep -n "from.*import.*ModuleName" --type py;查找配置、环境变量、常量、TODO/FIXME 及错误处理,如 grep -n "TODO|FIXME|HACK|XXX" -i。

使用方式:先明确搜索目标,再选择策略。推荐从宽到窄:先用语义搜索锁定目录,再用 grep 精确定位具体函数,最后阅读文件理解实现。可按目录缩小范围,并组合多种搜索逐步建立理解。常用优化选项包括显示上下文(-C 5、-B 3、-A 3)、忽略大小写(-i)、按文件类型过滤(--type py,js,ts)及 glob 排除。还可结合 Git 命令,如 git blame filename、git log -p filename、git log -S "function_name" --source --all、git log --grep="feature name",并配合 IDE 的跳转定义、查找引用与符号搜索。

适用场景:调试理解错误触发路径、学习新代码库的入口与路由、重构前收集全部调用点与测试、开发新功能时寻找相似实现与测试范例、沿数据流追踪对象从创建到消费的全过程。

限制:资料未说明具体平台、定价或性能指标;技能本身不执行代码修改,搜索准确性依赖查询表述与代码库结构。若结果为空可检查拼写与大小写、改用语义搜索、放宽范围或更换关键词;结果过多可增加目录定向、使用更具体模式或按类型过滤;结果不符预期可改用 grep 精确匹配或补充语义查询上下文。