superclaude-kiro 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +190 -0
  3. package/bin/superclaude-kiro.js +38 -0
  4. package/dist/agents/sc-analyze.json +18 -0
  5. package/dist/agents/sc-implement.json +18 -0
  6. package/dist/agents/sc-pm.json +18 -0
  7. package/dist/agents/superclaude.json +18 -0
  8. package/dist/mcp/mcp-servers.json +44 -0
  9. package/dist/steering/superclaude/sc-agent.md +80 -0
  10. package/dist/steering/superclaude/sc-analyze.md +89 -0
  11. package/dist/steering/superclaude/sc-brainstorm.md +100 -0
  12. package/dist/steering/superclaude/sc-build.md +94 -0
  13. package/dist/steering/superclaude/sc-business-panel.md +90 -0
  14. package/dist/steering/superclaude/sc-cleanup.md +93 -0
  15. package/dist/steering/superclaude/sc-design.md +88 -0
  16. package/dist/steering/superclaude/sc-document.md +88 -0
  17. package/dist/steering/superclaude/sc-estimate.md +86 -0
  18. package/dist/steering/superclaude/sc-explain.md +92 -0
  19. package/dist/steering/superclaude/sc-git.md +80 -0
  20. package/dist/steering/superclaude/sc-help.md +148 -0
  21. package/dist/steering/superclaude/sc-implement.md +97 -0
  22. package/dist/steering/superclaude/sc-improve.md +93 -0
  23. package/dist/steering/superclaude/sc-index-repo.md +169 -0
  24. package/dist/steering/superclaude/sc-index.md +86 -0
  25. package/dist/steering/superclaude/sc-load.md +93 -0
  26. package/dist/steering/superclaude/sc-pm.md +592 -0
  27. package/dist/steering/superclaude/sc-recommend.md +1008 -0
  28. package/dist/steering/superclaude/sc-reflect.md +87 -0
  29. package/dist/steering/superclaude/sc-research.md +103 -0
  30. package/dist/steering/superclaude/sc-save.md +93 -0
  31. package/dist/steering/superclaude/sc-sc.md +134 -0
  32. package/dist/steering/superclaude/sc-select-tool.md +86 -0
  33. package/dist/steering/superclaude/sc-spawn.md +85 -0
  34. package/dist/steering/superclaude/sc-spec-panel.md +428 -0
  35. package/dist/steering/superclaude/sc-task.md +89 -0
  36. package/dist/steering/superclaude/sc-test.md +93 -0
  37. package/dist/steering/superclaude/sc-troubleshoot.md +88 -0
  38. package/dist/steering/superclaude/sc-workflow.md +97 -0
  39. package/package.json +52 -0
  40. package/src/cli.js +23 -0
  41. package/src/converter.js +63 -0
  42. package/src/installer.js +319 -0
  43. package/src/utils.js +105 -0
  44. package/templates/cli-settings.json +7 -0
@@ -0,0 +1,80 @@
1
+ ---
2
+ inclusion: manual
3
+ ---
4
+
5
+ # SuperClaude: git
6
+
7
+ > Converted from Claude Code SuperClaude framework
8
+ > Original: ~/.claude/commands/sc/git.md
9
+
10
+ # /sc:git - Git Operations
11
+
12
+ ## Triggers
13
+ - Git repository operations: status, add, commit, push, pull, branch
14
+ - Need for intelligent commit message generation
15
+ - Repository workflow optimization requests
16
+ - Branch management and merge operations
17
+
18
+ ## Usage
19
+ ```
20
+ /sc:git [operation] [args] [--smart-commit] [--interactive]
21
+ ```
22
+
23
+ ## Behavioral Flow
24
+ 1. **Analyze**: Check repository state and working directory changes
25
+ 2. **Validate**: Ensure operation is appropriate for current Git context
26
+ 3. **Execute**: Run Git command with intelligent automation
27
+ 4. **Optimize**: Apply smart commit messages and workflow patterns
28
+ 5. **Report**: Provide status and next steps guidance
29
+
30
+ Key behaviors:
31
+ - Generate conventional commit messages based on change analysis
32
+ - Apply consistent branch naming conventions
33
+ - Handle merge conflicts with guided resolution
34
+ - Provide clear status summaries and workflow recommendations
35
+
36
+ ## Tool Coordination
37
+ - **Bash**: Git command execution and repository operations
38
+ - **Read**: Repository state analysis and configuration review
39
+ - **Grep**: Log parsing and status analysis
40
+ - **Write**: Commit message generation and documentation
41
+
42
+ ## Key Patterns
43
+ - **Smart Commits**: Analyze changes → generate conventional commit message
44
+ - **Status Analysis**: Repository state → actionable recommendations
45
+ - **Branch Strategy**: Consistent naming and workflow enforcement
46
+ - **Error Recovery**: Conflict resolution and state restoration guidance
47
+
48
+ ## Examples
49
+
50
+ ### Smart Status Analysis
51
+ ```
52
+ /sc:git status
53
+ # Analyzes repository state with change summary
54
+ # Provides next steps and workflow recommendations
55
+ ```
56
+
57
+ ### Intelligent Commit
58
+ ```
59
+ /sc:git commit --smart-commit
60
+ # Generates conventional commit message from change analysis
61
+ # Applies best practices and consistent formatting
62
+ ```
63
+
64
+ ### Interactive Operations
65
+ ```
66
+ /sc:git merge feature-branch --interactive
67
+ # Guided merge with conflict resolution assistance
68
+ ```
69
+
70
+ ## Boundaries
71
+
72
+ **Will:**
73
+ - Execute Git operations with intelligent automation
74
+ - Generate conventional commit messages from change analysis
75
+ - Provide workflow optimization and best practice guidance
76
+
77
+ **Will Not:**
78
+ - Modify repository configuration without explicit authorization
79
+ - Execute destructive operations without confirmation
80
+ - Handle complex merges requiring manual intervention
@@ -0,0 +1,148 @@
1
+ ---
2
+ inclusion: manual
3
+ ---
4
+
5
+ # SuperClaude: help
6
+
7
+ > Converted from Claude Code SuperClaude framework
8
+ > Original: ~/.claude/commands/sc/help.md
9
+
10
+ # /sc:help - Command Reference Documentation
11
+
12
+ ## Triggers
13
+ - Command discovery and reference lookup requests
14
+ - Framework exploration and capability understanding needs
15
+ - Documentation requests for available SuperClaude commands
16
+
17
+ ## Behavioral Flow
18
+ 1. **Display**: Present complete command list with descriptions
19
+ 2. **Complete**: End interaction after displaying information
20
+
21
+ Key behaviors:
22
+ - Information display only - no execution or implementation
23
+ - Reference documentation mode without action triggers
24
+
25
+ Here is a complete list of all available SuperClaude (`/sc`) commands.
26
+
27
+ | Command | Description |
28
+ |---|---|
29
+ | `/sc:analyze` | Comprehensive code analysis across quality, security, performance, and architecture domains |
30
+ | `/sc:brainstorm` | Interactive requirements discovery through Socratic dialogue and systematic exploration |
31
+ | `/sc:build` | Build, compile, and package projects with intelligent error handling and optimization |
32
+ | `/sc:business-panel` | Multi-expert business analysis with adaptive interaction modes |
33
+ | `/sc:cleanup` | Systematically clean up code, remove dead code, and optimize project structure |
34
+ | `/sc:design` | Design system architecture, APIs, and component interfaces with comprehensive specifications |
35
+ | `/sc:document` | Generate focused documentation for components, functions, APIs, and features |
36
+ | `/sc:estimate` | Provide development estimates for tasks, features, or projects with intelligent analysis |
37
+ | `/sc:explain` | Provide clear explanations of code, concepts, and system behavior with educational clarity |
38
+ | `/sc:git` | Git operations with intelligent commit messages and workflow optimization |
39
+ | `/sc:help` | List all available /sc commands and their functionality |
40
+ | `/sc:implement` | Feature and code implementation with intelligent persona activation and MCP integration |
41
+ | `/sc:improve` | Apply systematic improvements to code quality, performance, and maintainability |
42
+ | `/sc:index` | Generate comprehensive project documentation and knowledge base with intelligent organization |
43
+ | `/sc:load` | Session lifecycle management with Serena MCP integration for project context loading |
44
+ | `/sc:reflect` | Task reflection and validation using Serena MCP analysis capabilities |
45
+ | `/sc:save` | Session lifecycle management with Serena MCP integration for session context persistence |
46
+ | `/sc:select-tool` | Intelligent MCP tool selection based on complexity scoring and operation analysis |
47
+ | `/sc:spawn` | Meta-system task orchestration with intelligent breakdown and delegation |
48
+ | `/sc:spec-panel` | Multi-expert specification review and improvement using renowned specification and software engineering experts |
49
+ | `/sc:task` | Execute complex tasks with intelligent workflow management and delegation |
50
+ | `/sc:test` | Execute tests with coverage analysis and automated quality reporting |
51
+ | `/sc:troubleshoot` | Diagnose and resolve issues in code, builds, deployments, and system behavior |
52
+ | `/sc:workflow` | Generate structured implementation workflows from PRDs and feature requirements |
53
+
54
+ ## SuperClaude Framework Flags
55
+
56
+ SuperClaude supports behavioral flags to enable specific execution modes and tool selection patterns. Use these flags with any `/sc` command to customize behavior.
57
+
58
+ ### Mode Activation Flags
59
+
60
+ | Flag | Trigger | Behavior |
61
+ |------|---------|----------|
62
+ | `--brainstorm` | Vague project requests, exploration keywords | Activate collaborative discovery mindset, ask probing questions |
63
+ | `--introspect` | Self-analysis requests, error recovery | Expose thinking process with transparency markers |
64
+ | `--task-manage` | Multi-step operations (>3 steps) | Orchestrate through delegation, systematic organization |
65
+ | `--orchestrate` | Multi-tool operations, parallel execution | Optimize tool selection matrix, enable parallel thinking |
66
+ | `--token-efficient` | Context usage >75%, large-scale operations | Symbol-enhanced communication, 30-50% token reduction |
67
+
68
+ ### MCP Server Flags
69
+
70
+ | Flag | Trigger | Behavior |
71
+ |------|---------|----------|
72
+ | `--c7` / `--context7` | Library imports, framework questions | Enable Context7 for curated documentation lookup |
73
+ | `--seq` / `--sequential` | Complex debugging, system design | Enable Sequential for structured multi-step reasoning |
74
+ | `--magic` | UI component requests (/ui, /21) | Enable Magic for modern UI generation from 21st.dev |
75
+ | `--morph` / `--morphllm` | Bulk code transformations | Enable Morphllm for efficient multi-file pattern application |
76
+ | `--serena` | Symbol operations, project memory | Enable Serena for semantic understanding and session persistence |
77
+ | `--play` / `--playwright` | Browser testing, E2E scenarios | Enable Playwright for real browser automation and testing |
78
+ | `--all-mcp` | Maximum complexity scenarios | Enable all MCP servers for comprehensive capability |
79
+ | `--no-mcp` | Native-only execution needs | Disable all MCP servers, use native tools |
80
+
81
+ ### Analysis Depth Flags
82
+
83
+ | Flag | Trigger | Behavior |
84
+ |------|---------|----------|
85
+ | `--think` | Multi-component analysis needs | Standard structured analysis (~4K tokens), enables Sequential |
86
+ | `--think-hard` | Architectural analysis, system-wide dependencies | Deep analysis (~10K tokens), enables Sequential + Context7 |
87
+ | `--ultrathink` | Critical system redesign, legacy modernization | Maximum depth analysis (~32K tokens), enables all MCP servers |
88
+
89
+ ### Execution Control Flags
90
+
91
+ | Flag | Trigger | Behavior |
92
+ |------|---------|----------|
93
+ | `--delegate [auto\|files\|folders]` | >7 directories OR >50 files | Enable sub-agent parallel processing with intelligent routing |
94
+ | `--concurrency [n]` | Resource optimization needs | Control max concurrent operations (range: 1-15) |
95
+ | `--loop` | Improvement keywords (polish, refine, enhance) | Enable iterative improvement cycles with validation gates |
96
+ | `--iterations [n]` | Specific improvement cycle requirements | Set improvement cycle count (range: 1-10) |
97
+ | `--validate` | Risk score >0.7, resource usage >75% | Pre-execution risk assessment and validation gates |
98
+ | `--safe-mode` | Resource usage >85%, production environment | Maximum validation, conservative execution |
99
+
100
+ ### Output Optimization Flags
101
+
102
+ | Flag | Trigger | Behavior |
103
+ |------|---------|----------|
104
+ | `--uc` / `--ultracompressed` | Context pressure, efficiency requirements | Symbol communication system, 30-50% token reduction |
105
+ | `--scope [file\|module\|project\|system]` | Analysis boundary needs | Define operational scope and analysis depth |
106
+ | `--focus [performance\|security\|quality\|architecture\|accessibility\|testing]` | Domain-specific optimization | Target specific analysis domain and expertise application |
107
+
108
+ ### Flag Priority Rules
109
+
110
+ - **Safety First**: `--safe-mode` > `--validate` > optimization flags
111
+ - **Explicit Override**: User flags > auto-detection
112
+ - **Depth Hierarchy**: `--ultrathink` > `--think-hard` > `--think`
113
+ - **MCP Control**: `--no-mcp` overrides all individual MCP flags
114
+ - **Scope Precedence**: system > project > module > file
115
+
116
+ ### Usage Examples
117
+
118
+ ```bash
119
+ # Deep analysis with Context7 enabled
120
+ /sc:analyze --think-hard --context7 src/
121
+
122
+ # UI development with Magic and validation
123
+ /sc:implement --magic --validate "Add user dashboard"
124
+
125
+ # Token-efficient task management
126
+ /sc:task --token-efficient --delegate auto "Refactor authentication system"
127
+
128
+ # Safe production deployment
129
+ /sc:build --safe-mode --validate --focus security
130
+ ```
131
+
132
+ ## Boundaries
133
+
134
+ **Will:**
135
+ - Display comprehensive list of available SuperClaude commands
136
+ - Provide clear descriptions of each command's functionality
137
+ - Present information in readable tabular format
138
+ - Show all available SuperClaude framework flags and their usage
139
+ - Provide flag usage examples and priority rules
140
+
141
+ **Will Not:**
142
+ - Execute any commands or create any files
143
+ - Activate implementation modes or start projects
144
+ - Engage TodoWrite or any execution tools
145
+
146
+ ---
147
+
148
+ **Note:** This list is manually generated and may become outdated. If you suspect it is inaccurate, please consider regenerating it or contacting a maintainer.
@@ -0,0 +1,97 @@
1
+ ---
2
+ inclusion: manual
3
+ ---
4
+
5
+ # SuperClaude: implement
6
+
7
+ > Converted from Claude Code SuperClaude framework
8
+ > Original: ~/.claude/commands/sc/implement.md
9
+
10
+ # /sc:implement - Feature Implementation
11
+
12
+ > **Context Framework Note**: This behavioral instruction activates when Claude Code users type `/sc:implement` patterns. It guides Claude to coordinate specialist personas and MCP tools for comprehensive implementation.
13
+
14
+ ## Triggers
15
+ - Feature development requests for components, APIs, or complete functionality
16
+ - Code implementation needs with framework-specific requirements
17
+ - Multi-domain development requiring coordinated expertise
18
+ - Implementation projects requiring testing and validation integration
19
+
20
+ ## Context Trigger Pattern
21
+ ```
22
+ /sc:implement [feature-description] [--type component|api|service|feature] [--framework react|vue|express] [--safe] [--with-tests]
23
+ ```
24
+ **Usage**: Type this in Claude Code conversation to activate implementation behavioral mode with coordinated expertise and systematic development approach.
25
+
26
+ ## Behavioral Flow
27
+ 1. **Analyze**: Examine implementation requirements and detect technology context
28
+ 2. **Plan**: Choose approach and activate relevant personas for domain expertise
29
+ 3. **Generate**: Create implementation code with framework-specific best practices
30
+ 4. **Validate**: Apply security and quality validation throughout development
31
+ 5. **Integrate**: Update documentation and provide testing recommendations
32
+
33
+ Key behaviors:
34
+ - Context-based persona activation (architect, frontend, backend, security, qa)
35
+ - Framework-specific implementation via Context7 and Magic MCP integration
36
+ - Systematic multi-component coordination via Sequential MCP
37
+ - Comprehensive testing integration with Playwright for validation
38
+
39
+ ## MCP Integration
40
+ - **Context7 MCP**: Framework patterns and official documentation for React, Vue, Angular, Express
41
+ - **Magic MCP**: Auto-activated for UI component generation and design system integration
42
+ - **Sequential MCP**: Complex multi-step analysis and implementation planning
43
+ - **Playwright MCP**: Testing validation and quality assurance integration
44
+
45
+ ## Tool Coordination
46
+ - **Write/Edit/MultiEdit**: Code generation and modification for implementation
47
+ - **Read/Grep/Glob**: Project analysis and pattern detection for consistency
48
+ - **TodoWrite**: Progress tracking for complex multi-file implementations
49
+ - **Task**: Delegation for large-scale feature development requiring systematic coordination
50
+
51
+ ## Key Patterns
52
+ - **Context Detection**: Framework/tech stack → appropriate persona and MCP activation
53
+ - **Implementation Flow**: Requirements → code generation → validation → integration
54
+ - **Multi-Persona Coordination**: Frontend + Backend + Security → comprehensive solutions
55
+ - **Quality Integration**: Implementation → testing → documentation → validation
56
+
57
+ ## Examples
58
+
59
+ ### React Component Implementation
60
+ ```
61
+ /sc:implement user profile component --type component --framework react
62
+ # Magic MCP generates UI component with design system integration
63
+ # Frontend persona ensures best practices and accessibility
64
+ ```
65
+
66
+ ### API Service Implementation
67
+ ```
68
+ /sc:implement user authentication API --type api --safe --with-tests
69
+ # Backend persona handles server-side logic and data processing
70
+ # Security persona ensures authentication best practices
71
+ ```
72
+
73
+ ### Full-Stack Feature
74
+ ```
75
+ /sc:implement payment processing system --type feature --with-tests
76
+ # Multi-persona coordination: architect, frontend, backend, security
77
+ # Sequential MCP breaks down complex implementation steps
78
+ ```
79
+
80
+ ### Framework-Specific Implementation
81
+ ```
82
+ /sc:implement dashboard widget --framework vue
83
+ # Context7 MCP provides Vue-specific patterns and documentation
84
+ # Framework-appropriate implementation with official best practices
85
+ ```
86
+
87
+ ## Boundaries
88
+
89
+ **Will:**
90
+ - Implement features with intelligent persona activation and MCP coordination
91
+ - Apply framework-specific best practices and security validation
92
+ - Provide comprehensive implementation with testing and documentation integration
93
+
94
+ **Will Not:**
95
+ - Make architectural decisions without appropriate persona consultation
96
+ - Implement features conflicting with security policies or architectural constraints
97
+ - Override user-specified safety constraints or bypass quality gates
@@ -0,0 +1,93 @@
1
+ ---
2
+ inclusion: manual
3
+ ---
4
+
5
+ # SuperClaude: improve
6
+
7
+ > Converted from Claude Code SuperClaude framework
8
+ > Original: ~/.claude/commands/sc/improve.md
9
+
10
+ # /sc:improve - Code Improvement
11
+
12
+ ## Triggers
13
+ - Code quality enhancement and refactoring requests
14
+ - Performance optimization and bottleneck resolution needs
15
+ - Maintainability improvements and technical debt reduction
16
+ - Best practices application and coding standards enforcement
17
+
18
+ ## Usage
19
+ ```
20
+ /sc:improve [target] [--type quality|performance|maintainability|style] [--safe] [--interactive]
21
+ ```
22
+
23
+ ## Behavioral Flow
24
+ 1. **Analyze**: Examine codebase for improvement opportunities and quality issues
25
+ 2. **Plan**: Choose improvement approach and activate relevant personas for expertise
26
+ 3. **Execute**: Apply systematic improvements with domain-specific best practices
27
+ 4. **Validate**: Ensure improvements preserve functionality and meet quality standards
28
+ 5. **Document**: Generate improvement summary and recommendations for future work
29
+
30
+ Key behaviors:
31
+ - Multi-persona coordination (architect, performance, quality, security) based on improvement type
32
+ - Framework-specific optimization via Context7 integration for best practices
33
+ - Systematic analysis via Sequential MCP for complex multi-component improvements
34
+ - Safe refactoring with comprehensive validation and rollback capabilities
35
+
36
+ ## MCP Integration
37
+ - **Sequential MCP**: Auto-activated for complex multi-step improvement analysis and planning
38
+ - **Context7 MCP**: Framework-specific best practices and optimization patterns
39
+ - **Persona Coordination**: Architect (structure), Performance (speed), Quality (maintainability), Security (safety)
40
+
41
+ ## Tool Coordination
42
+ - **Read/Grep/Glob**: Code analysis and improvement opportunity identification
43
+ - **Edit/MultiEdit**: Safe code modification and systematic refactoring
44
+ - **TodoWrite**: Progress tracking for complex multi-file improvement operations
45
+ - **Task**: Delegation for large-scale improvement workflows requiring systematic coordination
46
+
47
+ ## Key Patterns
48
+ - **Quality Improvement**: Code analysis → technical debt identification → refactoring application
49
+ - **Performance Optimization**: Profiling analysis → bottleneck identification → optimization implementation
50
+ - **Maintainability Enhancement**: Structure analysis → complexity reduction → documentation improvement
51
+ - **Security Hardening**: Vulnerability analysis → security pattern application → validation verification
52
+
53
+ ## Examples
54
+
55
+ ### Code Quality Enhancement
56
+ ```
57
+ /sc:improve src/ --type quality --safe
58
+ # Systematic quality analysis with safe refactoring application
59
+ # Improves code structure, reduces technical debt, enhances readability
60
+ ```
61
+
62
+ ### Performance Optimization
63
+ ```
64
+ /sc:improve api-endpoints --type performance --interactive
65
+ # Performance persona analyzes bottlenecks and optimization opportunities
66
+ # Interactive guidance for complex performance improvement decisions
67
+ ```
68
+
69
+ ### Maintainability Improvements
70
+ ```
71
+ /sc:improve legacy-modules --type maintainability --preview
72
+ # Architect persona analyzes structure and suggests maintainability improvements
73
+ # Preview mode shows changes before application for review
74
+ ```
75
+
76
+ ### Security Hardening
77
+ ```
78
+ /sc:improve auth-service --type security --validate
79
+ # Security persona identifies vulnerabilities and applies security patterns
80
+ # Comprehensive validation ensures security improvements are effective
81
+ ```
82
+
83
+ ## Boundaries
84
+
85
+ **Will:**
86
+ - Apply systematic improvements with domain-specific expertise and validation
87
+ - Provide comprehensive analysis with multi-persona coordination and best practices
88
+ - Execute safe refactoring with rollback capabilities and quality preservation
89
+
90
+ **Will Not:**
91
+ - Apply risky improvements without proper analysis and user confirmation
92
+ - Make architectural changes without understanding full system impact
93
+ - Override established coding standards or project-specific conventions
@@ -0,0 +1,169 @@
1
+ ---
2
+ inclusion: manual
3
+ ---
4
+
5
+ # SuperClaude: index-repo
6
+
7
+ > Converted from Claude Code SuperClaude framework
8
+ > Original: ~/.claude/commands/sc/index-repo.md
9
+
10
+ # Repository Index Creator
11
+
12
+ 📊 **Index Creator activated**
13
+
14
+ ## Problem Statement
15
+
16
+ **Before**: Reading all files → 58,000 tokens every session
17
+ **After**: Read PROJECT_INDEX.md → 3,000 tokens (94% reduction)
18
+
19
+ ## Index Creation Flow
20
+
21
+ ### Phase 1: Analyze Repository Structure
22
+
23
+ **Parallel analysis** (5 concurrent Glob searches):
24
+
25
+ 1. **Code Structure**
26
+ ```
27
+ src/**/*.{ts,py,js,tsx,jsx}
28
+ lib/**/*.{ts,py,js}
29
+ superclaude/**/*.py
30
+ ```
31
+
32
+ 2. **Documentation**
33
+ ```
34
+ docs/**/*.md
35
+ *.md (root level)
36
+ README*.md
37
+ ```
38
+
39
+ 3. **Configuration**
40
+ ```
41
+ *.toml
42
+ *.yaml, *.yml
43
+ *.json (exclude package-lock, node_modules)
44
+ ```
45
+
46
+ 4. **Tests**
47
+ ```
48
+ tests/**/*.{py,ts,js}
49
+ **/*.test.{ts,py,js}
50
+ **/*.spec.{ts,py,js}
51
+ ```
52
+
53
+ 5. **Scripts & Tools**
54
+ ```
55
+ scripts/**/*
56
+ bin/**/*
57
+ tools/**/*
58
+ ```
59
+
60
+ ### Phase 2: Extract Metadata
61
+
62
+ For each file category, extract:
63
+ - Entry points (main.py, index.ts, cli.py)
64
+ - Key modules and exports
65
+ - API surface (public functions/classes)
66
+ - Dependencies (imports, requires)
67
+
68
+ ### Phase 3: Generate Index
69
+
70
+ Create `PROJECT_INDEX.md` with structure:
71
+
72
+ ```markdown
73
+ # Project Index: {project_name}
74
+
75
+ Generated: {timestamp}
76
+
77
+ ## 📁 Project Structure
78
+
79
+ {tree view of main directories}
80
+
81
+ ## 🚀 Entry Points
82
+
83
+ - CLI: {path} - {description}
84
+ - API: {path} - {description}
85
+ - Tests: {path} - {description}
86
+
87
+ ## 📦 Core Modules
88
+
89
+ ### Module: {name}
90
+ - Path: {path}
91
+ - Exports: {list}
92
+ - Purpose: {1-line description}
93
+
94
+ ## 🔧 Configuration
95
+
96
+ - {config_file}: {purpose}
97
+
98
+ ## 📚 Documentation
99
+
100
+ - {doc_file}: {topic}
101
+
102
+ ## 🧪 Test Coverage
103
+
104
+ - Unit tests: {count} files
105
+ - Integration tests: {count} files
106
+ - Coverage: {percentage}%
107
+
108
+ ## 🔗 Key Dependencies
109
+
110
+ - {dependency}: {version} - {purpose}
111
+
112
+ ## 📝 Quick Start
113
+
114
+ 1. {setup step}
115
+ 2. {run step}
116
+ 3. {test step}
117
+ ```
118
+
119
+ ### Phase 4: Validation
120
+
121
+ Quality checks:
122
+ - [ ] All entry points identified?
123
+ - [ ] Core modules documented?
124
+ - [ ] Index size < 5KB?
125
+ - [ ] Human-readable format?
126
+
127
+ ---
128
+
129
+ ## Usage
130
+
131
+ **Create index**:
132
+ ```
133
+ /index-repo
134
+ ```
135
+
136
+ **Update existing index**:
137
+ ```
138
+ /index-repo mode=update
139
+ ```
140
+
141
+ **Quick index (skip tests)**:
142
+ ```
143
+ /index-repo mode=quick
144
+ ```
145
+
146
+ ---
147
+
148
+ ## Token Efficiency
149
+
150
+ **ROI Calculation**:
151
+ - Index creation: 2,000 tokens (one-time)
152
+ - Index reading: 3,000 tokens (every session)
153
+ - Full codebase read: 58,000 tokens (every session)
154
+
155
+ **Break-even**: 1 session
156
+ **10 sessions savings**: 550,000 tokens
157
+ **100 sessions savings**: 5,500,000 tokens
158
+
159
+ ---
160
+
161
+ ## Output Format
162
+
163
+ Creates two files:
164
+ 1. `PROJECT_INDEX.md` (3KB, human-readable)
165
+ 2. `PROJECT_INDEX.json` (10KB, machine-readable)
166
+
167
+ ---
168
+
169
+ **Index Creator is now active.** Run to analyze current repository.
@@ -0,0 +1,86 @@
1
+ ---
2
+ inclusion: manual
3
+ ---
4
+
5
+ # SuperClaude: index
6
+
7
+ > Converted from Claude Code SuperClaude framework
8
+ > Original: ~/.claude/commands/sc/index.md
9
+
10
+ # /sc:index - Project Documentation
11
+
12
+ ## Triggers
13
+ - Project documentation creation and maintenance requirements
14
+ - Knowledge base generation and organization needs
15
+ - API documentation and structure analysis requirements
16
+ - Cross-referencing and navigation enhancement requests
17
+
18
+ ## Usage
19
+ ```
20
+ /sc:index [target] [--type docs|api|structure|readme] [--format md|json|yaml]
21
+ ```
22
+
23
+ ## Behavioral Flow
24
+ 1. **Analyze**: Examine project structure and identify key documentation components
25
+ 2. **Organize**: Apply intelligent organization patterns and cross-referencing strategies
26
+ 3. **Generate**: Create comprehensive documentation with framework-specific patterns
27
+ 4. **Validate**: Ensure documentation completeness and quality standards
28
+ 5. **Maintain**: Update existing documentation while preserving manual additions and customizations
29
+
30
+ Key behaviors:
31
+ - Multi-persona coordination (architect, scribe, quality) based on documentation scope and complexity
32
+ - Sequential MCP integration for systematic analysis and comprehensive documentation workflows
33
+ - Context7 MCP integration for framework-specific patterns and documentation standards
34
+ - Intelligent organization with cross-referencing capabilities and automated maintenance
35
+
36
+ ## MCP Integration
37
+ - **Sequential MCP**: Complex multi-step project analysis and systematic documentation generation
38
+ - **Context7 MCP**: Framework-specific documentation patterns and established standards
39
+ - **Persona Coordination**: Architect (structure), Scribe (content), Quality (validation)
40
+
41
+ ## Tool Coordination
42
+ - **Read/Grep/Glob**: Project structure analysis and content extraction for documentation generation
43
+ - **Write**: Documentation creation with intelligent organization and cross-referencing
44
+ - **TodoWrite**: Progress tracking for complex multi-component documentation workflows
45
+ - **Task**: Advanced delegation for large-scale documentation requiring systematic coordination
46
+
47
+ ## Key Patterns
48
+ - **Structure Analysis**: Project examination → component identification → logical organization → cross-referencing
49
+ - **Documentation Types**: API docs → Structure docs → README → Knowledge base approaches
50
+ - **Quality Validation**: Completeness assessment → accuracy verification → standard compliance → maintenance planning
51
+ - **Framework Integration**: Context7 patterns → official standards → best practices → consistency validation
52
+
53
+ ## Examples
54
+
55
+ ### Project Structure Documentation
56
+ ```
57
+ /sc:index project-root --type structure --format md
58
+ # Comprehensive project structure documentation with intelligent organization
59
+ # Creates navigable structure with cross-references and component relationships
60
+ ```
61
+
62
+ ### API Documentation Generation
63
+ ```
64
+ /sc:index src/api --type api --format json
65
+ # API documentation with systematic analysis and validation
66
+ # Scribe and quality personas ensure completeness and accuracy
67
+ ```
68
+
69
+ ### Knowledge Base Creation
70
+ ```
71
+ /sc:index . --type docs
72
+ # Interactive knowledge base generation with project-specific patterns
73
+ # Architect persona provides structural organization and cross-referencing
74
+ ```
75
+
76
+ ## Boundaries
77
+
78
+ **Will:**
79
+ - Generate comprehensive project documentation with intelligent organization and cross-referencing
80
+ - Apply multi-persona coordination for systematic analysis and quality validation
81
+ - Provide framework-specific patterns and established documentation standards
82
+
83
+ **Will Not:**
84
+ - Override existing manual documentation without explicit update permission
85
+ - Generate documentation without appropriate project structure analysis and validation
86
+ - Bypass established documentation standards or quality requirements