mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
- Restructured core framework components - Added new Agents, MCP servers, and Modes documentation - Introduced SuperClaude-Lite minimal implementation - Enhanced Commands with session management capabilities - Added comprehensive Hooks system with Python integration - Removed legacy setup and profile components - Updated .gitignore to exclude Tests/, ClaudeDocs/, and .serena/ - Consolidated configuration into SuperClaude/Config/ - Added Templates for consistent component creation This is the initial commit for the V4 Beta branch containing all recent framework improvements and architectural changes. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
6.3 KiB
6.3 KiB
| name | description | allowed-tools | category | complexity | scope | mcp-integration | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
[Clear, concise description for help systems and auto-activation patterns] |
|
utility | basic |
|
|
/sc:[command-name] - [Command Title]
Purpose
[Clear statement of what this command does and when to use it. Focus on the primary goal and value proposition.]
Usage
/sc:[command-name] [arguments] [--flag1] [--flag2]
Arguments
argument1- Description of the argument and its purposeargument2- Description of the argument and its purpose--flag1- Description of the flag and its impact--flag2- Description of the flag and its impact
Execution
- [First step - what the command does initially]
- [Second step - core processing or analysis]
- [Third step - main operation or transformation]
- [Fourth step - validation or output generation]
- [Fifth step - final results and feedback]
Claude Code Integration
- Tool Usage: [Describe how the command uses its allowed tools]
- File Operations: [Explain file reading, writing, or manipulation patterns]
- Analysis Approach: [Detail how the command analyzes or processes input]
- Output Format: [Describe the expected output and formatting]
Performance Targets
- Execution Time: <5s for typical operations
- Success Rate: >95% for well-formed inputs
- Error Handling: Clear feedback for common failure modes
Examples
Basic Usage
/sc:[command-name] [simple-example]
# Expected outcome description
Advanced Usage
/sc:[command-name] [complex-example] --flag1 --flag2
# Expected outcome description
Error Handling
- Invalid Input: [How the command handles bad input]
- Missing Dependencies: [What happens when prerequisites are missing]
- File Access Issues: [How file permission or access problems are handled]
- Resource Constraints: [Behavior under resource limitations]
Integration Points
- SuperClaude Framework: [How this command fits into the broader framework]
- Other Commands: [Commands that commonly precede or follow this one]
- File System: [File system interactions and expectations]
Boundaries
This command will:
- [Specific capability 1]
- [Specific capability 2]
- [Specific capability 3]
This command will not:
- [Specific limitation 1]
- [Specific limitation 2]
- [Specific limitation 3]
Template Usage Guidelines
Quick Start
- Copy this template to
SuperClaude/Commands/[command-name].md - Fill in the frontmatter with appropriate values
- Replace all placeholder text with command-specific content
- Test the command with various inputs
- Validate integration with Claude Code
Tool Selection Guidelines
Basic commands should use minimal, focused tool sets:
- Read: For analyzing input files and configuration
- Bash: For executing system commands and operations
- Grep: For pattern matching and text search
- Glob: For file discovery and path matching
- Write: For generating output files when needed
Section Guidelines
Purpose Section
- Single paragraph explaining the command's primary function
- Focus on when and why a user would invoke this command
- Avoid technical implementation details
Usage Section
- Clear command syntax with argument placeholders
- Use consistent formatting for optional arguments
- Include common flag combinations
Execution Section
- 5 numbered steps describing the command's workflow
- Focus on what happens, not how it's implemented
- Use action-oriented language
Claude Code Integration Section
- Explain how the command leverages its allowed tools
- Detail file system interactions
- Describe error handling approach
- Mention any special integration patterns
Examples Section
- Provide at least 2 realistic examples
- Show both simple and complex usage patterns
- Include expected outcomes for each example
Quality Standards
Consistency Requirements
- All sections must be present and properly formatted
- Frontmatter must include all required fields
- Tool usage must align with allowed-tools list
- Examples must be realistic and testable
Content Standards
- Clear, concise language appropriate for developers
- Technical accuracy in all descriptions
- Consistent terminology throughout
- Proper markdown formatting
Integration Standards
- Must work within Claude Code environment
- Should integrate cleanly with other SuperClaude commands
- Must handle errors gracefully
- Should provide clear user feedback
Common Patterns
File Processing Commands
typical_tools: [Read, Grep, Glob, Write]
typical_flow:
1. Discover/validate input files
2. Analyze file content or structure
3. Process according to command logic
4. Generate output or modify files
5. Report results and next steps
Analysis Commands
typical_tools: [Read, Grep, Glob, Bash]
typical_flow:
1. Parse target and scope
2. Collect relevant data
3. Apply analysis techniques
4. Generate findings with severity
5. Present recommendations
System Operation Commands
typical_tools: [Bash, Read, Write]
typical_flow:
1. Validate system state
2. Execute system operations
3. Monitor execution results
4. Handle errors and edge cases
5. Report completion status
Testing Guidelines
Validation Checklist
- Command syntax is properly documented
- All arguments and flags are explained
- Examples work as described
- Error cases are handled gracefully
- Tool usage aligns with allowed-tools
- Integration points are documented
- Performance expectations are realistic
Common Test Cases
- Valid input with expected output
- Invalid input with appropriate error messages
- Edge cases (empty files, large inputs, etc.)
- Missing dependencies or permissions
- Integration with other SuperClaude commands
This template is designed for basic utility commands that perform focused operations with minimal complexity. For more sophisticated commands requiring MCP integration or advanced orchestration, use the appropriate higher-tier templates.