mcpField
C
codebase-navigator

codebase-navigator

github.com/srbhr开发28.9k44 次安装6 天前更新
代码仓库

关于 codebase-navigator

codebase-navigator 是面向开发者的代码库探索技能，用于查找代码并了解项目结构。它结合搜索与追踪脚本，以及架构和入口文件索引。

主要功能

  1. 01搜索函数、组件和端点
  2. 02追踪 API 与数据流
  3. 03查找符号用法和依赖
  4. 04浏览架构及入口文档

适用场景

  1. 01定位函数或组件定义
  2. 02追踪功能的调用或数据流

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/srbhr/resume-matcher --skill codebase-navigator

安装后在 Claude Code 中输入/codebase-navigator确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
REFERENCE.md
scripts/
search.sh
trace.sh

详细介绍

代码库导航器

探索代码、查找文件或了解项目结构时，请先使用此 Skill。

快速开始

搜索脚本（推荐）

运行随附脚本执行常见搜索：

# Find functions/methods
.agents/skills/codebase-navigator/scripts/search.sh functions <pattern>

# Find React components
.agents/skills/codebase-navigator/scripts/search.sh components <pattern>

# Find API endpoints
.agents/skills/codebase-navigator/scripts/search.sh endpoints

# Trace an API flow end-to-end
.agents/skills/codebase-navigator/scripts/trace.sh api-flow <endpoint>

# Trace a data field from backend to UI
.agents/skills/codebase-navigator/scripts/trace.sh data-flow <field_name>

# Find component hierarchy
.agents/skills/codebase-navigator/scripts/trace.sh component-tree <ComponentName>
直接使用 ripgrep 模式
# Find any symbol
rg --no-heading -n '\bMySymbol\b' apps/

# Python function definitions
rg --no-heading -n '(def|async def) my_function' apps/backend/ --type py

# React component usage
rg --no-heading -n '<MyComponent' apps/frontend/ --glob '*.tsx'

# Pydantic models
rg --no-heading -n 'class My.*BaseModel' apps/backend/ --type py

# API route handlers
rg --no-heading -n '@(router|app)\.(get|post|put|patch|delete)' apps/backend/ --type py

架构概览

需求文档
后端架构docs/agent/architecture/backend-architecture.md
前端架构docs/agent/architecture/frontend-architecture.md
API 契约docs/agent/apis/front-end-apis.md
API 流程图docs/agent/apis/api-flow-maps.md
完整文档索引docs/agent/README.md

项目结构

apps/
├── backend/app/
│   ├── main.py              # FastAPI entry, CORS, routers
│   ├── config.py            # Pydantic settings from env
│   ├── database.py          # TinyDB wrapper
│   ├── llm.py               # LiteLLM wrapper
│   ├── routers/             # API endpoints
│   ├── services/            # Business logic
│   ├── schemas/             # Pydantic models
│   └── prompts/             # LLM prompt templates
│
└── frontend/
    ├── app/                 # Next.js pages
    ├── components/          # UI components
    ├── lib/                 # API client, utilities, i18n
    ├── hooks/               # Custom React hooks
    └── messages/            # i18n translations (en, es, zh, ja)

常见工作流

"X 在哪里定义？"
.agents/skills/codebase-navigator/scripts/search.sh functions my_function
.agents/skills/codebase-navigator/scripts/search.sh components MyComponent
.agents/skills/codebase-navigator/scripts/search.sh classes MyClass
.agents/skills/codebase-navigator/scripts/search.sh types MyType
"谁调用了 X？"
.agents/skills/codebase-navigator/scripts/search.sh usage my_function
.agents/skills/codebase-navigator/scripts/search.sh deps my_file.py
"功能 X 的数据如何流转？"
.agents/skills/codebase-navigator/scripts/trace.sh api-flow resumes
.agents/skills/codebase-navigator/scripts/trace.sh data-flow personalInfo
.agents/skills/codebase-navigator/scripts/trace.sh component-tree ResumeEditor

关键入口文件

内容文件
后端启动apps/backend/app/main.py
前端页面apps/frontend/app/
API 客户端apps/frontend/lib/api.ts 或 lib/api-client.ts
设计令牌apps/frontend/app/globals.css
简历 Schemaapps/backend/app/schemas/
大模型提示词apps/backend/app/prompts/

参考资料

完整的 ripgrep 速查表和高级搜索模式，请参阅 references/REFERENCE.md。

评论

支持 Markdown