Skip to content

k8scat/cursor-commands

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Cursor 命令集合

Cursor 官方推荐

这是一个精心策划的 Cursor 斜杠命令提示词集合,可为您的团队提供可重用、版本控制的 AI 工作流,直接集成在 Cursor IDE 中。

🔗 另请查看 Cursor Hooks - 在每次文件编辑后运行

什么是 Cursor 命令?

Cursor 命令是保存为 Markdown 文件的可重用 AI 提示词,存储在 .cursor/commands/ 目录中。当您在 Cursor 的聊天输入框中输入 / 时,IDE 会列出项目和全局库中的所有命令,让您可以立即插入提示词。它们就像 AI 驱动的快捷方式,可自动化重复任务、强化团队标准并保持反馈一致性。

功能特性

  • 🚀 快速访问:输入 / 即可显示所有命令,无需离开工作流
  • 🔄 可重用:为整个团队的常见任务标准化提示词
  • 👥 可共享:将命令存储在 git 中,随仓库一起分发
  • 🎯 专注:每个命令都针对特定工作流,结构清晰
  • 📝 可自定义:编辑或扩展 Markdown 文件以匹配您的流程

命令的工作原理

命令可以存放在两个位置:

  • 项目命令:在仓库内的 .cursor/commands 目录中存储 Markdown 文件
  • 全局命令:在机器上的 ~/.cursor/commands 目录中存储个人命令

当您输入 / 时,Cursor 会自动扫描这两个目录,合并结果,并将选定的命令插入聊天框以准备运行。

如何使用

  1. 在 Cursor 的 AI 聊天或代理输入框中输入 /
  2. 从可用命令中选择
  3. 让 AI 使用相关项目上下文执行提示词

创建命令

  • 在项目根目录创建 .cursor/commands 目录
  • 添加具有描述性名称的 .md 文件(例如 code-review.mdrun-all-tests-and-fix.md
  • 编写清晰的 Markdown 指令,描述命令应该完成什么
  • 打开 Cursor,输入 /,选择您的新命令立即执行

示例结构:

.cursor/
└── commands/
    ├── accessibility-audit.md
    ├── add-documentation.md
    ├── add-error-handling.md
    ├── address-github-pr-comments.md
    ├── code-review.md
    ├── create-pr.md
    ├── database-migration.md
    ├── debug-issue.md
    ├── fix-compile-errors.md
    ├── fix-git-issues.md
    ├── generate-api-docs.md
    ├── generate-pr-description.md
    ├── light-review-existing-diffs.md
    ├── lint-fix.md
    ├── lint-suite.md
    ├── onboard-new-developer.md
    ├── optimize-performance.md
    ├── refactor-code.md
    ├── run-all-tests-and-fix.md
    ├── security-audit.md
    ├── security-review.md
    ├── setup-new-feature.md
    └── write-unit-tests.md

可用命令

代码质量与维护

  • lint-fix.md – 自动分析并修复当前文件中的代码规范问题
  • lint-suite.md – 运行项目代码检查工具,应用修复,确保代码库符合格式要求
  • refactor-code.md – 在保持功能的同时提升代码质量
  • optimize-performance.md – 分析并优化代码性能
  • add-error-handling.md – 在变更集中实现全面的错误处理

审查与协作

  • code-review.md – 包含结构化步骤和重点领域的全面审查清单
  • address-github-pr-comments.md – 处理审查者反馈并撰写周到的回复
  • light-review-existing-diffs.md – 快速检查以突出显示有风险的差异和清理项
  • create-pr.md – 准备结构良好的拉取请求及验证清单
  • generate-pr-description.md – 自动起草详细的拉取请求描述

测试与可靠性

  • run-all-tests-and-fix.md – 执行完整测试套件,分类失败并确认修复
  • write-unit-tests.md – 生成具有适当覆盖率的专注单元测试
  • debug-issue.md – 用于隔离缺陷的逐步调试工作流
  • fix-compile-errors.md – 快速诊断并解决编译失败

文档与入职

  • add-documentation.md – 捕获全面的产品或代码文档
  • generate-api-docs.md – 生成包含模式和示例的丰富 API 文档
  • onboard-new-developer.md – 新团队成员的清单驱动入职流程
  • setup-new-feature.md – 规划新工作的需求、分支和架构

安全、无障碍与基础设施

  • security-audit.md – 代码变更的结构化安全清单
  • security-review.md – 更广泛的漏洞和风险评估工作流
  • accessibility-audit.md – 审查 WCAG 合规性问题
  • database-migration.md – 规划、创建和验证带有回滚的数据库迁移
  • fix-git-issues.md – 安全解决合并冲突和仓库问题

快速开始

  1. 克隆此仓库或将 .cursor/commands/ 目录复制到您的项目中
  2. 在 Cursor IDE 中打开项目
  3. 在 AI 聊天中输入 / 浏览可用命令
  4. 选择一个命令,让 Cursor 使用您的代码上下文执行提示词

安装选项

# 选项 1:克隆仓库
git clone https://github.com/k8scat/cursor-commands.git
cd cursor-commands
# 选项 2:将命令复制到现有项目
cp -r cursor-commands/.cursor /path/to/your/project/

或者,手动创建目录:

  1. 在项目根目录创建 .cursor/commands/
  2. 复制或创作您需要的 Markdown 命令文件

编写自己的命令

使用现有文件作为模板或从头开始:

touch .cursor/commands/my-custom-command.md
# 我的自定义命令

此命令功能的简要描述。

## 目标
任务和预期结果的详细说明。

## 要求
- 具体要求或约束
- 要遵循的编码标准
- 预期格式或结构

## 输出
AI 应该生成的内容描述。

为 AI 提供清晰的遵循指令。

示例提示词

# 生成 API 文档

为当前代码创建全面的 API 文档。包括:

- 端点描述和 HTTP 方法
- 带示例的请求/响应模式
- 身份验证要求
- 错误代码和响应
- 速率限制信息

格式为 OpenAPI/Swagger 规范。
# 安全审计

对当前代码执行安全审计。检查:

- SQL 注入漏洞
- XSS 攻击向量
- 身份验证和授权问题
- 输入验证问题
- 敏感数据暴露

为发现的每个问题提供具体的修复步骤。

最佳实践

  • 具体明确:描述预期结果和验收标准
  • 提供上下文:引用项目约定、架构或标准
  • 设定边界:明确范围、假设和工具限制
  • 包含示例:在有帮助时展示预期格式或响应
  • 保持专注:使每个命令针对单一、清晰的目标
  • 一起审查:像对待代码变更一样在 PR 中审查命令变更
  • 使用描述性名称:使文件名反映命令的目的

参考资料

支持

  • 打开 issue 提供反馈或请求
  • 参考此 README 了解与提示词一起提供的命令索引

许可证

本项目是开源的,采用 MIT 许可证

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •