write-cursor-command

编写 Cursor Command

根据用户描述的需求，编写符合 Cursor 官方格式的 slash command，并保存到 .cursor/commands/。

Cursor Command 官方格式（必须遵守）

• 文件格式：纯 Markdown，禁止 YAML frontmatter（与 Rules/Skills 不同）。
• 存放位置：
  • 项目命令：.cursor/commands/（项目根目录下）
  • 全局命令：~/.cursor/commands/（用户主目录）
• 文件名：使用 kebab-case，即小写字母与连字符，扩展名 .md。文件名即命令名，输入 /文件名 触发（如 update-readme.md → /update-readme）。
• 内容：用 Markdown 描述「当用户执行该命令时，AI 应该做什么」。用户输入 /命令名 后面的文字 会一并作为上下文传给模型。

参考：Cursor Docs - Commands

编写流程

1. 理解需求

• 用户希望执行 /xxx 时完成什么？（例如：更新某文档、跑测试、生成某类代码）
• 有无环境约束？（如 Windows/PowerShell、虚拟环境、编码）
• 有无项目规范要引用？（如 AGENTS.md、.cursor/rules）

2. 确定命令名与路径

• 根据用途起一个简短的 kebab-case 名称（如 update-readme、run-tests、add-mcp-tool）。
• 默认写入项目：.cursor/commands/<命令名>.md。若用户明确要全局命令，则使用 ~/.cursor/commands/<命令名>.md。

3. 撰写 Markdown 内容

按下面结构组织（可依需求增删小节）：

1. 标题（可选）
   一行 # 中文名 (English Name)，便于识别。

2. Overview
   2～3 句话说明：该命令做什么、在什么场景下用。

3. 执行步骤 / Steps
   分步骤写清「AI 执行此命令时应做的具体动作」。

   • 若有先后顺序，用 1、2、3…
   • 若有子项，用缩进列表或 加粗 小标题。

4. 环境约束（若需要）
   如 Shell（PowerShell）、编码（UTF-8）、Python 虚拟环境路径等。

5. 注意事项 / 模板（若需要）
   固定格式、代码块模板、不要改动的部分等。

6. Checklist
   用 - [ ] 列出执行完命令后应自检的项，便于用户或 AI 核对。

4. 保存与确认

• 保存到 .cursor/commands/<命令名>.md。
• 确认：无 frontmatter、文件名 kebab-case、内容为纯 Markdown。

内容模板（可直接套用）

# 命令中文名 (Command Name)

## Overview
简要说明该命令的用途和适用场景（2～3 句）。

## 执行步骤

1. **第一步**
   - 子步骤或说明

2. **第二步**
   - 子步骤或说明

3. **第三步**
   - 子步骤或说明

## 注意事项（可选）
- 需要遵守的约定或不要改动的部分

## Checklist
- [ ] 检查项 1
- [ ] 检查项 2

本项目中已有命令可作参考

• explain.md：解释/说明类命令（可按实际内容补充）。
• lint-and-format.md：代码检查与格式化（ruff、black 等）。
• publish-to-pypi.md：打包并发布到 TestPyPI 或正式 PyPI（前置检查、构建、twine 上传、错误处理）。
• update-changelog.md：更新 CHANGELOG.md。
• update-history.md：将当前对话中的用户指令追加到 HISTORY.md。
• update-readme.md：按项目状态更新 README（版本、工具列表、结构、文档链接）。

写作时可参考其「目标/Overview + 步骤 + 环境约束 + 错误处理 + Checklist」的写法，保持风格一致。新增命令后建议同步更新本列表。