name: generate_command description: 遵循约定和最佳实践创建新的自定义斜杠命令 argument-hint: “[命令目的和要求]”
创建自定义 Claude 代码命令
在 .claude/commands/ 中创建一个新的斜杠命令,用于请求的任务。
目标
#$ARGUMENTS
关键能力利用
文件操作:
- 读取、编辑、写入 - 精确修改文件
- 全局搜索、Grep - 搜索代码库
- 多编辑 - 原子性多部分更改
开发:
- Bash - 运行命令(git、测试、linter)
- Task - 启动专业代理处理复杂任务
- TodoWrite - 用待办事项列表跟踪进度
Web 与 APIs:
- WebFetch、WebSearch - 研究文档
- GitHub(gh cli)- PRs、issues、评论
- Playwright - 浏览器自动化、截图
集成:
- AppSignal - 日志和监控
- Context7 - 框架文档
- Stripe、Todoist、Featurebase(如相关)
最佳实践
- 具体和清晰 - 详细指令产生更好结果
- 分解复杂任务 - 使用分步计划
- 使用示例 - 参考现有代码模式
- 包含成功标准 - 测试通过、代码整洁等
- 先思考 - 对复杂问题使用“think hard”或“plan”关键词
- 迭代 - 逐步指导过程
必需:YAML 前端
每个命令必须从 YAML 前端开始:
---
name: command-name
description: 简要描述此命令的功能(最多 100 字符)
argument-hint: "[命令接受的参数]"
---
字段:
name: 小写命令标识符(内部使用)description: 清晰、简洁的命令目的摘要argument-hint: 显示用户期望的参数(例如[文件路径]、[PR 编号]、[可选:格式])
结构化您的命令
# [命令名称]
[此命令功能的简要描述]
## 步骤
1. [第一步具体细节]
- 包含文件路径、模式或约束
- 如适用参考现有代码
2. [第二步]
- 尽可能使用并行工具调用
- 检查/验证结果
3. [最终步骤]
- 运行测试
- 代码检查
- 提交更改(如适当)
## 成功标准
- [ ] 预期结果 1
- [ ] 预期结果 2
有效命令提示
- 使用 $ARGUMENTS 占位符 用于动态输入
- 参考 CLAUDE.md 模式和约定
- 包含验证步骤 - 测试、代码检查、视觉检查
- 明确约束 - 不要修改 X,使用模式 Y
- 使用 XML 标签 用于结构化提示:
<task>、<requirements>、<constraints>
示例模式
按照以下步骤实现 #$ARGUMENTS:
1. 研究现有模式
- 使用 Grep 搜索类似代码
- 阅读相关文件以理解方法
2. 计划实现
- 思考边界情况和要求
- 考虑所需的测试案例
3. 实现
- 遵循现有代码模式(参考特定文件)
- 如果使用 TDD,先写测试
- 确保代码遵循 CLAUDE.md 约定
4. 验证
- 运行测试:`bin/rails test`
- 运行代码检查:`bundle exec standardrb`
- 使用 git diff 检查更改
5. 提交(可选)
- 暂存更改
- 写清晰提交信息
创建命令文件
- 创建文件 在
.claude/commands/[name].md(支持子目录如workflows/) - 从 YAML 前端开始(见上文)
- 结构化命令 使用上述模板
- 测试命令 使用适当参数
命令文件模板
---
name: command-name
description: 此命令的功能
argument-hint: "[期望参数]"
---
# 命令标题
简要介绍此命令的功能和使用时机。
## 工作流
### 步骤 1: [第一步]
详细说明要做什么。
### 步骤 2: [第二步]
详细说明要做什么。
## 成功标准
- [ ] 预期结果 1
- [ ] 预期结果 2