superkit-mcp-server 1.2.3 → 1.2.4

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 (161) hide show
  1. package/ARCHITECTURE.md +102 -102
  2. package/README.md +71 -71
  3. package/SUPERKIT.md +168 -168
  4. package/agents/code-archaeologist.md +106 -106
  5. package/agents/coder.md +90 -90
  6. package/agents/data-engineer.md +28 -28
  7. package/agents/devops-engineer.md +242 -242
  8. package/agents/git-manager.md +203 -203
  9. package/agents/orchestrator.md +420 -420
  10. package/agents/penetration-tester.md +188 -188
  11. package/agents/performance-optimizer.md +187 -187
  12. package/agents/planner.md +270 -270
  13. package/agents/qa-automation-engineer.md +103 -103
  14. package/agents/quant-developer.md +32 -32
  15. package/agents/reviewer.md +100 -100
  16. package/agents/scout.md +222 -222
  17. package/agents/tester.md +274 -274
  18. package/agents/ui-designer.md +208 -208
  19. package/build/tools/sessionManager.js +79 -10
  20. package/build/tools/todoTools.js +39 -39
  21. package/build/tools/validators/__tests__/apiSchema.test.js +23 -23
  22. package/build/tools/validators/__tests__/convertRules.test.js +5 -5
  23. package/build/tools/validators/__tests__/frontendDesign.test.js +12 -12
  24. package/build/tools/validators/__tests__/geoChecker.test.js +19 -19
  25. package/build/tools/validators/__tests__/mobileAudit.test.js +12 -12
  26. package/build/tools/validators/__tests__/reactPerformanceChecker.test.js +17 -17
  27. package/build/tools/validators/__tests__/securityScan.test.js +6 -6
  28. package/build/tools/validators/__tests__/seoChecker.test.js +16 -16
  29. package/build/tools/validators/__tests__/typeCoverage.test.js +14 -14
  30. package/commands/README.md +122 -122
  31. package/commands/ask.toml +72 -72
  32. package/commands/brainstorm.toml +119 -119
  33. package/commands/chat.toml +77 -77
  34. package/commands/code-preview.toml +37 -37
  35. package/commands/code.toml +28 -28
  36. package/commands/content.toml +200 -200
  37. package/commands/cook.toml +77 -77
  38. package/commands/copywrite.toml +131 -131
  39. package/commands/db.toml +192 -192
  40. package/commands/debug.toml +166 -166
  41. package/commands/design.toml +158 -158
  42. package/commands/dev-rules.toml +14 -14
  43. package/commands/do.toml +117 -117
  44. package/commands/doc-rules.toml +14 -14
  45. package/commands/docs.toml +148 -148
  46. package/commands/fix.toml +440 -440
  47. package/commands/fullstack.toml +175 -175
  48. package/commands/git.toml +235 -235
  49. package/commands/help.toml +84 -84
  50. package/commands/integrate.toml +127 -127
  51. package/commands/journal.toml +136 -136
  52. package/commands/kit-setup.toml +40 -40
  53. package/commands/mcp.toml +183 -183
  54. package/commands/orchestration.toml +15 -15
  55. package/commands/plan.toml +171 -171
  56. package/commands/pm.toml +148 -148
  57. package/commands/pr.toml +50 -50
  58. package/commands/project.toml +32 -32
  59. package/commands/research.toml +117 -117
  60. package/commands/review-pr.toml +63 -63
  61. package/commands/review.toml +190 -190
  62. package/commands/scout-ext.toml +97 -97
  63. package/commands/scout.toml +79 -79
  64. package/commands/screenshot.toml +65 -65
  65. package/commands/session.toml +102 -102
  66. package/commands/skill.toml +384 -384
  67. package/commands/status.toml +22 -22
  68. package/commands/team.toml +56 -56
  69. package/commands/test.toml +164 -164
  70. package/commands/ticket.toml +70 -70
  71. package/commands/use.toml +106 -106
  72. package/commands/video.toml +83 -83
  73. package/commands/watzup.toml +71 -71
  74. package/commands/workflow.toml +14 -14
  75. package/package.json +35 -35
  76. package/skills/meta/README.md +30 -30
  77. package/skills/meta/api-design/SKILL.md +134 -134
  78. package/skills/meta/code-review/SKILL.md +44 -44
  79. package/skills/meta/code-review/checklists/pre-merge.md +25 -25
  80. package/skills/meta/code-review/workflows/architecture-pass.md +26 -26
  81. package/skills/meta/code-review/workflows/performance-pass.md +27 -27
  82. package/skills/meta/code-review/workflows/security-pass.md +29 -29
  83. package/skills/meta/compound-docs/SKILL.md +133 -133
  84. package/skills/meta/debug/SKILL.md +40 -40
  85. package/skills/meta/debug/templates/bug-report.template.md +31 -31
  86. package/skills/meta/debug/workflows/reproduce-issue.md +20 -20
  87. package/skills/meta/docker/SKILL.md +126 -126
  88. package/skills/meta/examples/supabase/SKILL.md +46 -46
  89. package/skills/meta/examples/supabase/references/best-practices.md +319 -319
  90. package/skills/meta/examples/supabase/references/common-patterns.md +373 -373
  91. package/skills/meta/examples/supabase/templates/migration-template.sql +49 -49
  92. package/skills/meta/examples/supabase/templates/rls-policy-template.sql +77 -77
  93. package/skills/meta/examples/supabase/workflows/debugging.md +260 -260
  94. package/skills/meta/examples/supabase/workflows/migration-workflow.md +211 -211
  95. package/skills/meta/examples/supabase/workflows/rls-policies.md +244 -244
  96. package/skills/meta/examples/supabase/workflows/schema-design.md +321 -321
  97. package/skills/meta/file-todos/SKILL.md +88 -88
  98. package/skills/meta/mobile/SKILL.md +140 -140
  99. package/skills/meta/nextjs/SKILL.md +101 -101
  100. package/skills/meta/performance/SKILL.md +130 -130
  101. package/skills/meta/react-patterns/SKILL.md +83 -83
  102. package/skills/meta/security/SKILL.md +114 -114
  103. package/skills/meta/session-resume/SKILL.md +96 -96
  104. package/skills/meta/tailwind/SKILL.md +139 -139
  105. package/skills/meta/testing/SKILL.md +43 -43
  106. package/skills/meta/testing/references/vitest-patterns.md +45 -45
  107. package/skills/meta/testing/templates/component-test.template.tsx +37 -37
  108. package/skills/tech/alpha-vantage/SKILL.md +142 -142
  109. package/skills/tech/alpha-vantage/references/commodities.md +153 -153
  110. package/skills/tech/alpha-vantage/references/economic-indicators.md +158 -158
  111. package/skills/tech/alpha-vantage/references/forex-crypto.md +154 -154
  112. package/skills/tech/alpha-vantage/references/fundamentals.md +223 -223
  113. package/skills/tech/alpha-vantage/references/intelligence.md +138 -138
  114. package/skills/tech/alpha-vantage/references/options.md +93 -93
  115. package/skills/tech/alpha-vantage/references/technical-indicators.md +374 -374
  116. package/skills/tech/alpha-vantage/references/time-series.md +157 -157
  117. package/skills/tech/financial-modeling/SKILL.md +18 -18
  118. package/skills/tech/financial-modeling/skills/3-statements/SKILL.md +368 -368
  119. package/skills/tech/financial-modeling/skills/3-statements/references/formatting.md +118 -118
  120. package/skills/tech/financial-modeling/skills/3-statements/references/formulas.md +292 -292
  121. package/skills/tech/financial-modeling/skills/3-statements/references/sec-filings.md +125 -125
  122. package/skills/tech/financial-modeling/skills/dcf-model/SKILL.md +1210 -1210
  123. package/skills/tech/financial-modeling/skills/dcf-model/TROUBLESHOOTING.md +40 -40
  124. package/skills/tech/financial-modeling/skills/dcf-model/requirements.txt +8 -8
  125. package/skills/tech/financial-modeling/skills/dcf-model/scripts/validate_dcf.py +292 -292
  126. package/skills/tech/financial-modeling/skills/lbo-model/SKILL.md +236 -236
  127. package/skills/tech/financial-modeling/skills/merger-model/SKILL.md +108 -108
  128. package/skills/workflows/README.md +203 -203
  129. package/skills/workflows/adr.md +174 -174
  130. package/skills/workflows/changelog.md +74 -74
  131. package/skills/workflows/compound.md +323 -323
  132. package/skills/workflows/compound_health.md +74 -74
  133. package/skills/workflows/create-agent-skill.md +138 -138
  134. package/skills/workflows/cycle.md +144 -144
  135. package/skills/workflows/deploy-docs.md +84 -84
  136. package/skills/workflows/development-rules.md +42 -42
  137. package/skills/workflows/doc.md +95 -95
  138. package/skills/workflows/documentation-management.md +34 -34
  139. package/skills/workflows/explore.md +146 -146
  140. package/skills/workflows/generate_command.md +106 -106
  141. package/skills/workflows/heal-skill.md +97 -97
  142. package/skills/workflows/housekeeping.md +229 -229
  143. package/skills/workflows/kit-setup.md +102 -102
  144. package/skills/workflows/map-codebase.md +78 -78
  145. package/skills/workflows/orchestration-protocol.md +43 -43
  146. package/skills/workflows/plan-compound.md +439 -439
  147. package/skills/workflows/plan_review.md +269 -269
  148. package/skills/workflows/primary-workflow.md +37 -37
  149. package/skills/workflows/promote_pattern.md +86 -86
  150. package/skills/workflows/release-docs.md +82 -82
  151. package/skills/workflows/report-bug.md +135 -135
  152. package/skills/workflows/reproduce-bug.md +118 -118
  153. package/skills/workflows/resolve_pr.md +133 -133
  154. package/skills/workflows/resolve_todo.md +128 -128
  155. package/skills/workflows/review-compound.md +376 -376
  156. package/skills/workflows/skill-review.md +127 -127
  157. package/skills/workflows/specs.md +257 -257
  158. package/skills/workflows/triage-sprint.md +102 -102
  159. package/skills/workflows/triage.md +152 -152
  160. package/skills/workflows/work.md +399 -399
  161. package/skills/workflows/xcode-test.md +93 -93
@@ -1,108 +1,108 @@
1
- # Merger Model
2
-
3
- description: Build accretion/dilution analysis for M&A transactions. Models pro forma EPS impact, synergy sensitivities, and purchase price allocation. Use when evaluating a potential acquisition, preparing merger consequences analysis for a pitch, or advising on deal terms. Triggers on "merger model", "accretion dilution", "M&A model", "pro forma EPS", "merger consequences", or "deal impact analysis".
4
-
5
- ## Workflow
6
-
7
- ### Step 1: Gather Inputs
8
-
9
- **Acquirer:**
10
- - Company name, current share price, shares outstanding
11
- - LTM and NTM EPS (GAAP and adjusted)
12
- - P/E multiple
13
- - Pre-tax cost of debt, tax rate
14
- - Cash on balance sheet, existing debt
15
-
16
- **Target:**
17
- - Company name, current share price, shares outstanding (if public)
18
- - LTM and NTM EPS or net income
19
- - Enterprise value or equity value
20
-
21
- **Deal Terms:**
22
- - Offer price per share (or premium to current)
23
- - Consideration mix: % cash vs. % stock
24
- - New debt raised to fund cash portion
25
- - Expected synergies (revenue and cost) and phase-in timeline
26
- - Transaction fees and financing costs
27
- - Expected close date
28
-
29
- ### Step 2: Purchase Price Analysis
30
-
31
- | Item | Value |
32
- |------|-------|
33
- | Offer price per share | |
34
- | Premium to current | |
35
- | Equity value | |
36
- | Plus: net debt assumed | |
37
- | Enterprise value | |
38
- | EV / EBITDA implied | |
39
- | P/E implied | |
40
-
41
- ### Step 3: Sources & Uses
42
-
43
- | Sources | $ | Uses | $ |
44
- |---------|---|------|---|
45
- | New debt | | Equity purchase price | |
46
- | Cash on hand | | Refinance target debt | |
47
- | New equity issued | | Transaction fees | |
48
- | | | Financing fees | |
49
- | **Total** | | **Total** | |
50
-
51
- ### Step 4: Pro Forma EPS (Accretion / Dilution)
52
-
53
- Calculate year-by-year (Year 1-3):
54
-
55
- | | Standalone | Pro Forma | Accretion/(Dilution) |
56
- |---|-----------|-----------|---------------------|
57
- | Acquirer net income | | | |
58
- | Target net income | | | |
59
- | Synergies (after tax) | | | |
60
- | Foregone interest on cash (after tax) | | | |
61
- | New debt interest (after tax) | | | |
62
- | Intangible amortization (after tax) | | | |
63
- | Pro forma net income | | | |
64
- | Pro forma shares | | | |
65
- | **Pro forma EPS** | | | |
66
- | **Accretion / (Dilution) %** | | | |
67
-
68
- ### Step 5: Sensitivity Analysis
69
-
70
- **Accretion/Dilution vs. Synergies and Offer Premium:**
71
-
72
- | | $0M syn | $25M syn | $50M syn | $75M syn | $100M syn |
73
- |---|---------|----------|----------|----------|-----------|
74
- | 15% premium | | | | | |
75
- | 20% premium | | | | | |
76
- | 25% premium | | | | | |
77
- | 30% premium | | | | | |
78
-
79
- **Accretion/Dilution vs. Cash/Stock Mix:**
80
-
81
- | | 100% cash | 75/25 | 50/50 | 25/75 | 100% stock |
82
- |---|-----------|-------|-------|-------|------------|
83
- | Year 1 | | | | | |
84
- | Year 2 | | | | | |
85
-
86
- ### Step 6: Breakeven Synergies
87
-
88
- Calculate the minimum synergies needed for the deal to be EPS-neutral in Year 1.
89
-
90
- ### Step 7: Output
91
-
92
- - Excel workbook with:
93
- - Assumptions tab
94
- - Sources & uses
95
- - Pro forma income statement
96
- - Accretion/dilution summary
97
- - Sensitivity tables
98
- - Breakeven analysis
99
- - One-page merger consequences summary for pitch book
100
-
101
- ## Important Notes
102
-
103
- - Always show both GAAP and adjusted (cash) EPS where relevant
104
- - Stock deals: use acquirer's current price for exchange ratio, note dilution from new shares
105
- - Include purchase price allocation — goodwill and intangible amortization matter for GAAP EPS
106
- - Synergy phase-in is critical — Year 1 is often only 25-50% of run-rate synergies
107
- - Don't forget foregone interest income on cash used and new interest expense on debt raised
108
- - Tax rate on synergies and interest adjustments should match the acquirer's marginal rate
1
+ # Merger Model
2
+
3
+ description: Build accretion/dilution analysis for M&A transactions. Models pro forma EPS impact, synergy sensitivities, and purchase price allocation. Use when evaluating a potential acquisition, preparing merger consequences analysis for a pitch, or advising on deal terms. Triggers on "merger model", "accretion dilution", "M&A model", "pro forma EPS", "merger consequences", or "deal impact analysis".
4
+
5
+ ## Workflow
6
+
7
+ ### Step 1: Gather Inputs
8
+
9
+ **Acquirer:**
10
+ - Company name, current share price, shares outstanding
11
+ - LTM and NTM EPS (GAAP and adjusted)
12
+ - P/E multiple
13
+ - Pre-tax cost of debt, tax rate
14
+ - Cash on balance sheet, existing debt
15
+
16
+ **Target:**
17
+ - Company name, current share price, shares outstanding (if public)
18
+ - LTM and NTM EPS or net income
19
+ - Enterprise value or equity value
20
+
21
+ **Deal Terms:**
22
+ - Offer price per share (or premium to current)
23
+ - Consideration mix: % cash vs. % stock
24
+ - New debt raised to fund cash portion
25
+ - Expected synergies (revenue and cost) and phase-in timeline
26
+ - Transaction fees and financing costs
27
+ - Expected close date
28
+
29
+ ### Step 2: Purchase Price Analysis
30
+
31
+ | Item | Value |
32
+ |------|-------|
33
+ | Offer price per share | |
34
+ | Premium to current | |
35
+ | Equity value | |
36
+ | Plus: net debt assumed | |
37
+ | Enterprise value | |
38
+ | EV / EBITDA implied | |
39
+ | P/E implied | |
40
+
41
+ ### Step 3: Sources & Uses
42
+
43
+ | Sources | $ | Uses | $ |
44
+ |---------|---|------|---|
45
+ | New debt | | Equity purchase price | |
46
+ | Cash on hand | | Refinance target debt | |
47
+ | New equity issued | | Transaction fees | |
48
+ | | | Financing fees | |
49
+ | **Total** | | **Total** | |
50
+
51
+ ### Step 4: Pro Forma EPS (Accretion / Dilution)
52
+
53
+ Calculate year-by-year (Year 1-3):
54
+
55
+ | | Standalone | Pro Forma | Accretion/(Dilution) |
56
+ |---|-----------|-----------|---------------------|
57
+ | Acquirer net income | | | |
58
+ | Target net income | | | |
59
+ | Synergies (after tax) | | | |
60
+ | Foregone interest on cash (after tax) | | | |
61
+ | New debt interest (after tax) | | | |
62
+ | Intangible amortization (after tax) | | | |
63
+ | Pro forma net income | | | |
64
+ | Pro forma shares | | | |
65
+ | **Pro forma EPS** | | | |
66
+ | **Accretion / (Dilution) %** | | | |
67
+
68
+ ### Step 5: Sensitivity Analysis
69
+
70
+ **Accretion/Dilution vs. Synergies and Offer Premium:**
71
+
72
+ | | $0M syn | $25M syn | $50M syn | $75M syn | $100M syn |
73
+ |---|---------|----------|----------|----------|-----------|
74
+ | 15% premium | | | | | |
75
+ | 20% premium | | | | | |
76
+ | 25% premium | | | | | |
77
+ | 30% premium | | | | | |
78
+
79
+ **Accretion/Dilution vs. Cash/Stock Mix:**
80
+
81
+ | | 100% cash | 75/25 | 50/50 | 25/75 | 100% stock |
82
+ |---|-----------|-------|-------|-------|------------|
83
+ | Year 1 | | | | | |
84
+ | Year 2 | | | | | |
85
+
86
+ ### Step 6: Breakeven Synergies
87
+
88
+ Calculate the minimum synergies needed for the deal to be EPS-neutral in Year 1.
89
+
90
+ ### Step 7: Output
91
+
92
+ - Excel workbook with:
93
+ - Assumptions tab
94
+ - Sources & uses
95
+ - Pro forma income statement
96
+ - Accretion/dilution summary
97
+ - Sensitivity tables
98
+ - Breakeven analysis
99
+ - One-page merger consequences summary for pitch book
100
+
101
+ ## Important Notes
102
+
103
+ - Always show both GAAP and adjusted (cash) EPS where relevant
104
+ - Stock deals: use acquirer's current price for exchange ratio, note dilution from new shares
105
+ - Include purchase price allocation — goodwill and intangible amortization matter for GAAP EPS
106
+ - Synergy phase-in is critical — Year 1 is often only 25-50% of run-rate synergies
107
+ - Don't forget foregone interest income on cash used and new interest expense on debt raised
108
+ - Tax rate on synergies and interest adjustments should match the acquirer's marginal rate
@@ -1,203 +1,203 @@
1
- # Compound Engineering Workflows
2
-
3
- > **Quick Start:** New to this project? Read [critical-patterns.md](../../docs/solutions/patterns/critical-patterns.md) first.
4
- > **Technical Architecture:** For the complete system architecture, see [docs/architecture/compound-system.md](../../docs/architecture/compound-system.md).
5
-
6
- ## Purpose
7
-
8
- This directory contains workflow definitions that orchestrate the agent's compound engineering process. Workflows provide structured, repeatable sequences for planning, implementing, reviewing, and documenting work.
9
-
10
- ## Components
11
-
12
- | Category | Workflows |
13
- |----------|-----------|
14
- | **Core Loop** | `/explore`, `/specs`, `/plan-compound`, `/plan_review`, `/work`, `/review-compound`, `/compound`, `/housekeeping`, `/cycle` |
15
- | **Todo / Triage** | `/triage`, `/triage-sprint`, `/resolve_todo` |
16
- | **Code Review** | `/resolve_pr`, `/plan_review`, `/review-compound` |
17
- | **Architecture / Context** | `/adr`, `/map-codebase`, `/doc`, `/kit-setup` |
18
- | **Release** | `/changelog`, `/release-docs`, `/deploy-docs` |
19
- | **Debugging** | `/report-bug`, `/reproduce-bug` |
20
- | **Skills & Extensions** | `/create-agent-skill`, `/heal-skill`, `/generate_command`, `/skill-review` |
21
- | **Maintenance** | `/housekeeping`, `/compound_health`, `/promote_pattern` |
22
-
23
- ## Component Details
24
-
25
- ### 🔴 Critical Workflows
26
-
27
- | Workflow | Purpose | When to Use |
28
- |----------|---------|-------------|
29
- | `plan-compound.md` | Transform features into structured plans with security & pattern checks | Before significant work |
30
- | `work.md` | Execute work plans systematically while maintaining quality | During implementation |
31
- | `review-compound.md` | Multi-pass code review (Security via MCP, Perf, Architecture) | After work complete |
32
- | `compound.md` | Document reusable knowledge to compound project capability | After solving problems |
33
-
34
- ### 🟡 Supporting Workflows
35
-
36
- | Workflow | Purpose |
37
- |----------|---------|
38
- | `explore.md` | Deep investigation, best practices, and systematic analysis |
39
- | `specs.md` | Create and manage specifications for multi-session initiatives |
40
- | `housekeeping.md` | Pre-push cleanup to archive completed items |
41
- | `triage.md` | Prioritize findings from code reviews |
42
-
43
- ## Core Loop
44
-
45
- ```
46
- /explore (optional) → /specs (large) → /plan-compound (per phase) → /plan_review → /work → /review-compound → /compound → /housekeeping → repeat
47
- ```
48
-
49
- | Command | When | Purpose |
50
- |---------|------|---------|
51
- | `/explore` | Before planning | Deep investigation, best practices, multi-order analysis |
52
- | `/specs` | Major initiatives | Create structured specification with phases |
53
- | `/plan-compound` | Before sig. work | Transform descriptions into well-structured project plans |
54
- | `/plan_review` | Pre-execution | Review implementation plans for quality and completeness |
55
- | `/work` | Implementation | Execute work plans systematically while maintaining quality |
56
- | `/review-compound`| Post-work | Perform comprehensive multi-pass code review with MCP security |
57
- | `/compound` | Post-solution | Document reusable knowledge to compound project capability |
58
- | `/cycle` | Small tasks | Orchestrate full "plan → review → work → review → compound" lifecycle |
59
- | `/housekeeping` | Pre-push | Archive completed work, validate repo health |
60
-
61
- ## Support Commands
62
-
63
- ### Todos & Triage
64
- | Command | Purpose |
65
- |---------|---------|
66
- | `/triage` | Triage and prioritize findings from code reviews |
67
- | `/triage-sprint` | Batch process pending todos to unblock triage bottlenecks |
68
- | `/resolve_todo` | Resolve multiple todo items efficiently |
69
-
70
- ### Code Review & Quality
71
- | Command | Purpose |
72
- |---------|---------|
73
- | `/resolve_pr` | Handle PR comments and review feedback efficiently |
74
- | `/plan_review` | Review implementation plans for quality |
75
- | `/review-compound` | Perform multi-pass code review with security, performance, & architecture checks |
76
-
77
- ### Architecture & Context
78
- | Command | Purpose |
79
- |---------|---------|
80
- | `/adr` | Create a new Architecture Decision Record |
81
- | `/map-codebase` | Map existing codebase architecture, tech stack, and conventions |
82
- | `/doc` | Update folder-level documentation and component changelogs |
83
- | `/kit-setup` | Interactive project setup wizard creating context files |
84
-
85
- ### Release & Docs
86
- | Command | Purpose |
87
- |---------|---------|
88
- | `/changelog` | Generate changelog entries from commits |
89
- | `/release-docs` | Prepare release documentation |
90
- | `/deploy-docs` | Deploy documentation updates |
91
-
92
- ### Debugging
93
- | Command | Purpose |
94
- |---------|---------|
95
- | `/report-bug` | Report bugs with structured reproduction steps |
96
- | `/reproduce-bug` | Reproduce reported bugs systematically |
97
-
98
- ### Skills & Extensions
99
- | Command | Purpose |
100
- |---------|---------|
101
- | `/create-agent-skill` | Create new skills for extending agent capabilities |
102
- | `/heal-skill` | Diagnose and fix broken skills |
103
- | `/generate_command` | Create new workflow commands dynamically |
104
- | `/skill-review` | Weekly review of potential new agent skills discovered from usage |
105
-
106
- ### Maintenance & Health
107
- | Command | Purpose |
108
- |---------|---------|
109
- | `/compound_health` | Check the improved Compound System's health and usage metrics |
110
- | `/promote_pattern` | Promote a recurring issue to a critical pattern |
111
-
112
- ### Platform-Specific
113
- | Command | Purpose |
114
- |---------|---------|
115
- | `/xcode-test` | Run Xcode tests for iOS applications |
116
-
117
- ### Modular Skills
118
- | Skill | Purpose | Entry Point |
119
- |-------|---------|-------------|
120
- | `session-resume` | Establish session state | `skills/session-resume/SKILL.md` |
121
- | `compound-docs` | Search/Document solutions | `skills/compound-docs/SKILL.md` |
122
- | `file-todos` | Manage file-based tasks | `skills/file-todos/SKILL.md` |
123
- | `code-review` | Systematic quality gates | `skills/code-review/SKILL.md` |
124
- | `testing` | Unified test patterns | `skills/testing/SKILL.md` |
125
- | `debug` | Structured root cause analysis | `skills/debug/SKILL.md` |
126
-
127
- ---
128
-
129
- ## Before You Start Any Work
130
-
131
- ### 1. Resume Session (STRICTLY REQUIRED)
132
-
133
- Always run this first when starting a new conversation:
134
- ```bash
135
- # Read and follow the checklist
136
- cat skills/session-resume/SKILL.md
137
- ```
138
-
139
- ### 2. Search Existing Solutions
140
-
141
- ```bash
142
- # Check if this problem was solved before
143
- grep -r "{keywords}" docs/solutions/
144
-
145
- # Check critical patterns
146
- cat docs/solutions/patterns/critical-patterns.md
147
- ```
148
-
149
- ### 3. Check Pending Work
150
-
151
- ```bash
152
- # Any active specs?
153
- ls docs/specs/*/README.md 2>/dev/null | grep -v templates
154
-
155
- # Any ready todos?
156
- ls todos/*-ready-*.md 2>/dev/null
157
-
158
- # Any in-progress plans?
159
- ls plans/*.md 2>/dev/null
160
- ```
161
-
162
- ---
163
-
164
- ## Directory Structure
165
-
166
- ```
167
- skills/workflows/ # You are here - all workflow definitions
168
- docs/solutions/ # Persistent knowledge base
169
- ├── patterns/ # Critical patterns (READ FIRST)
170
- ├── schema.yaml # Solution validation schema
171
- └── {categories}/ # Categorized solutions
172
- docs/explorations/ # Deep investigations & research
173
- skills/ # Modular capabilities
174
- plans/ # Implementation plans from /plan
175
- └── archive/ # Completed plans
176
- todos/ # Work items from /review, /triage
177
- └── archive/ # Completed todos
178
- docs/specs/ # Multi-session specifications
179
- └── archive/ # Completed specs
180
- ```
181
-
182
- ---
183
-
184
- ## Key Principles
185
-
186
- 1. **Search before solving** - Check `docs/solutions/` and `docs/explorations/`
187
- 2. **Document after solving** - Run `/compound` when you fix something
188
- 3. **Follow patterns** - Reference `critical-patterns.md`
189
- 4. **Create todos for deferred work** - Don't just document in artifacts
190
- 5. **Use conventional commits** - Enables changelog automation
191
- 6. **Housekeeping before push** - Run `/housekeeping` to archive completed work
192
-
193
- ---
194
-
195
- ## Changelog
196
-
197
- ### 2026-01-24
198
- - Added Purpose, Components, and Component Details sections
199
- - Restructured for documentation validation compliance
200
-
201
- ### 2025-12-20
202
- - Added modular skills section
203
- - Updated core loop documentation
1
+ # Compound Engineering Workflows
2
+
3
+ > **Quick Start:** New to this project? Read [critical-patterns.md](../../docs/solutions/patterns/critical-patterns.md) first.
4
+ > **Technical Architecture:** For the complete system architecture, see [docs/architecture/compound-system.md](../../docs/architecture/compound-system.md).
5
+
6
+ ## Purpose
7
+
8
+ This directory contains workflow definitions that orchestrate the agent's compound engineering process. Workflows provide structured, repeatable sequences for planning, implementing, reviewing, and documenting work.
9
+
10
+ ## Components
11
+
12
+ | Category | Workflows |
13
+ |----------|-----------|
14
+ | **Core Loop** | `/explore`, `/specs`, `/plan-compound`, `/plan_review`, `/work`, `/review-compound`, `/compound`, `/housekeeping`, `/cycle` |
15
+ | **Todo / Triage** | `/triage`, `/triage-sprint`, `/resolve_todo` |
16
+ | **Code Review** | `/resolve_pr`, `/plan_review`, `/review-compound` |
17
+ | **Architecture / Context** | `/adr`, `/map-codebase`, `/doc`, `/kit-setup` |
18
+ | **Release** | `/changelog`, `/release-docs`, `/deploy-docs` |
19
+ | **Debugging** | `/report-bug`, `/reproduce-bug` |
20
+ | **Skills & Extensions** | `/create-agent-skill`, `/heal-skill`, `/generate_command`, `/skill-review` |
21
+ | **Maintenance** | `/housekeeping`, `/compound_health`, `/promote_pattern` |
22
+
23
+ ## Component Details
24
+
25
+ ### 🔴 Critical Workflows
26
+
27
+ | Workflow | Purpose | When to Use |
28
+ |----------|---------|-------------|
29
+ | `plan-compound.md` | Transform features into structured plans with security & pattern checks | Before significant work |
30
+ | `work.md` | Execute work plans systematically while maintaining quality | During implementation |
31
+ | `review-compound.md` | Multi-pass code review (Security via MCP, Perf, Architecture) | After work complete |
32
+ | `compound.md` | Document reusable knowledge to compound project capability | After solving problems |
33
+
34
+ ### 🟡 Supporting Workflows
35
+
36
+ | Workflow | Purpose |
37
+ |----------|---------|
38
+ | `explore.md` | Deep investigation, best practices, and systematic analysis |
39
+ | `specs.md` | Create and manage specifications for multi-session initiatives |
40
+ | `housekeeping.md` | Pre-push cleanup to archive completed items |
41
+ | `triage.md` | Prioritize findings from code reviews |
42
+
43
+ ## Core Loop
44
+
45
+ ```
46
+ /explore (optional) → /specs (large) → /plan-compound (per phase) → /plan_review → /work → /review-compound → /compound → /housekeeping → repeat
47
+ ```
48
+
49
+ | Command | When | Purpose |
50
+ |---------|------|---------|
51
+ | `/explore` | Before planning | Deep investigation, best practices, multi-order analysis |
52
+ | `/specs` | Major initiatives | Create structured specification with phases |
53
+ | `/plan-compound` | Before sig. work | Transform descriptions into well-structured project plans |
54
+ | `/plan_review` | Pre-execution | Review implementation plans for quality and completeness |
55
+ | `/work` | Implementation | Execute work plans systematically while maintaining quality |
56
+ | `/review-compound`| Post-work | Perform comprehensive multi-pass code review with MCP security |
57
+ | `/compound` | Post-solution | Document reusable knowledge to compound project capability |
58
+ | `/cycle` | Small tasks | Orchestrate full "plan → review → work → review → compound" lifecycle |
59
+ | `/housekeeping` | Pre-push | Archive completed work, validate repo health |
60
+
61
+ ## Support Commands
62
+
63
+ ### Todos & Triage
64
+ | Command | Purpose |
65
+ |---------|---------|
66
+ | `/triage` | Triage and prioritize findings from code reviews |
67
+ | `/triage-sprint` | Batch process pending todos to unblock triage bottlenecks |
68
+ | `/resolve_todo` | Resolve multiple todo items efficiently |
69
+
70
+ ### Code Review & Quality
71
+ | Command | Purpose |
72
+ |---------|---------|
73
+ | `/resolve_pr` | Handle PR comments and review feedback efficiently |
74
+ | `/plan_review` | Review implementation plans for quality |
75
+ | `/review-compound` | Perform multi-pass code review with security, performance, & architecture checks |
76
+
77
+ ### Architecture & Context
78
+ | Command | Purpose |
79
+ |---------|---------|
80
+ | `/adr` | Create a new Architecture Decision Record |
81
+ | `/map-codebase` | Map existing codebase architecture, tech stack, and conventions |
82
+ | `/doc` | Update folder-level documentation and component changelogs |
83
+ | `/kit-setup` | Interactive project setup wizard creating context files |
84
+
85
+ ### Release & Docs
86
+ | Command | Purpose |
87
+ |---------|---------|
88
+ | `/changelog` | Generate changelog entries from commits |
89
+ | `/release-docs` | Prepare release documentation |
90
+ | `/deploy-docs` | Deploy documentation updates |
91
+
92
+ ### Debugging
93
+ | Command | Purpose |
94
+ |---------|---------|
95
+ | `/report-bug` | Report bugs with structured reproduction steps |
96
+ | `/reproduce-bug` | Reproduce reported bugs systematically |
97
+
98
+ ### Skills & Extensions
99
+ | Command | Purpose |
100
+ |---------|---------|
101
+ | `/create-agent-skill` | Create new skills for extending agent capabilities |
102
+ | `/heal-skill` | Diagnose and fix broken skills |
103
+ | `/generate_command` | Create new workflow commands dynamically |
104
+ | `/skill-review` | Weekly review of potential new agent skills discovered from usage |
105
+
106
+ ### Maintenance & Health
107
+ | Command | Purpose |
108
+ |---------|---------|
109
+ | `/compound_health` | Check the improved Compound System's health and usage metrics |
110
+ | `/promote_pattern` | Promote a recurring issue to a critical pattern |
111
+
112
+ ### Platform-Specific
113
+ | Command | Purpose |
114
+ |---------|---------|
115
+ | `/xcode-test` | Run Xcode tests for iOS applications |
116
+
117
+ ### Modular Skills
118
+ | Skill | Purpose | Entry Point |
119
+ |-------|---------|-------------|
120
+ | `session-resume` | Establish session state | `skills/session-resume/SKILL.md` |
121
+ | `compound-docs` | Search/Document solutions | `skills/compound-docs/SKILL.md` |
122
+ | `file-todos` | Manage file-based tasks | `skills/file-todos/SKILL.md` |
123
+ | `code-review` | Systematic quality gates | `skills/code-review/SKILL.md` |
124
+ | `testing` | Unified test patterns | `skills/testing/SKILL.md` |
125
+ | `debug` | Structured root cause analysis | `skills/debug/SKILL.md` |
126
+
127
+ ---
128
+
129
+ ## Before You Start Any Work
130
+
131
+ ### 1. Resume Session (STRICTLY REQUIRED)
132
+
133
+ Always run this first when starting a new conversation:
134
+ ```bash
135
+ # Read and follow the checklist
136
+ cat skills/session-resume/SKILL.md
137
+ ```
138
+
139
+ ### 2. Search Existing Solutions
140
+
141
+ ```bash
142
+ # Check if this problem was solved before
143
+ grep -r "{keywords}" docs/solutions/
144
+
145
+ # Check critical patterns
146
+ cat docs/solutions/patterns/critical-patterns.md
147
+ ```
148
+
149
+ ### 3. Check Pending Work
150
+
151
+ ```bash
152
+ # Any active specs?
153
+ ls docs/specs/*/README.md 2>/dev/null | grep -v templates
154
+
155
+ # Any ready todos?
156
+ ls todos/*-ready-*.md 2>/dev/null
157
+
158
+ # Any in-progress plans?
159
+ ls plans/*.md 2>/dev/null
160
+ ```
161
+
162
+ ---
163
+
164
+ ## Directory Structure
165
+
166
+ ```
167
+ skills/workflows/ # You are here - all workflow definitions
168
+ docs/solutions/ # Persistent knowledge base
169
+ ├── patterns/ # Critical patterns (READ FIRST)
170
+ ├── schema.yaml # Solution validation schema
171
+ └── {categories}/ # Categorized solutions
172
+ docs/explorations/ # Deep investigations & research
173
+ skills/ # Modular capabilities
174
+ plans/ # Implementation plans from /plan
175
+ └── archive/ # Completed plans
176
+ todos/ # Work items from /review, /triage
177
+ └── archive/ # Completed todos
178
+ docs/specs/ # Multi-session specifications
179
+ └── archive/ # Completed specs
180
+ ```
181
+
182
+ ---
183
+
184
+ ## Key Principles
185
+
186
+ 1. **Search before solving** - Check `docs/solutions/` and `docs/explorations/`
187
+ 2. **Document after solving** - Run `/compound` when you fix something
188
+ 3. **Follow patterns** - Reference `critical-patterns.md`
189
+ 4. **Create todos for deferred work** - Don't just document in artifacts
190
+ 5. **Use conventional commits** - Enables changelog automation
191
+ 6. **Housekeeping before push** - Run `/housekeeping` to archive completed work
192
+
193
+ ---
194
+
195
+ ## Changelog
196
+
197
+ ### 2026-01-24
198
+ - Added Purpose, Components, and Component Details sections
199
+ - Restructured for documentation validation compliance
200
+
201
+ ### 2025-12-20
202
+ - Added modular skills section
203
+ - Updated core loop documentation