mcpField
P
project-discovery

project-discovery

github.com/laurigates开发5966 次安装1 天前更新
代码仓库

关于 project-discovery

该 Skill 帮助 Claude Code 用户进入陌生的 Git 代码库时快速了解项目状态、结构和开发工具。它通过脚本或手动检查整理风险提示与后续建议。

主要功能

  1. 01检查分支、改动与提交历史
  2. 02识别语言、框架和仓库结构
  3. 03发现构建、测试与 CI 工具
  4. 04快速扫描文档与配置风险

适用场景

  1. 01接手陌生代码库前了解现状
  2. 02为新克隆项目查找构建与测试命令
  3. 03在修改前发现未提交改动或分支差异

安装

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

$npx skills add https://github.com/laurigates/claude-plugins --skill project-discovery

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

包含的文件

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

REFERENCE.md
scripts/
analyze-skills.sh
discover.sh
scripts/tests/
test-analyze-skills.sh

详细介绍

项目探索

何时使用此技能

在以下情况下使用此技能……在以下情况下改用 project-continue……
进入陌生的代码库，需要了解语言和工具根据 PRD 和功能跟踪器，在熟悉的项目中继续已知工作
推理中出现不确定的表述（“不确定这是什么用途”）已经有明确的下一项任务，只需继续执行
克隆了一个新仓库，需要了解构建／测试命令从头搭建全新项目时改用 project-init

在做出更改前，系统地了解代码库的状态。通过明确 Git 状态、项目结构和开发工具，避免基于错误假设开展工作。

核心专长

自动激活检测：

  • 检测 Claude 推理或回复中的不确定性
  • 在用户手动请求了解项目情况时激活
  • 仅针对 Git 仓库

探索能力：

  • 分析 Git 状态（分支、更改、远程同步、提交历史）
  • 识别项目类型（语言、框架、单体仓库检测）
  • 探索开发工具（构建、测试、Lint、CI/CD）
  • 快速浏览文档（README、安装说明）
  • 识别风险标记（未提交的工作、分支分歧）

输出：

  • 项目状态的结构化摘要
  • 突出显示关键风险标记
  • 提供可执行的后续步骤建议
  • 探索时间为 2-3 分钟

此技能的激活时机

自动触发条件

当 Claude 的内部推理或回复中出现以下不确定性表述时，此技能会自动激活：

  • “我应该先了解……”
  • “让我检查一下项目……”
  • “不确定项目结构……”
  • “我需要了解……”
  • “继续之前，让我先……”
  • “我不太确定……”
  • “让我调查一下项目……”

**原因：**这些表述表明 Claude 正在缺少完整上下文的情况下工作，这可能导致错误假设、错误命令或不恰当的文件编辑。

手动调用

用户可以通过以下关键词明确请求探索项目：

  • “了解项目情况”
  • “探索项目”
  • “了解此代码库”
  • “项目当前状态如何？”
  • “分析项目结构”
  • “为我介绍项目背景”
不应激活的情况

在以下情况下，请勿激活此技能：

  • Claude 已掌握明确的上下文，并且正有把握地执行具体任务
  • 用户询问的是 Claude 已分析过的特定代码
  • 当前对话已确立项目上下文
  • 在非 Git 目录中工作（此技能专注于 Git）

快速探索（推荐）

如需快速、一致地了解项目情况，请运行随附的探索脚本：

bash "${CLAUDE_PLUGIN_ROOT}/skills/project-discovery/scripts/discover.sh"

此脚本可用一次执行取代手动的 5 步流程，并输出结构化数据，涵盖 Git 状态、项目类型、工具、文档和风险评估。

如需查看完整的手动工作流（包含所有命令、风险标记、摘要模板、针对非 Git／空目录／大型单体仓库／缺少文档等情况的错误处理，以及相关原理），请参阅 REFERENCE.md。

与其他技能集成

相关技能
  • git-commit-workflow：发现常见提交模式后使用
  • chezmoi-expert：如果项目是 dotfiles 仓库（检测 chezmoi.toml）
  • git-security-checks：检测到 pre-commit 钩子时运行
  • Explore agent：如果需要在初步了解之外进一步探索代码库，则委派给此 Agent
何时委派

项目探索后，如果用户要求进一步调查：

  • “身份验证是如何工作的？” → 使用 Explore Agent
  • “检查这段代码是否存在安全问题” → 使用 security-audit Agent
  • “了解架构” → 使用 code-analysis Agent

项目探索用于确立基准上下文；专门技能则负责深入调查。

快速参考：探索命令

必要的 Git 命令
git branch --show-current                     # Current branch
git status --short --branch                   # Git state summary
git log --oneline -n 10                       # Recent commits
git rev-list --count HEAD...@{u}              # Commits ahead/behind remote
项目类型、工具链和文档

scripts/discover.sh 已能检测项目类型（清单文件）、工具链（npm 脚本、Make 目标、CI 工作流）和文档。请从脚本的结构化输出中读取这些信息，或直接使用 Glob/Grep/Read 工具，而不要手动编写 ls/find/head shell 命令——完整的手动命令集请参阅 REFERENCE.md。

输出示例

完整的发现输出示例请参阅 examples.md，其中包括：

  • 使用 pytest + ruff + GitHub Actions 的 Python 项目
  • 使用 npm + ESLint + Vitest 的 JavaScript/TypeScript 项目
  • 使用 cargo + clippy 且没有 CI 的 Rust 项目
  • 包含多个子项目的 Monorepo
  • 存在未提交更改的项目（风险标记）
  • 已清理完毕、可开始工作的项目

详细的命令参考和更多示例请参阅 discovery-commands.md 和 examples.md。

评论

支持 Markdown