85 lines
1.8 KiB
Markdown
85 lines
1.8 KiB
Markdown
# sc-create-command: Guide for creating new custom Claude commands with proper structure.
|
|
|
|
## Process:
|
|
|
|
### 1. Understanding Purpose
|
|
|
|
- What problem does this command solve?
|
|
- Who will use this command?
|
|
- What is the expected output?
|
|
- How will users interact with it?
|
|
|
|
### 2. Category Classification
|
|
|
|
Determine command type:
|
|
|
|
- **Planning**: Project setup, architecture decisions
|
|
- **Implementation**: Code generation, feature development
|
|
- **Analysis**: Code review, performance analysis
|
|
- **Testing**: Test creation, validation
|
|
- **Documentation**: Docs generation, updates
|
|
- **Workflow**: Multi-step processes
|
|
- **Utility**: Helper commands, tools
|
|
|
|
### 3. Pattern Selection
|
|
|
|
Study similar existing commands:
|
|
|
|
- Analyze structure and flow
|
|
- Note common patterns
|
|
- Identify reusable components
|
|
- Follow established conventions
|
|
|
|
### 4. Command Location
|
|
|
|
Choose appropriate location:
|
|
|
|
- **Project-specific**: `.claude/commands/`
|
|
- **User-level**: `~/.claude/commands/`
|
|
- Consider reusability and context
|
|
|
|
### 5. Command Structure
|
|
|
|
Create with these sections:
|
|
|
|
- **Title**: Clear, action-oriented name
|
|
- **Description**: One-line summary
|
|
- **Usage**: How to invoke with parameters
|
|
- **Process**: Step-by-step instructions
|
|
- **Output**: Expected results
|
|
- **Notes**: Special considerations
|
|
|
|
## Template:
|
|
|
|
For SimpleClaude commands look at @templates/sc-command-template.md, or use this basic markdown template:
|
|
|
|
```markdown
|
|
# Command Name
|
|
|
|
Brief description of what this command does.
|
|
|
|
## Usage:
|
|
|
|
`/command-name [arguments]`
|
|
|
|
## Process:
|
|
|
|
1. First step
|
|
2. Second step
|
|
3. Third step
|
|
|
|
## Notes:
|
|
|
|
- Important considerations
|
|
- Limitations
|
|
```
|
|
|
|
## Best Practices:
|
|
|
|
- Keep commands focused and single-purpose
|
|
- Include parameter validation
|
|
- Provide helpful error messages
|
|
- Document expected inputs/outputs
|
|
- Consider edge cases
|
|
- Test thoroughly before finalizing
|