cursor 安装和使用gsd
GSD (Get Shit Done) 是一个轻量级且强大的元提示、上下文工程和规范驱动开发系统,专门为 Cursor IDE 适配。它通过结构化的工作流程,帮助开发者使用 AI 工具可靠地构建软件。
官方仓库: - GSD for Cursor - Cursor IDE 专用版本 - GSD 主仓库 - 原始版本(支持多个平台)
什么是 GSD?
GSD 是一个元提示和上下文工程系统,解决了 AI 编程中的”上下文腐化”问题——当 Claude 填满上下文窗口时发生的质量下降。GSD 通过以下方式解决这个问题:
- 27 个斜杠命令 - 用于项目生命周期管理
- 11 个专门的代理 - 用于不同任务(规划、执行、验证、研究)
- 工作流文档 - 包含详细的过程逻辑
- 模板 - 用于生成的工件
- 参考文档 - 提供深度指导
GSD 的核心价值
GSD 的设计理念是:复杂性在系统中,而不是在你的工作流中。它提供了:
- 上下文工程 - 自动管理 Claude 需要的上下文
- XML 提示格式化 - 每个计划都是结构化的 XML,针对 Claude 优化
- 多代理编排 - 每个阶段使用专门的代理,保持主上下文窗口干净
- 原子 Git 提交 - 每个任务都有独立的提交,便于追踪和回滚
系统要求
- Cursor IDE 版本 2.4 或更高
安装方法
方法一:使用安装脚本(推荐)⭐
GSD for Cursor 提供了便捷的安装脚本,支持 Windows、macOS 和 Linux。
Windows (PowerShell):
.\scripts\install.ps1
macOS/Linux:
./scripts/install.sh
安装脚本会自动:
1. 克隆 GSD for Cursor 仓库到 ~/.cursor/ 目录
2. 设置必要的配置
3. 验证安装
方法二:手动安装
如果需要更多控制,可以手动安装:
步骤 1:克隆仓库
mkdir -p ~/.cursor
git clone https://github.com/rmindel/gsd-for-cursor.git ~/.cursor/gsd-for-cursor
步骤 2:复制文件到 Cursor 配置目录
# 复制命令
cp -r ~/.cursor/gsd-for-cursor/src/commands/* ~/.cursor/commands/
# 复制代理
cp -r ~/.cursor/gsd-for-cursor/src/agents/* ~/.cursor/agents/
# 复制工作流
cp -r ~/.cursor/gsd-for-cursor/src/workflows/* ~/.cursor/workflows/
步骤 3:验证安装
重启 Cursor,然后在 Agent 聊天中输入:
/gsd/help
如果看到帮助信息,说明安装成功。
基本工作流
GSD 提供了一个结构化的开发流程,从项目初始化到完成:
1. 映射现有代码库(可选)
如果你已经有代码,先运行:
/gsd/map-codebase
这会启动并行代理来分析你的技术栈、架构、约定和关注点。然后 /gsd/new-project 就会了解你的代码库。
2. 初始化项目
/gsd/new-project
一个命令,一个流程。系统会:
- 提问 - 持续询问直到完全理解你的想法(目标、约束、技术偏好、边界情况)
- 研究 - 启动并行代理调查领域(可选但推荐)
- 需求 - 提取 v1、v2 和超出范围的内容
- 路线图 - 创建映射到需求的阶段
你批准路线图后,就可以开始构建了。
创建的文件: PROJECT.md, REQUIREMENTS.md, ROADMAP.md, STATE.md, .planning/research/
3. 讨论阶段
/gsd/discuss-phase 1
这是你塑造实现的地方。
路线图每个阶段只有一两句话。这不足以按照你想象的方式构建。这一步在研究和规划之前捕获你的偏好。
系统分析阶段并识别基于构建内容的灰色区域:
- 视觉功能 → 布局、密度、交互、空状态
- API/CLI → 响应格式、标志、错误处理、详细程度
- 内容系统 → 结构、语调、深度、流程
- 组织任务 → 分组标准、命名、重复、异常
对于你选择的每个区域,它会询问直到你满意。输出 CONTEXT.md 直接输入到下一步。
创建的文件: {phase_num}-CONTEXT.md
4. 规划阶段
/gsd/plan-phase 1
系统会:
- 研究 - 研究如何实现此阶段,由你的 CONTEXT.md 决策指导
- 规划 - 创建 2-3 个原子任务计划,使用 XML 结构
- 验证 - 对照需求检查计划,循环直到通过
每个计划都足够小,可以在新的上下文窗口中执行。没有质量下降,没有”我现在会更简洁”。
创建的文件: {phase_num}-RESEARCH.md, {phase_num}-{N}-PLAN.md
5. 执行阶段
/gsd/execute-phase 1
系统会:
- 分波运行计划 - 可能时并行,依赖时顺序
- 每个计划使用新上下文 - 200k token 纯粹用于实现,零累积垃圾
- 每个任务提交 - 每个任务都有自己的原子提交
- 对照目标验证 - 检查代码库是否交付了阶段承诺的内容
你可以走开,回来时看到完成的工作和干净的 git 历史。
波执行工作原理:
计划根据依赖关系分组为”波”。每波内,计划并行运行。波按顺序运行。
WAVE 1 (并行) WAVE 2 (并行) WAVE 3
┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌─────────┐
│ Plan 01 │ │ Plan 02 │ → │ Plan 03 │ │ Plan 04 │ → │ Plan 05 │
│ User │ │ Product │ │ Orders │ │ Cart │ │ Checkout│
│ Model │ │ Model │ │ API │ │ API │ │ UI │
└─────────┘ └─────────┘ └─────────┘ └─────────┘ └─────────┘
│ │ ↑ ↑ ↑
└───────────┴──────────────┴───────────┘ │
Dependencies: Plan 03 needs Plan 01 │
Plan 04 needs Plan 02 │
Plan 05 needs Plans 03 + 04 │
创建的文件: {phase_num}-{N}-SUMMARY.md, {phase_num}-VERIFICATION.md
6. 验证工作
/gsd/verify-work 1
这是你确认它实际工作的地方。
自动化验证检查代码存在且测试通过。但功能是否按你预期的方式工作?这是你使用它的机会。
系统会:
- 提取可测试的交付物 - 你现在应该能够做什么
- 逐个引导你 - “你能用邮箱登录吗?” 是/否,或描述问题
- 自动诊断失败 - 启动调试代理查找根本原因
- 创建验证的修复计划 - 准备好立即重新执行
如果一切通过,你继续。如果有问题,你不手动调试——只需再次运行 /gsd/execute-phase,使用它创建的修复计划。
创建的文件: {phase_num}-UAT.md,如果发现问题则创建修复计划
7. 重复 → 完成 → 下一个里程碑
/gsd/discuss-phase 2
/gsd/plan-phase 2
/gsd/execute-phase 2
/gsd/verify-work 2
...
/gsd/complete-milestone
/gsd/new-milestone
循环 讨论 → 规划 → 执行 → 验证 直到里程碑完成。
当所有阶段完成后,/gsd/complete-milestone 归档里程碑并标记发布。
然后 /gsd/new-milestone 开始下一个版本——与 new-project 相同的流程,但针对你现有的代码库。
快速模式
/gsd/quick
用于不需要完整规划的临时任务。
快速模式为你提供 GSD 保证(原子提交、状态跟踪),路径更快:
- 相同的代理 - 规划器 + 执行器,相同的质量
- 跳过可选步骤 - 无研究、无计划检查、无验证器
- 单独跟踪 - 位于
.planning/quick/,不在阶段中
用于:错误修复、小功能、配置更改、一次性任务。
核心命令
核心工作流
| 命令 | 功能 |
|---|---|
/gsd/new-project [--auto] |
完整初始化:提问 → 研究 → 需求 → 路线图 |
/gsd/discuss-phase [N] [--auto] |
在规划之前捕获实现决策 |
/gsd/plan-phase [N] [--auto] |
研究 + 规划 + 验证阶段 |
/gsd/execute-phase <N> |
并行波执行所有计划,完成时验证 |
/gsd/verify-work [N] |
手动用户验收测试 |
/gsd/audit-milestone |
验证里程碑达到其完成定义 |
/gsd/complete-milestone |
归档里程碑,标记发布 |
/gsd/new-milestone [name] |
开始下一个版本 |
导航
| 命令 | 功能 |
|---|---|
/gsd/progress |
我在哪里?下一步是什么? |
/gsd/help |
显示所有命令和使用指南 |
/gsd/update |
更新 GSD 并预览变更日志 |
现有项目(Brownfield)
| 命令 | 功能 |
|---|---|
/gsd/map-codebase |
在新项目之前分析现有代码库 |
阶段管理
| 命令 | 功能 |
|---|---|
/gsd/add-phase |
追加阶段到路线图 |
/gsd/insert-phase [N] |
在阶段之间插入紧急工作 |
/gsd/remove-phase [N] |
删除未来阶段,重新编号 |
/gsd/list-phase-assumptions [N] |
在规划之前查看 Claude 的预期方法 |
会话
| 命令 | 功能 |
|---|---|
/gsd/pause-work |
在阶段中途停止时创建交接 |
/gsd/resume-work |
从上次会话恢复 |
实用工具
| 命令 | 功能 |
|---|---|
/gsd/settings |
配置模型配置文件和工作流代理 |
/gsd/set-profile <profile> |
切换模型配置文件(quality/balanced/budget) |
/gsd/add-todo [desc] |
捕获想法供以后使用 |
/gsd/check-todos |
列出待处理的 todos |
/gsd/debug [desc] |
系统化调试,带持久状态 |
/gsd/quick [--full] |
使用 GSD 保证执行临时任务 |
/gsd/health [--repair] |
验证 .planning/ 目录完整性 |
配置
GSD 将项目设置存储在 .planning/config.json 中。在 /gsd/new-project 期间配置或稍后使用 /gsd/settings 更新。
核心设置
| 设置 | 选项 | 默认值 | 控制内容 |
|---|---|---|---|
| mode | yolo, interactive | interactive | 自动批准 vs 每步确认 |
| depth | quick, standard, comprehensive | standard | 规划彻底性(阶段 × 计划) |
模型配置文件
控制每个代理使用的 Claude 模型。平衡质量与 token 支出。
| 配置文件 | 规划 | 执行 | 验证 |
|---|---|---|---|
| quality | Opus | Opus | Sonnet |
| balanced (默认) | Opus | Sonnet | Sonnet |
| budget | Sonnet | Sonnet | Haiku |
切换配置文件:
/gsd/set-profile budget
工作流代理
这些在规划/执行期间启动额外的代理。它们提高质量但增加 token 和时间。
| 设置 | 默认值 | 功能 |
|---|---|---|
| workflow.research | true | 在规划每个阶段之前研究领域 |
| workflow.plan_check | true | 在执行之前验证计划达到阶段目标 |
| workflow.verifier | true | 在执行后确认必须项已交付 |
| workflow.auto_advance | false | 自动链接讨论 → 规划 → 执行而不停止 |
Git 分支
控制 GSD 在执行期间如何处理分支。
| 设置 | 选项 | 默认值 | 功能 |
|---|---|---|---|
| git.branching_strategy | none, phase, milestone | none | 分支创建策略 |
| git.phase_branch_template | string | gsd/phase-{phase}-{slug} | 阶段分支模板 |
| git.milestone_branch_template | string | gsd/{milestone}-{slug} | 里程碑分支模板 |
策略:
none— 提交到当前分支(默认 GSD 行为)phase— 每个阶段创建一个分支,阶段完成时合并milestone— 为整个里程碑创建一个分支,完成时合并
Cursor 版本与主版本的区别
GSD for Cursor 是原始 GSD 的适配版本,主要区别如下:
| 方面 | Claude Code | Cursor |
|---|---|---|
| 命令前缀 | /gsd:command |
/gsd/command |
| 配置目录 | ~/.claude/ |
~/.cursor/ |
| 工具名称 | PascalCase (Read) | snake_case (read) |
| 工具前置 | allowed-tools: [Read, Write] | tools: { read: true, write: true } |
| 颜色 | 名称 (yellow) | Hex (#FFFF00) |
为什么 GSD 有效
上下文工程
Claude Code 非常强大,如果你给它需要的上下文。大多数人没有。
GSD 为你处理:
| 文件 | 功能 |
|---|---|
| PROJECT.md | 项目愿景,始终加载 |
| research/ | 生态系统知识(技术栈、功能、架构、陷阱) |
| REQUIREMENTS.md | 范围的 v1/v2 需求,带阶段可追溯性 |
| ROADMAP.md | 你要去哪里,完成了什么 |
| STATE.md | 决策、阻塞、位置——跨会话的记忆 |
| PLAN.md | 原子任务,XML 结构,验证步骤 |
| SUMMARY.md | 发生了什么,改变了什么,提交到历史 |
| todos/ | 捕获的想法和任务供以后工作 |
XML 提示格式化
每个计划都是针对 Claude 优化的结构化 XML:
<task type="auto">
<name>Create login endpoint</name>
<files>src/app/api/auth/login/route.ts</files>
<action>
Use jose for JWT (not jsonwebtoken - CommonJS issues).
Validate credentials against users table.
Return httpOnly cookie on success.
</action>
<verify>curl -X POST localhost:3000/api/auth/login returns 200 + Set-Cookie</verify>
<done>Valid credentials return cookie, invalid return 401</done>
</task>
精确的指令。没有猜测。内置验证。
多代理编排
每个阶段使用相同的模式:一个薄编排器启动专门的代理,收集结果,并路由到下一步。
| 阶段 | 编排器做什么 | 代理做什么 |
|---|---|---|
| 研究 | 协调,呈现发现 | 4 个并行研究人员调查技术栈、功能、架构、陷阱 |
| 规划 | 验证,管理迭代 | 规划器创建计划,检查器验证,循环直到通过 |
| 执行 | 分组为波,跟踪进度 | 执行器并行实现,每个使用新的 200k 上下文 |
| 验证 | 呈现结果,路由下一步 | 验证器对照目标检查代码库,调试器诊断失败 |
编排器从不做繁重的工作。它启动代理,等待,集成结果。
结果: 你可以运行整个阶段——深度研究、创建和验证多个计划、跨并行执行器编写数千行代码、对照目标自动验证——你的主上下文窗口保持在 30-40%。工作发生在新的子代理上下文中。你的会话保持快速和响应。
原子 Git 提交
每个任务在完成后立即获得自己的提交:
abc123f docs(08-02): complete user registration plan
def456g feat(08-02): add email confirmation flow
hij789k feat(08-02): implement password hashing
lmn012o feat(08-02): create registration endpoint
好处: Git bisect 找到确切的失败任务。每个任务独立可回滚。清晰的 Claude 未来会话历史。AI 自动化工作流中更好的可观察性。
每个提交都是精确的、可追踪的和有意义的。
安全注意事项
保护敏感文件
GSD 的代码库映射和分析命令读取文件以了解你的项目。通过将包含秘密的文件添加到 Cursor 的拒绝列表来保护它们:
- 打开 Cursor 设置(
.cursor/settings.json或全局) - 将敏感文件模式添加到拒绝列表:
{
"permissions": {
"deny": [
"Read(.env)",
"Read(.env.*)",
"Read(**/secrets/*)",
"Read(**/*credential*)",
"Read(**/*.pem)",
"Read(**/*.key)"
]
}
}
这完全阻止 Cursor 读取这些文件,无论你运行什么命令。
故障排除
安装后找不到命令?
- 重启 Cursor 以重新加载命令
- 验证文件存在于
~/.cursor/commands/gsd/(全局)或./.cursor/commands/gsd/(本地)
命令不按预期工作?
- 运行
/gsd/help验证安装 - 重新运行安装脚本重新安装
更新到最新版本?
cd ~/.cursor/gsd-for-cursor
git pull origin main
然后重新运行安装脚本。
使用 Docker 或容器化环境?
如果文件读取失败,使用波浪号路径(~/.cursor/...),在安装前设置 CURSOR_CONFIG_DIR:
CURSOR_CONFIG_DIR=/home/youruser/.cursor ./scripts/install.sh
这确保使用绝对路径而不是 ~,这在容器中可能无法正确展开。
实际应用示例
示例 1:创建新项目
/gsd/new-project
> 我想构建一个任务管理应用
> 使用 React + TypeScript + Node.js
> 需要用户认证、任务 CRUD、实时更新
GSD 会: 1. 提问了解更多细节 2. 研究最佳实践和技术栈 3. 提取需求并创建路线图 4. 等待你的批准
示例 2:执行一个阶段
/gsd/discuss-phase 1
> 选择:视觉功能、API 设计
> 回答关于布局、交互的问题
/gsd/plan-phase 1
> 系统研究并创建计划
/gsd/execute-phase 1
> 系统并行执行计划,创建原子提交
示例 3:快速修复
/gsd/quick
> 修复登录页面的样式问题
GSD 会快速创建计划并执行,跳过研究步骤。
总结
GSD for Cursor 是一个强大的开发工作流系统,通过结构化的流程和上下文工程,解决了 AI 编程中的质量下降问题。它提供了:
- 结构化工作流 - 从项目初始化到完成的完整流程
- 上下文管理 - 自动管理 Claude 需要的上下文
- 多代理编排 - 保持主上下文窗口干净
- 原子提交 - 清晰的 Git 历史
- 灵活配置 - 适应不同的开发需求
关键要点:
1. 使用安装脚本快速安装
2. 先运行 /gsd/map-codebase 如果已有代码
3. 遵循讨论 → 规划 → 执行 → 验证的循环
4. 使用快速模式处理简单任务
5. 配置模型配置文件平衡质量和成本
相关资源: - GSD for Cursor GitHub:https://github.com/rmindel/gsd-for-cursor - GSD 主仓库:https://github.com/gsd-build/get-shit-done - Cursor 官方文档:https://docs.cursor.com
注意:GSD 是一个活跃开发的项目,功能和 API 可能会随时间变化。建议关注项目更新日志以了解最新变化。