mcpField
G
gsd-map-codebase

gsd-map-codebase

github.com/shoootyouAgent 工作流22133 次安装32 周前更新
代码仓库

关于 gsd-map-codebase

gsd-map-codebase 是将现有代码库整理为 7 份结构化文档的技能。它并行分派 Agent 分析技术、架构、质量和风险，并由 Agent 直接写入项目文件。

主要功能

  1. 01梳理技术、架构与代码质量
  2. 02使用 4 个并行映射 Agent
  3. 03在 .planning/codebase/ 写入 7 份文档
  4. 04可指定子系统作为分析重点
  5. 05检查已有项目状态

适用场景

  1. 01在项目初始化前了解代码库
  2. 02熟悉不熟悉的代码库
  3. 03重大变更后刷新文档
  4. 04为大型重构做准备

安装

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

$npx skills add https://github.com/shoootyou/get-shit-done-multi --skill gsd-map-codebase

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

详细介绍

使用并行的 gsd-codebase-mapper Agent 分析现有代码库，并生成结构化的代码库文档。

每个映射 Agent 会探索一个重点领域，并直接将文档写入 .planning/codebase/。编排器只接收确认信息，以尽量减少上下文用量。

输出：.planning/codebase/ 文件夹，包含 7 份描述代码库现状的结构化文档。

<execution_context> @{{PLATFORM_ROOT}}/get-shit-done/workflows/map-codebase.md </execution_context>

重点领域：$ARGUMENTS（可选——如果提供，将告知 Agent 聚焦于特定子系统）

如果存在，则加载项目状态： 检查是否存在 .planning/STATE.md——如果项目已初始化，则加载上下文

此命令可在以下情况下运行：

  • 在 {{COMMAND_PREFIX}}new-project 之前（棕地代码库）——先创建代码库映射
  • 在 {{COMMAND_PREFIX}}new-project 之后（绿地代码库）——随着代码演进更新代码库映射
  • 随时刷新对代码库的了解

<when_to_use> 以下情况使用 map-codebase：

  • 初始化前的棕地项目（先了解现有代码）
  • 重大变更后刷新代码库映射
  • 熟悉陌生的代码库
  • 大规模重构前（了解当前状态）
  • STATE.md 引用了过时的代码库信息

以下情况跳过 map-codebase：

  • 尚无代码的绿地项目（无内容可映射）
  • 简单的代码库（少于 5 个文件） </when_to_use>
1. 检查 `.planning/codebase/` 是否已存在（提供刷新或跳过选项） 2. 创建 `.planning/codebase/` 目录结构 3. 并行启动 4 个 gsd-codebase-mapper Agent： - Agent 1：技术重点 → 写入 STACK.md、INTEGRATIONS.md - Agent 2：架构重点 → 写入 ARCHITECTURE.md、STRUCTURE.md - Agent 3：质量重点 → 写入 CONVENTIONS.md、TESTING.md - Agent 4：关注点重点 → 写入 CONCERNS.md 4. 等待 Agent 完成并收集确认信息（而非文档内容） 5. 确认全部 7 份文档均已生成，并统计行数 6. 提交代码库映射 7. 提供后续步骤建议（通常为：{{COMMAND_PREFIX}}new-project 或 {{COMMAND_PREFIX}}plan-phase）

<success_criteria>

  • 已创建 .planning/codebase/ 目录
  • 4 个映射 Agent 已写入全部 7 份代码库文档
  • 文档遵循模板结构
  • 并行 Agent 均已完成且无错误
  • 用户了解后续步骤 </success_criteria>

评论

支持 Markdown