@intentsolutionsio/sprint 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 (38) hide show
  1. package/.claude-plugin/plugin.json +23 -0
  2. package/LICENSE +21 -0
  3. package/README.md +320 -0
  4. package/agents/allpurpose-agent.md +159 -0
  5. package/agents/cicd-agent.md +189 -0
  6. package/agents/nextjs-dev.md +204 -0
  7. package/agents/nextjs-diagnostics-agent.md +206 -0
  8. package/agents/project-architect.md +398 -0
  9. package/agents/python-dev.md +159 -0
  10. package/agents/qa-test-agent.md +192 -0
  11. package/agents/ui-test-agent.md +295 -0
  12. package/agents/website-designer.md +48 -0
  13. package/commands/clean.md +153 -0
  14. package/commands/generate-map.md +160 -0
  15. package/commands/new.md +173 -0
  16. package/commands/setup.md +239 -0
  17. package/commands/sprint.md +482 -0
  18. package/commands/test.md +183 -0
  19. package/package.json +44 -0
  20. package/skills/agent-patterns/SKILL.md +103 -0
  21. package/skills/agent-patterns/references/errors.md +8 -0
  22. package/skills/agent-patterns/references/examples.md +291 -0
  23. package/skills/agent-patterns/references/ui-test-report.md +35 -0
  24. package/skills/api-contract/SKILL.md +115 -0
  25. package/skills/api-contract/references/best-practices.md +47 -0
  26. package/skills/api-contract/references/errors.md +8 -0
  27. package/skills/api-contract/references/examples.md +448 -0
  28. package/skills/api-contract/references/pagination.md +46 -0
  29. package/skills/api-contract/references/typescript-interfaces.md +46 -0
  30. package/skills/api-contract/references/writing-endpoints.md +45 -0
  31. package/skills/spec-writing/SKILL.md +110 -0
  32. package/skills/spec-writing/references/errors.md +8 -0
  33. package/skills/spec-writing/references/examples.md +274 -0
  34. package/skills/spec-writing/references/testing-configuration.md +40 -0
  35. package/skills/sprint-workflow/SKILL.md +81 -0
  36. package/skills/sprint-workflow/references/errors.md +8 -0
  37. package/skills/sprint-workflow/references/examples.md +317 -0
  38. package/skills/sprint-workflow/references/sprint-phases.md +54 -0
@@ -0,0 +1,160 @@
1
+ ---
2
+ name: generate-map
3
+ description: Analyze codebase and generate a comprehensive project-map.md overview
4
+ argument-hint: "[--force]"
5
+ ---
6
+
7
+ # Generate Project Map Command
8
+
9
+ You are generating a comprehensive `.claude/project-map.md` file for this codebase.
10
+
11
+ ## Your Task
12
+
13
+ Analyze the entire codebase and create a clear, concise project map that a new developer can read in a few minutes to understand the system.
14
+
15
+ ## Workflow
16
+
17
+ 1. **Scan the codebase structure**
18
+ - List all top-level directories
19
+ - Identify the main technology stack
20
+ - Find configuration files (package.json, pyproject.toml, docker-compose.yml, etc.)
21
+
22
+ 2. **Identify the tech stack**
23
+ - Backend framework and language
24
+ - Frontend framework (if any)
25
+ - Database(s)
26
+ - Infrastructure (Docker, K8s, cloud services)
27
+ - Key libraries and dependencies
28
+
29
+ 3. **Map the project structure**
30
+ - Main folders and their responsibilities
31
+ - Entry points and important files
32
+ - Configuration locations
33
+
34
+ 4. **Document the API surface** (if applicable)
35
+ - Main endpoints grouped by domain
36
+ - Authentication method
37
+ - Link to OpenAPI/Swagger if available
38
+
39
+ 5. **Document the database** (if applicable)
40
+ - Main entities and relationships
41
+ - Migration tool and location
42
+
43
+ 6. **Document the frontend** (if applicable)
44
+ - Main pages/routes
45
+ - Component organization
46
+ - State management approach
47
+
48
+ 7. **Document infrastructure**
49
+ - How to run the project locally
50
+ - Docker services and ports
51
+ - Environment variables needed
52
+
53
+ 8. **Document testing**
54
+ - Test frameworks in use
55
+ - How to run tests
56
+
57
+ ## Output Format
58
+
59
+ Create/overwrite `.claude/project-map.md` with this structure:
60
+
61
+ ```markdown
62
+ # Project Map
63
+
64
+ > Auto-generated overview of the codebase. Last updated: [date]
65
+
66
+ ## Tech Stack
67
+
68
+ - **Backend:** [framework, language, version]
69
+ - **Frontend:** [framework, language, version]
70
+ - **Database:** [type, version]
71
+ - **Infrastructure:** [Docker, etc.]
72
+ - **Key Libraries:** [list]
73
+
74
+ ## Project Structure
75
+
76
+ ```
77
+ /
78
+ ├── backend/ # [description]
79
+ ├── frontend/ # [description]
80
+ ├── ...
81
+ ```
82
+
83
+ ## API Surface
84
+
85
+ ### [Domain 1]
86
+ - `GET /api/...` - [description]
87
+ - `POST /api/...` - [description]
88
+
89
+ ### [Domain 2]
90
+ ...
91
+
92
+ ## Database Schema
93
+
94
+ Main entities:
95
+ - **Entity1** - [description, key fields]
96
+ - **Entity2** - [description, key fields]
97
+
98
+ Relationships: [brief description]
99
+
100
+ ## Frontend Architecture
101
+
102
+ Main routes:
103
+ - `/` - [description]
104
+ - `/dashboard` - [description]
105
+
106
+ Key components: [list]
107
+
108
+ ## Infrastructure
109
+
110
+ ### Local Development
111
+ ```bash
112
+ # Commands to run the project
113
+ ```
114
+
115
+ ### Docker Services
116
+ | Service | Port | Description |
117
+ |---------|------|-------------|
118
+ | ... | ... | ... |
119
+
120
+ ### Environment Variables
121
+ | Variable | Purpose | Required |
122
+ |----------|---------|----------|
123
+ | ... | ... | ... |
124
+
125
+ ## Testing
126
+
127
+ - **Framework:** [pytest/jest/etc.]
128
+ - **Run tests:** `[command]`
129
+
130
+ ## Development Workflow
131
+
132
+ 1. [Setup step]
133
+ 2. [Run step]
134
+ 3. [Test step]
135
+
136
+ ## Current Features
137
+
138
+ - [Feature 1]
139
+ - [Feature 2]
140
+
141
+ ## Known Limitations
142
+
143
+ - [Limitation 1]
144
+ - [Limitation 2]
145
+ ```
146
+
147
+ ## Guidelines
148
+
149
+ - Keep it concise - aim for a document readable in 5 minutes
150
+ - Use bullet points and tables
151
+ - Link to detailed docs rather than copying content
152
+ - Remove any sections that don't apply
153
+ - Be accurate - verify information from actual files
154
+
155
+ ## After Generation
156
+
157
+ Report to the user:
158
+ - Summary of what was documented
159
+ - Any areas that need manual review
160
+ - Suggestions for missing documentation
@@ -0,0 +1,173 @@
1
+ ---
2
+ name: new
3
+ description: Create a new sprint directory with specs.md template
4
+ argument-hint: "[goal description]"
5
+ ---
6
+
7
+ # New Sprint Command
8
+
9
+ You are bootstrapping a new sprint for the user.
10
+
11
+ ## Workflow
12
+
13
+ ### Step 1: Determine Sprint Index
14
+
15
+ Find the next sprint number:
16
+ ```bash
17
+ # Get current highest sprint number
18
+ LAST=$(ls -d .claude/sprint/*/ 2>/dev/null | sort -V | tail -1 | grep -oE '[0-9]+' | tail -1)
19
+ if [ -z "$LAST" ]; then
20
+ NEXT=1
21
+ else
22
+ NEXT=$((LAST + 1))
23
+ fi
24
+ echo $NEXT
25
+ ```
26
+
27
+ ### Step 2: Create Sprint Directory
28
+
29
+ ```bash
30
+ mkdir -p .claude/sprint/[NEXT]
31
+ ```
32
+
33
+ ### Step 3: Gather Sprint Information
34
+
35
+ Ask the user for sprint details. Present this as a structured question:
36
+
37
+ **What would you like to build in this sprint?**
38
+
39
+ Options to clarify:
40
+ 1. **Goal**: What's the main objective? (1-2 sentences)
41
+ 2. **Scope**: What specific features or fixes?
42
+ 3. **Testing**:
43
+ - QA testing: required / optional / skip
44
+ - UI testing: required / optional / skip
45
+ - UI testing mode: automated / manual
46
+
47
+ ### Step 4: Create specs.md
48
+
49
+ Based on user input, create `.claude/sprint/[NEXT]/specs.md`:
50
+
51
+ ```markdown
52
+ # Sprint [NEXT] Specifications
53
+
54
+ ## Goal
55
+ [User's goal description]
56
+
57
+ ## Scope
58
+ [List of features/tasks]
59
+
60
+ ## Testing
61
+ - QA: [required/optional/skip]
62
+ - UI Testing: [required/optional/skip]
63
+ - UI Testing Mode: [automated/manual]
64
+
65
+ ## Notes
66
+ [Any additional context]
67
+ ```
68
+
69
+ ### Step 5: Suggest Next Steps
70
+
71
+ After creating the sprint, suggest:
72
+
73
+ ```
74
+ Sprint [NEXT] created at .claude/sprint/[NEXT]/
75
+
76
+ Next steps:
77
+ 1. Review and edit .claude/sprint/[NEXT]/specs.md if needed
78
+ 2. Run /sprint to start the sprint workflow
79
+ 3. The architect will analyze specs and create detailed specifications
80
+
81
+ Tip: For detailed specs, you can add:
82
+ - API endpoint details
83
+ - UI mockup descriptions
84
+ - Database schema changes
85
+ - Specific test scenarios
86
+ ```
87
+
88
+ ## Quick Mode
89
+
90
+ If the user provides a one-liner goal, create the sprint immediately:
91
+
92
+ Example: `/sprint:new Add user authentication with OAuth`
93
+
94
+ Creates:
95
+ ```markdown
96
+ # Sprint [N] Specifications
97
+
98
+ ## Goal
99
+ Add user authentication with OAuth
100
+
101
+ ## Scope
102
+ - To be analyzed by architect
103
+
104
+ ## Testing
105
+ - QA: required
106
+ - UI Testing: required
107
+ - UI Testing Mode: automated
108
+ ```
109
+
110
+ ## Templates
111
+
112
+ Offer templates for common sprint types:
113
+
114
+ ### Feature Sprint
115
+ ```markdown
116
+ # Sprint [N] Specifications
117
+
118
+ ## Goal
119
+ [New feature description]
120
+
121
+ ## Scope
122
+ - Backend API endpoints
123
+ - Frontend UI components
124
+ - Database migrations
125
+ - Tests
126
+
127
+ ## Testing
128
+ - QA: required
129
+ - UI Testing: required
130
+ - UI Testing Mode: automated
131
+ ```
132
+
133
+ ### Bug Fix Sprint
134
+ ```markdown
135
+ # Sprint [N] Specifications
136
+
137
+ ## Goal
138
+ Fix [bug description]
139
+
140
+ ## Scope
141
+ - Root cause analysis
142
+ - Fix implementation
143
+ - Regression tests
144
+
145
+ ## Testing
146
+ - QA: required
147
+ - UI Testing: optional
148
+ - UI Testing Mode: automated
149
+ ```
150
+
151
+ ### Refactoring Sprint
152
+ ```markdown
153
+ # Sprint [N] Specifications
154
+
155
+ ## Goal
156
+ Refactor [component/system]
157
+
158
+ ## Scope
159
+ - Code restructuring
160
+ - No functional changes
161
+ - Update tests if needed
162
+
163
+ ## Testing
164
+ - QA: required
165
+ - UI Testing: skip
166
+ ```
167
+
168
+ ## Output
169
+
170
+ Report to user:
171
+ - Sprint number and directory created
172
+ - Summary of specs.md content
173
+ - Next steps to proceed
@@ -0,0 +1,239 @@
1
+ ---
2
+ name: setup
3
+ description: Interactive project onboarding - creates project-goals.md and project-map.md
4
+ allowed-tools:
5
+ - Read
6
+ - Write
7
+ - Glob
8
+ - Grep
9
+ - Bash
10
+ - AskUserQuestion
11
+ ---
12
+
13
+ # Setup Command - Interactive Project Onboarding
14
+
15
+ Initialize a project for use with Sprint by creating the two "Second Brain" documents that guide all sprint work.
16
+
17
+ ## Overview
18
+
19
+ This command interactively creates:
20
+ 1. `.claude/project-goals.md` - Business vision and objectives (user-maintained)
21
+ 2. `.claude/project-map.md` - Technical architecture (architect-maintained)
22
+
23
+ ## Workflow
24
+
25
+ ### Step 1: Check Existing Files
26
+
27
+ Check if either file already exists:
28
+
29
+ ```bash
30
+ test -f .claude/project-goals.md && echo "GOALS_EXISTS" || echo "NO_GOALS"
31
+ test -f .claude/project-map.md && echo "MAP_EXISTS" || echo "NO_MAP"
32
+ ```
33
+
34
+ If files exist, ask the user:
35
+ - Overwrite existing files?
36
+ - Skip existing and create only missing?
37
+ - Abort setup?
38
+
39
+ ### Step 2: Create .claude Directory
40
+
41
+ Ensure the directory exists:
42
+
43
+ ```bash
44
+ mkdir -p .claude
45
+ ```
46
+
47
+ ### Step 3: Gather Project Goals (Interactive)
48
+
49
+ Use AskUserQuestion to gather business context:
50
+
51
+ **Question 1: Product Vision**
52
+ - "What is this project? Describe it in 1-2 sentences."
53
+
54
+ **Question 2: Target Users**
55
+ - "Who are the target users?"
56
+ - Options: "Developers", "End consumers", "Internal team", "Other"
57
+
58
+ **Question 3: Key Features**
59
+ - "What are the 3-5 most important features or capabilities?"
60
+
61
+ **Question 4: Success Metrics**
62
+ - "How will you measure success?"
63
+ - Options: "User adoption", "Revenue", "Performance metrics", "Other"
64
+
65
+ **Question 5: Constraints**
66
+ - "Any important constraints or requirements?"
67
+ - Examples: compliance, performance, technology restrictions
68
+
69
+ ### Step 4: Generate project-goals.md
70
+
71
+ Write the gathered information to `.claude/project-goals.md`:
72
+
73
+ ```markdown
74
+ # Project Goals
75
+
76
+ ## Vision
77
+ [User's product vision]
78
+
79
+ ## Target Users
80
+ [Target audience description]
81
+
82
+ ## Key Features
83
+ - [Feature 1]
84
+ - [Feature 2]
85
+ - [Feature 3]
86
+
87
+ ## Success Metrics
88
+ [How success is measured]
89
+
90
+ ## Constraints
91
+ [Important constraints and requirements]
92
+
93
+ ---
94
+ *This file is maintained by the user. Update it when business objectives change.*
95
+ ```
96
+
97
+ ### Step 5: Scan Codebase
98
+
99
+ Analyze the project structure:
100
+
101
+ ```bash
102
+ # List top-level structure
103
+ ls -la
104
+
105
+ # Find key configuration files
106
+ find . -maxdepth 2 -name "package.json" -o -name "pyproject.toml" -o -name "Cargo.toml" -o -name "go.mod" -o -name "*.csproj" 2>/dev/null
107
+
108
+ # Check for common frameworks
109
+ test -f next.config.js -o -f next.config.ts && echo "NEXTJS"
110
+ test -f nuxt.config.ts && echo "NUXT"
111
+ test -f angular.json && echo "ANGULAR"
112
+ test -f vite.config.ts && echo "VITE"
113
+ test -d backend -o -f requirements.txt -o -f pyproject.toml && echo "PYTHON"
114
+ test -f go.mod && echo "GO"
115
+ test -f Cargo.toml && echo "RUST"
116
+ ```
117
+
118
+ Read key files to understand the project:
119
+ - README.md (if exists)
120
+ - package.json / pyproject.toml / etc.
121
+ - Docker configuration
122
+ - CI/CD files
123
+
124
+ ### Step 6: Gather Technical Context (Interactive)
125
+
126
+ Ask clarifying questions based on scan results:
127
+
128
+ **Question: Tech Stack Confirmation**
129
+ - "I detected [frameworks]. Is this correct?"
130
+ - Allow corrections
131
+
132
+ **Question: Architecture Style**
133
+ - Options: "Monolith", "Microservices", "Serverless", "Monorepo", "Other"
134
+
135
+ **Question: Database**
136
+ - Options: "PostgreSQL", "MySQL", "MongoDB", "SQLite", "None/Other"
137
+
138
+ **Question: Deployment**
139
+ - Options: "Docker", "Kubernetes", "Serverless", "Traditional hosting", "Not yet decided"
140
+
141
+ ### Step 7: Generate project-map.md
142
+
143
+ Create `.claude/project-map.md` with discovered and confirmed information:
144
+
145
+ ```markdown
146
+ # Project Map
147
+
148
+ ## Tech Stack
149
+
150
+ ### Backend
151
+ - Language: [detected/confirmed]
152
+ - Framework: [detected/confirmed]
153
+ - Database: [confirmed]
154
+
155
+ ### Frontend
156
+ - Framework: [detected/confirmed]
157
+ - Styling: [detected]
158
+
159
+ ### Infrastructure
160
+ - Deployment: [confirmed]
161
+ - CI/CD: [detected]
162
+
163
+ ## Project Structure
164
+
165
+ ```
166
+ [directory tree of main folders]
167
+ ```
168
+
169
+ ## Key Components
170
+
171
+ ### [Component 1]
172
+ - Location: [path]
173
+ - Purpose: [description]
174
+
175
+ ### [Component 2]
176
+ - Location: [path]
177
+ - Purpose: [description]
178
+
179
+ ## Development Workflow
180
+
181
+ ### Running Locally
182
+ [commands to start the project]
183
+
184
+ ### Running Tests
185
+ [test commands]
186
+
187
+ ## Current Features
188
+ - [Feature 1]
189
+ - [Feature 2]
190
+
191
+ ## Known Limitations
192
+ - [Any detected issues or TODOs]
193
+
194
+ ---
195
+ *This file is maintained by the project-architect agent. Updated during sprints.*
196
+ ```
197
+
198
+ ### Step 8: Offer First Sprint
199
+
200
+ Ask the user:
201
+ - "Would you like to create your first sprint now?"
202
+
203
+ If yes, prompt for sprint goal and run `/sprint:new` logic.
204
+
205
+ If no, provide next steps:
206
+ ```
207
+ Setup complete!
208
+
209
+ Next steps:
210
+ 1. Review .claude/project-goals.md and adjust as needed
211
+ 2. Review .claude/project-map.md for accuracy
212
+ 3. Run /sprint:new to start your first sprint
213
+ ```
214
+
215
+ ## Error Handling
216
+
217
+ ### No Codebase Detected
218
+
219
+ If the directory appears empty or has no recognizable project structure:
220
+ - Ask if this is a new project
221
+ - Offer to create a minimal project-map.md for greenfield development
222
+ - Suggest running setup again after initial code is written
223
+
224
+ ### Permission Issues
225
+
226
+ If unable to write to .claude/:
227
+ - Report the error clearly
228
+ - Suggest checking directory permissions
229
+
230
+ ## Output
231
+
232
+ On completion, display:
233
+ ```
234
+ ✓ Created .claude/project-goals.md
235
+ ✓ Created .claude/project-map.md
236
+
237
+ Your project is ready for Sprint!
238
+ Run /sprint:new to begin.
239
+ ```