ai-sprint-kit 1.1.9 → 1.2.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.
- package/README.md +19 -19
- package/package.json +1 -1
- package/templates/.claude/agents/debugger.md +1 -1
- package/templates/.claude/agents/devops.md +1 -1
- package/templates/.claude/agents/docs.md +1 -1
- package/templates/.claude/agents/implementer.md +2 -2
- package/templates/.claude/agents/planner.md +1 -1
- package/templates/.claude/agents/reviewer.md +1 -1
- package/templates/.claude/agents/tester.md +3 -3
- package/templates/.claude/commands/{auto.md → ai-sprint-auto.md} +15 -15
- package/templates/.claude/commands/{code.md → ai-sprint-code.md} +19 -19
- package/templates/.claude/commands/{debug.md → ai-sprint-debug.md} +10 -10
- package/templates/.claude/commands/{deploy.md → ai-sprint-deploy.md} +7 -7
- package/templates/.claude/commands/{docs.md → ai-sprint-docs.md} +8 -8
- package/templates/.claude/commands/{plan.md → ai-sprint-plan.md} +3 -3
- package/templates/.claude/commands/{review.md → ai-sprint-review.md} +7 -7
- package/templates/.claude/commands/{scan.md → ai-sprint-scan.md} +15 -15
- package/templates/.claude/commands/{secure.md → ai-sprint-secure.md} +4 -4
- package/templates/.claude/commands/{test.md → ai-sprint-test.md} +9 -9
- package/templates/.claude/commands/{validate.md → ai-sprint-validate.md} +18 -18
- package/templates/.claude/skills/codebase-context/SKILL.md +9 -9
- package/templates/.claude/skills/codebase-context/references/refresh-triggers.md +3 -3
- package/templates/.claude/skills/implementation/SKILL.md +2 -2
- package/templates/.claude/skills/planning/SKILL.md +3 -3
- package/templates/.claude/skills/planning/references/plan-templates.md +1 -1
- package/templates/.claude/skills/planning/references/research-phase.md +1 -1
- package/templates/.claude/skills/quality-assurance/SKILL.md +2 -2
- package/templates/.claude/workflows/development-rules.md +4 -4
- package/templates/CLAUDE.md +42 -42
- package/templates/README.md +37 -37
- package/templates/docs/user-guide-th.md +64 -64
- package/templates/docs/user-guide.md +94 -94
|
@@ -3,16 +3,16 @@ description: Run comprehensive security scan (SAST + secrets + dependencies)
|
|
|
3
3
|
argument-hint: [path or scope]
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
## Command: /secure
|
|
6
|
+
## Command: /ai-sprint-secure
|
|
7
7
|
|
|
8
8
|
Run security scans to detect vulnerabilities, secrets, and dependency issues.
|
|
9
9
|
|
|
10
10
|
## Usage
|
|
11
11
|
|
|
12
12
|
```
|
|
13
|
-
/secure
|
|
14
|
-
/secure src/
|
|
15
|
-
/secure --full
|
|
13
|
+
/ai-sprint-secure
|
|
14
|
+
/ai-sprint-secure src/
|
|
15
|
+
/ai-sprint-secure --full
|
|
16
16
|
```
|
|
17
17
|
|
|
18
18
|
## Scan Types
|
|
@@ -3,16 +3,16 @@ description: Generate and run automated tests with coverage analysis
|
|
|
3
3
|
argument-hint: [optional: specific file or feature to test]
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
## Command: /test
|
|
6
|
+
## Command: /ai-sprint-test
|
|
7
7
|
|
|
8
8
|
Generate comprehensive test suites and run them with coverage analysis. Ensures >80% code coverage with focus on critical paths.
|
|
9
9
|
|
|
10
10
|
## Usage
|
|
11
11
|
|
|
12
12
|
```
|
|
13
|
-
/test
|
|
14
|
-
/test src/auth/
|
|
15
|
-
/test "payment processing"
|
|
13
|
+
/ai-sprint-test
|
|
14
|
+
/ai-sprint-test src/auth/
|
|
15
|
+
/ai-sprint-test "payment processing"
|
|
16
16
|
```
|
|
17
17
|
|
|
18
18
|
## Workflow
|
|
@@ -262,13 +262,13 @@ Tests are successful when:
|
|
|
262
262
|
|
|
263
263
|
## Integration with Other Commands
|
|
264
264
|
|
|
265
|
-
**/code** → **/test**
|
|
266
|
-
- After generating code, run /test to create test suite
|
|
265
|
+
**/ai-sprint-code** → **/ai-sprint-test**
|
|
266
|
+
- After generating code, run /ai-sprint-test to create test suite
|
|
267
267
|
|
|
268
|
-
**/test** → **/review**
|
|
269
|
-
- After tests pass, run /review for quality check
|
|
268
|
+
**/ai-sprint-test** → **/ai-sprint-review**
|
|
269
|
+
- After tests pass, run /ai-sprint-review for quality check
|
|
270
270
|
|
|
271
|
-
**/test** → **/secure**
|
|
271
|
+
**/ai-sprint-test** → **/ai-sprint-secure**
|
|
272
272
|
- Security tests complement security scanning
|
|
273
273
|
|
|
274
274
|
## Test Quality
|
|
@@ -3,16 +3,16 @@ description: Run comprehensive validation (tests + review + security + coverage)
|
|
|
3
3
|
argument-hint: [optional: path or scope]
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
## Command: /validate
|
|
6
|
+
## Command: /ai-sprint-validate
|
|
7
7
|
|
|
8
8
|
Run all validation checks in one command: tests, code review, security scan, and coverage analysis.
|
|
9
9
|
|
|
10
10
|
## Usage
|
|
11
11
|
|
|
12
12
|
```
|
|
13
|
-
/validate
|
|
14
|
-
/validate src/
|
|
15
|
-
/validate --strict
|
|
13
|
+
/ai-sprint-validate
|
|
14
|
+
/ai-sprint-validate src/
|
|
15
|
+
/ai-sprint-validate --strict
|
|
16
16
|
```
|
|
17
17
|
|
|
18
18
|
## Workflow
|
|
@@ -43,7 +43,7 @@ Check `ai_context/memory/learning.md` for known validation issues.
|
|
|
43
43
|
- OWASP Top 10 compliance
|
|
44
44
|
|
|
45
45
|
### 4. Generate Report
|
|
46
|
-
Save to: `ai_context/reports/validate-{timestamp}.md`
|
|
46
|
+
Save to: `ai_context/reports/ai-sprint-validate-{timestamp}.md`
|
|
47
47
|
|
|
48
48
|
## Validation Checks
|
|
49
49
|
|
|
@@ -149,24 +149,24 @@ or
|
|
|
149
149
|
### --strict
|
|
150
150
|
Fail on any warning-level issue:
|
|
151
151
|
```
|
|
152
|
-
/validate --strict
|
|
152
|
+
/ai-sprint-validate --strict
|
|
153
153
|
```
|
|
154
154
|
|
|
155
155
|
### --fix
|
|
156
156
|
Auto-fix fixable issues:
|
|
157
157
|
```
|
|
158
|
-
/validate --fix
|
|
158
|
+
/ai-sprint-validate --fix
|
|
159
159
|
```
|
|
160
160
|
|
|
161
161
|
### --coverage N
|
|
162
162
|
Set custom coverage threshold:
|
|
163
163
|
```
|
|
164
|
-
/validate --coverage 90
|
|
164
|
+
/ai-sprint-validate --coverage 90
|
|
165
165
|
```
|
|
166
166
|
|
|
167
167
|
## Agent Delegation
|
|
168
168
|
|
|
169
|
-
`/validate` orchestrates multiple agents:
|
|
169
|
+
`/ai-sprint-validate` orchestrates multiple agents:
|
|
170
170
|
|
|
171
171
|
1. **Tester Agent** - Run tests, check coverage
|
|
172
172
|
2. **Reviewer Agent** - Code quality analysis
|
|
@@ -179,14 +179,14 @@ Results are aggregated into single report.
|
|
|
179
179
|
### Pre-Commit
|
|
180
180
|
```bash
|
|
181
181
|
# Run before each commit
|
|
182
|
-
/validate || exit 1
|
|
182
|
+
/ai-sprint-validate || exit 1
|
|
183
183
|
```
|
|
184
184
|
|
|
185
185
|
### CI/CD Pipeline
|
|
186
186
|
```yaml
|
|
187
187
|
- name: Validate
|
|
188
188
|
run: |
|
|
189
|
-
/validate --strict
|
|
189
|
+
/ai-sprint-validate --strict
|
|
190
190
|
if [ $? -ne 0 ]; then
|
|
191
191
|
echo "Validation failed"
|
|
192
192
|
exit 1
|
|
@@ -200,21 +200,21 @@ Before validation:
|
|
|
200
200
|
|
|
201
201
|
After validation:
|
|
202
202
|
- Update `ai_context/memory/learning.md` with new patterns
|
|
203
|
-
- Save report to `ai_context/reports/validate-{timestamp}.md`
|
|
203
|
+
- Save report to `ai_context/reports/ai-sprint-validate-{timestamp}.md`
|
|
204
204
|
|
|
205
205
|
## Common Issues
|
|
206
206
|
|
|
207
207
|
### Low Coverage
|
|
208
208
|
- Identify untested code
|
|
209
|
-
- Generate missing tests with `/test`
|
|
209
|
+
- Generate missing tests with `/ai-sprint-test`
|
|
210
210
|
|
|
211
211
|
### Security Vulnerabilities
|
|
212
|
-
- Fix immediately with `/code`
|
|
213
|
-
- Re-run `/secure` to verify
|
|
212
|
+
- Fix immediately with `/ai-sprint-code`
|
|
213
|
+
- Re-run `/ai-sprint-secure` to verify
|
|
214
214
|
|
|
215
215
|
### Code Quality
|
|
216
|
-
- Refactor with `/code`
|
|
217
|
-
- Re-run `/review` to verify
|
|
216
|
+
- Refactor with `/ai-sprint-code`
|
|
217
|
+
- Re-run `/ai-sprint-review` to verify
|
|
218
218
|
|
|
219
219
|
## Success Criteria
|
|
220
220
|
|
|
@@ -230,7 +230,7 @@ Validation passes when:
|
|
|
230
230
|
|
|
231
231
|
**Validation is the last gate before deployment.**
|
|
232
232
|
|
|
233
|
-
Run `/validate` before:
|
|
233
|
+
Run `/ai-sprint-validate` before:
|
|
234
234
|
- Committing code
|
|
235
235
|
- Creating pull requests
|
|
236
236
|
- Deploying to any environment
|
|
@@ -1,26 +1,26 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: codebase-context
|
|
3
|
-
description: Efficient codebase understanding using scanned context. Activate when starting work on existing projects or after major code changes. Reads ai_context/codebase/ documents for project structure and compressed code overview.
|
|
3
|
+
description: Efficient codebase understanding using scanned context. Activate when starting work on existing projects or after major code changes. Reads ai_context/ai-sprint-codebase/ documents for project structure and compressed code overview.
|
|
4
4
|
license: MIT
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# Codebase Context
|
|
8
8
|
|
|
9
|
-
Understand existing codebases efficiently using ai_context/codebase/ documents.
|
|
9
|
+
Understand existing codebases efficiently using ai_context/ai-sprint-codebase/ documents.
|
|
10
10
|
|
|
11
11
|
## When to Use
|
|
12
12
|
|
|
13
13
|
**Starting work on existing project:**
|
|
14
|
-
1. Check if `ai_context/codebase/` exists
|
|
14
|
+
1. Check if `ai_context/ai-sprint-codebase/` exists
|
|
15
15
|
2. Read structure.md for project layout
|
|
16
16
|
3. Read overview.md for compressed codebase
|
|
17
17
|
|
|
18
18
|
**After major changes:**
|
|
19
|
-
- Run `/scan` to refresh context
|
|
19
|
+
- Run `/ai-sprint-scan` to refresh context
|
|
20
20
|
|
|
21
21
|
## Context Files
|
|
22
22
|
|
|
23
|
-
Located in `ai_context/codebase/`:
|
|
23
|
+
Located in `ai_context/ai-sprint-codebase/`:
|
|
24
24
|
|
|
25
25
|
| File | Purpose | When to Read |
|
|
26
26
|
|------|---------|--------------|
|
|
@@ -41,13 +41,13 @@ Load: `references/refresh-triggers.md`
|
|
|
41
41
|
|
|
42
42
|
```bash
|
|
43
43
|
# Check if context exists
|
|
44
|
-
ls ai_context/codebase/
|
|
44
|
+
ls ai_context/ai-sprint-codebase/
|
|
45
45
|
|
|
46
46
|
# Read structure first (fast overview)
|
|
47
|
-
cat ai_context/codebase/structure.md
|
|
47
|
+
cat ai_context/ai-sprint-codebase/structure.md
|
|
48
48
|
|
|
49
49
|
# Then read overview (comprehensive)
|
|
50
|
-
cat ai_context/codebase/overview.md
|
|
50
|
+
cat ai_context/ai-sprint-codebase/overview.md
|
|
51
51
|
```
|
|
52
52
|
|
|
53
53
|
## Token Efficiency
|
|
@@ -65,4 +65,4 @@ Before planning or implementing:
|
|
|
65
65
|
1. Check if codebase context exists
|
|
66
66
|
2. Read structure for project layout
|
|
67
67
|
3. Reference patterns from overview
|
|
68
|
-
4. Refresh with `/scan` if stale (>1 day)
|
|
68
|
+
4. Refresh with `/ai-sprint-scan` if stale (>1 day)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Refresh Triggers
|
|
4
4
|
|
|
5
|
-
Run `/scan` command when:
|
|
5
|
+
Run `/ai-sprint-scan` command when:
|
|
6
6
|
|
|
7
7
|
### 1. After Major Changes
|
|
8
8
|
- New features added
|
|
@@ -25,7 +25,7 @@ Run `/scan` command when:
|
|
|
25
25
|
|
|
26
26
|
```bash
|
|
27
27
|
# Check when last scanned
|
|
28
|
-
cat ai_context/codebase/scan-metadata.json
|
|
28
|
+
cat ai_context/ai-sprint-codebase/ai-sprint-scan-metadata.json
|
|
29
29
|
|
|
30
30
|
# Look for scanDate field
|
|
31
31
|
# Compare with today's date
|
|
@@ -62,7 +62,7 @@ large-data/
|
|
|
62
62
|
|
|
63
63
|
```bash
|
|
64
64
|
# Using Claude command
|
|
65
|
-
/scan
|
|
65
|
+
/ai-sprint-scan
|
|
66
66
|
|
|
67
67
|
# Using CLI directly
|
|
68
68
|
ai-sprint-kit scan
|
|
@@ -26,9 +26,9 @@ Production-grade coding patterns with security-first approach.
|
|
|
26
26
|
|
|
27
27
|
```
|
|
28
28
|
1. Read ai_context/memory/learning.md (avoid past mistakes)
|
|
29
|
-
2. Read relevant plan in ai_context/plans/
|
|
29
|
+
2. Read relevant plan in ai_context/ai-sprint-plans/
|
|
30
30
|
3. Understand existing patterns in codebase
|
|
31
|
-
4. Check ai_context/codebase/structure.md for project layout
|
|
31
|
+
4. Check ai_context/ai-sprint-codebase/structure.md for project layout
|
|
32
32
|
```
|
|
33
33
|
|
|
34
34
|
## Security Requirements
|
|
@@ -28,7 +28,7 @@ Structured approach to technical planning with research, analysis, and documenta
|
|
|
28
28
|
### Phase 1: Context Gathering
|
|
29
29
|
```
|
|
30
30
|
1. Check ai_context/memory/learning.md (avoid past mistakes)
|
|
31
|
-
2. Read ai_context/codebase/structure.md (project layout)
|
|
31
|
+
2. Read ai_context/ai-sprint-codebase/structure.md (project layout)
|
|
32
32
|
3. Review existing patterns in codebase
|
|
33
33
|
4. Research external solutions if needed
|
|
34
34
|
```
|
|
@@ -40,11 +40,11 @@ Load: `references/research-phase.md`
|
|
|
40
40
|
Load: `references/solution-design.md`
|
|
41
41
|
|
|
42
42
|
### Phase 4: Documentation
|
|
43
|
-
Load: `references/plan-templates.md`
|
|
43
|
+
Load: `references/ai-sprint-plan-templates.md`
|
|
44
44
|
|
|
45
45
|
## Output Structure
|
|
46
46
|
|
|
47
|
-
Plans saved to: `ai_context/plans/{timestamp}-{name}/`
|
|
47
|
+
Plans saved to: `ai_context/ai-sprint-plans/{timestamp}-{name}/`
|
|
48
48
|
|
|
49
49
|
```
|
|
50
50
|
{timestamp}-{name}/
|
|
@@ -37,11 +37,11 @@ Combined testing and review standards for production-grade code.
|
|
|
37
37
|
|
|
38
38
|
## Testing Strategy
|
|
39
39
|
|
|
40
|
-
Load: `references/testing-strategy.md`
|
|
40
|
+
Load: `references/ai-sprint-testing-strategy.md`
|
|
41
41
|
|
|
42
42
|
## Review Checklist
|
|
43
43
|
|
|
44
|
-
Load: `references/review-checklist.md`
|
|
44
|
+
Load: `references/ai-sprint-review-checklist.md`
|
|
45
45
|
|
|
46
46
|
## Security Checklist
|
|
47
47
|
|
|
@@ -77,16 +77,16 @@ Every agent must follow:
|
|
|
77
77
|
- Include date from bash command
|
|
78
78
|
|
|
79
79
|
### Plans
|
|
80
|
-
- Save to `ai_context/plans/` with timestamped folder
|
|
80
|
+
- Save to `ai_context/ai-sprint-plans/` with timestamped folder
|
|
81
81
|
- Use format: `{YYMMDD-HHMM}-{feature}/`
|
|
82
82
|
- Include phase files if complex
|
|
83
83
|
|
|
84
84
|
## Review Before Commit
|
|
85
85
|
|
|
86
86
|
All code changes must pass:
|
|
87
|
-
1. `/test` - All tests pass
|
|
88
|
-
2. `/review` - Code quality check
|
|
89
|
-
3. `/secure` - Security scan
|
|
87
|
+
1. `/ai-sprint-test` - All tests pass
|
|
88
|
+
2. `/ai-sprint-review` - Code quality check
|
|
89
|
+
3. `/ai-sprint-secure` - Security scan
|
|
90
90
|
|
|
91
91
|
## Human-in-the-Loop Gates
|
|
92
92
|
|
package/templates/CLAUDE.md
CHANGED
|
@@ -31,29 +31,29 @@ Guidance for Claude Code when using AI Sprint Framework.
|
|
|
31
31
|
|
|
32
32
|
### Full Automation (Recommended)
|
|
33
33
|
```bash
|
|
34
|
-
/auto "implement user registration with email verification"
|
|
34
|
+
/ai-sprint-auto "implement user registration with email verification"
|
|
35
35
|
```
|
|
36
36
|
Executes: plan → code → test → review → security → docs
|
|
37
37
|
|
|
38
38
|
### Manual Workflow
|
|
39
39
|
```bash
|
|
40
|
-
/plan "feature description" # 1. Create architecture
|
|
41
|
-
/code "implement the plan" # 2. Generate code
|
|
42
|
-
/test # 3. Test + coverage
|
|
43
|
-
/review # 4. Code quality
|
|
44
|
-
/secure # 5. Security scan
|
|
45
|
-
/deploy # 6. CI/CD setup
|
|
46
|
-
/docs # 7. Documentation
|
|
40
|
+
/ai-sprint-plan "feature description" # 1. Create architecture
|
|
41
|
+
/ai-sprint-code "implement the plan" # 2. Generate code
|
|
42
|
+
/ai-sprint-test # 3. Test + coverage
|
|
43
|
+
/ai-sprint-review # 4. Code quality
|
|
44
|
+
/ai-sprint-secure # 5. Security scan
|
|
45
|
+
/ai-sprint-deploy # 6. CI/CD setup
|
|
46
|
+
/ai-sprint-docs # 7. Documentation
|
|
47
47
|
```
|
|
48
48
|
|
|
49
49
|
### Quick Validation
|
|
50
50
|
```bash
|
|
51
|
-
/validate # Tests + review + security (before commit)
|
|
51
|
+
/ai-sprint-validate # Tests + review + security (before commit)
|
|
52
52
|
```
|
|
53
53
|
|
|
54
54
|
### Debugging Issues
|
|
55
55
|
```bash
|
|
56
|
-
/debug "describe the problem" # Root cause analysis
|
|
56
|
+
/ai-sprint-debug "describe the problem" # Root cause analysis
|
|
57
57
|
```
|
|
58
58
|
|
|
59
59
|
## Mandatory Security Requirements
|
|
@@ -73,9 +73,9 @@ Executes: plan → code → test → review → security → docs
|
|
|
73
73
|
- ✅ Edge case coverage
|
|
74
74
|
|
|
75
75
|
### Pre-Commit Gate
|
|
76
|
-
Always run `/validate` before pushing:
|
|
76
|
+
Always run `/ai-sprint-validate` before pushing:
|
|
77
77
|
```bash
|
|
78
|
-
/validate
|
|
78
|
+
/ai-sprint-validate
|
|
79
79
|
# Runs: tests + code review + security scan
|
|
80
80
|
# Blocks commit if: tests fail | coverage < 80% | security issues found
|
|
81
81
|
```
|
|
@@ -265,7 +265,7 @@ Before starting work on an existing project, read:
|
|
|
265
265
|
|
|
266
266
|
### Refreshing Context
|
|
267
267
|
|
|
268
|
-
Run `/scan` after major changes to update the codebase index.
|
|
268
|
+
Run `/ai-sprint-scan` after major changes to update the codebase index.
|
|
269
269
|
|
|
270
270
|
## Commands Reference
|
|
271
271
|
|
|
@@ -273,17 +273,17 @@ All commands have detailed docs in `.claude/commands/`:
|
|
|
273
273
|
|
|
274
274
|
| Command | Purpose | Usage |
|
|
275
275
|
|---------|---------|-------|
|
|
276
|
-
| `/plan` | Architecture | `/plan "implement feature"` |
|
|
277
|
-
| `/code` | Generate | `/code "write implementation"` |
|
|
278
|
-
| `/test` | Testing | `/test` (generates & runs) |
|
|
279
|
-
| `/review` | Quality | `/review` (analyzes code) |
|
|
280
|
-
| `/secure` | Security | `/secure src/` (scans directory) |
|
|
281
|
-
| `/deploy` | CI/CD | `/deploy` (sets up pipeline) |
|
|
282
|
-
| `/docs` | Docs | `/docs` (generates documentation) |
|
|
283
|
-
| `/debug` | Debugging | `/debug "issue description"` |
|
|
284
|
-
| `/scan` | Codebase | `/scan` (update AI context) |
|
|
285
|
-
| `/validate` | Gate | `/validate` (before commit) |
|
|
286
|
-
| `/auto` | Full Cycle | `/auto "feature description"` |
|
|
276
|
+
| `/ai-sprint-plan` | Architecture | `/ai-sprint-plan "implement feature"` |
|
|
277
|
+
| `/ai-sprint-code` | Generate | `/ai-sprint-code "write implementation"` |
|
|
278
|
+
| `/ai-sprint-test` | Testing | `/ai-sprint-test` (generates & runs) |
|
|
279
|
+
| `/ai-sprint-review` | Quality | `/ai-sprint-review` (analyzes code) |
|
|
280
|
+
| `/ai-sprint-secure` | Security | `/ai-sprint-secure src/` (scans directory) |
|
|
281
|
+
| `/ai-sprint-deploy` | CI/CD | `/ai-sprint-deploy` (sets up pipeline) |
|
|
282
|
+
| `/ai-sprint-docs` | Docs | `/ai-sprint-docs` (generates documentation) |
|
|
283
|
+
| `/ai-sprint-debug` | Debugging | `/ai-sprint-debug "issue description"` |
|
|
284
|
+
| `/ai-sprint-scan` | Codebase | `/ai-sprint-scan` (update AI context) |
|
|
285
|
+
| `/ai-sprint-validate` | Gate | `/ai-sprint-validate` (before commit) |
|
|
286
|
+
| `/ai-sprint-auto` | Full Cycle | `/ai-sprint-auto "feature description"` |
|
|
287
287
|
|
|
288
288
|
## Workflows Reference
|
|
289
289
|
|
|
@@ -327,8 +327,8 @@ Update collective knowledge:
|
|
|
327
327
|
|
|
328
328
|
### Code Generation
|
|
329
329
|
1. Review generated code before merging
|
|
330
|
-
2. Run `/test` to validate coverage
|
|
331
|
-
3. Run `/secure` before commit
|
|
330
|
+
2. Run `/ai-sprint-test` to validate coverage
|
|
331
|
+
3. Run `/ai-sprint-secure` before commit
|
|
332
332
|
4. Address all security findings
|
|
333
333
|
5. Update docs with changes
|
|
334
334
|
|
|
@@ -350,37 +350,37 @@ Update collective knowledge:
|
|
|
350
350
|
|
|
351
351
|
### Feature Implementation
|
|
352
352
|
```bash
|
|
353
|
-
/plan "describe feature"
|
|
354
|
-
/code "implement based on plan"
|
|
355
|
-
/test
|
|
356
|
-
/validate
|
|
353
|
+
/ai-sprint-plan "describe feature"
|
|
354
|
+
/ai-sprint-code "implement based on plan"
|
|
355
|
+
/ai-sprint-test
|
|
356
|
+
/ai-sprint-validate
|
|
357
357
|
# If passes → merge
|
|
358
|
-
# If fails → /debug "issue" → fix → rerun
|
|
358
|
+
# If fails → /ai-sprint-debug "issue" → fix → rerun
|
|
359
359
|
```
|
|
360
360
|
|
|
361
361
|
### Bug Fix
|
|
362
362
|
```bash
|
|
363
|
-
/debug "describe the bug and symptoms"
|
|
363
|
+
/ai-sprint-debug "describe the bug and symptoms"
|
|
364
364
|
# Review root cause analysis
|
|
365
|
-
/code "implement the fix"
|
|
366
|
-
/test
|
|
367
|
-
/validate
|
|
365
|
+
/ai-sprint-code "implement the fix"
|
|
366
|
+
/ai-sprint-test
|
|
367
|
+
/ai-sprint-validate
|
|
368
368
|
```
|
|
369
369
|
|
|
370
370
|
### Security Audit
|
|
371
371
|
```bash
|
|
372
|
-
/secure .
|
|
372
|
+
/ai-sprint-secure .
|
|
373
373
|
# Review findings in ai_context/reports/security-*.md
|
|
374
|
-
/code "fix high/critical issues"
|
|
375
|
-
/test
|
|
374
|
+
/ai-sprint-code "fix high/critical issues"
|
|
375
|
+
/ai-sprint-test
|
|
376
376
|
```
|
|
377
377
|
|
|
378
378
|
### Performance Optimization
|
|
379
379
|
```bash
|
|
380
|
-
/plan "performance improvement"
|
|
381
|
-
/code "optimize based on plan"
|
|
382
|
-
/test "ensure no regressions"
|
|
383
|
-
/review "check for best practices"
|
|
380
|
+
/ai-sprint-plan "performance improvement"
|
|
381
|
+
/ai-sprint-code "optimize based on plan"
|
|
382
|
+
/ai-sprint-test "ensure no regressions"
|
|
383
|
+
/ai-sprint-review "check for best practices"
|
|
384
384
|
```
|
|
385
385
|
|
|
386
386
|
## Customization
|
package/templates/README.md
CHANGED
|
@@ -10,15 +10,15 @@ This framework provides 9 specialized AI agents and 10 essential commands for au
|
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
12
|
# Full automation (recommended)
|
|
13
|
-
/auto "build user authentication system"
|
|
13
|
+
/ai-sprint-auto "build user authentication system"
|
|
14
14
|
|
|
15
15
|
# Or step-by-step
|
|
16
|
-
/plan "implement JWT authentication"
|
|
17
|
-
/code "implement the plan"
|
|
18
|
-
/test
|
|
19
|
-
/review
|
|
20
|
-
/secure
|
|
21
|
-
/deploy
|
|
16
|
+
/ai-sprint-plan "implement JWT authentication"
|
|
17
|
+
/ai-sprint-code "implement the plan"
|
|
18
|
+
/ai-sprint-test
|
|
19
|
+
/ai-sprint-review
|
|
20
|
+
/ai-sprint-secure
|
|
21
|
+
/ai-sprint-deploy
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
## MCP Tools (Optional)
|
|
@@ -72,17 +72,17 @@ See `CLAUDE.md` for detailed MCP configuration.
|
|
|
72
72
|
- **researcher** - Technology research with web search
|
|
73
73
|
|
|
74
74
|
### Commands (11)
|
|
75
|
-
- `/plan` - Create implementation architecture
|
|
76
|
-
- `/code` - Generate or refactor code
|
|
77
|
-
- `/test` - Generate and run tests (80%+ coverage required)
|
|
78
|
-
- `/review` - Analyze code quality
|
|
79
|
-
- `/secure` - Scan for vulnerabilities, secrets, dependencies
|
|
80
|
-
- `/deploy` - Configure CI/CD & deployment
|
|
81
|
-
- `/docs` - Generate documentation
|
|
82
|
-
- `/debug` - Investigate bugs & errors
|
|
83
|
-
- `/scan` - Scan codebase and update AI context
|
|
84
|
-
- `/validate` - Comprehensive check (tests + review + security)
|
|
85
|
-
- `/auto` - Full autonomous cycle
|
|
75
|
+
- `/ai-sprint-plan` - Create implementation architecture
|
|
76
|
+
- `/ai-sprint-code` - Generate or refactor code
|
|
77
|
+
- `/ai-sprint-test` - Generate and run tests (80%+ coverage required)
|
|
78
|
+
- `/ai-sprint-review` - Analyze code quality
|
|
79
|
+
- `/ai-sprint-secure` - Scan for vulnerabilities, secrets, dependencies
|
|
80
|
+
- `/ai-sprint-deploy` - Configure CI/CD & deployment
|
|
81
|
+
- `/ai-sprint-docs` - Generate documentation
|
|
82
|
+
- `/ai-sprint-debug` - Investigate bugs & errors
|
|
83
|
+
- `/ai-sprint-scan` - Scan codebase and update AI context
|
|
84
|
+
- `/ai-sprint-validate` - Comprehensive check (tests + review + security)
|
|
85
|
+
- `/ai-sprint-auto` - Full autonomous cycle
|
|
86
86
|
|
|
87
87
|
### Skills (5)
|
|
88
88
|
Skills enhance agent capabilities with specialized knowledge:
|
|
@@ -120,7 +120,7 @@ When you run `ai-sprint-kit init` on a project with existing source code, it aut
|
|
|
120
120
|
### Manual Scanning
|
|
121
121
|
```bash
|
|
122
122
|
# Update codebase context after changes
|
|
123
|
-
/scan
|
|
123
|
+
/ai-sprint-scan
|
|
124
124
|
|
|
125
125
|
# Or use CLI directly
|
|
126
126
|
ai-sprint-kit scan
|
|
@@ -199,23 +199,23 @@ Without jq, statusline shows basic "🚀 AI Sprint" text.
|
|
|
199
199
|
|
|
200
200
|
### Recommended: Full Automation
|
|
201
201
|
```bash
|
|
202
|
-
/auto "feature description"
|
|
202
|
+
/ai-sprint-auto "feature description"
|
|
203
203
|
```
|
|
204
204
|
Executes: plan → code → test → review → security → docs
|
|
205
205
|
|
|
206
206
|
### Manual Step-by-Step
|
|
207
207
|
```bash
|
|
208
|
-
/plan "implement registration system" # Architecture
|
|
209
|
-
/code "implement the plan" # Generate code
|
|
210
|
-
/test # Tests + coverage
|
|
211
|
-
/review # Quality analysis
|
|
212
|
-
/secure # Security scan
|
|
213
|
-
/deploy # CI/CD setup
|
|
208
|
+
/ai-sprint-plan "implement registration system" # Architecture
|
|
209
|
+
/ai-sprint-code "implement the plan" # Generate code
|
|
210
|
+
/ai-sprint-test # Tests + coverage
|
|
211
|
+
/ai-sprint-review # Quality analysis
|
|
212
|
+
/ai-sprint-secure # Security scan
|
|
213
|
+
/ai-sprint-deploy # CI/CD setup
|
|
214
214
|
```
|
|
215
215
|
|
|
216
216
|
### Validation Before Commit
|
|
217
217
|
```bash
|
|
218
|
-
/validate # tests + review + security
|
|
218
|
+
/ai-sprint-validate # tests + review + security
|
|
219
219
|
```
|
|
220
220
|
|
|
221
221
|
## Configuration
|
|
@@ -255,27 +255,27 @@ ANTHROPIC_API_KEY=your_key
|
|
|
255
255
|
- OWASP Top 10 compliance
|
|
256
256
|
|
|
257
257
|
### Pre-Commit Gate
|
|
258
|
-
Run `/validate` before committing. Fixes all issues before pushing.
|
|
258
|
+
Run `/ai-sprint-validate` before committing. Fixes all issues before pushing.
|
|
259
259
|
|
|
260
260
|
## Examples
|
|
261
261
|
|
|
262
262
|
### Example 1: Complete Feature
|
|
263
263
|
```bash
|
|
264
|
-
/auto "implement password reset with email verification"
|
|
264
|
+
/ai-sprint-auto "implement password reset with email verification"
|
|
265
265
|
```
|
|
266
266
|
|
|
267
267
|
### Example 2: Step-by-Step with Review
|
|
268
268
|
```bash
|
|
269
|
-
/plan "design GraphQL API for posts"
|
|
270
|
-
/code "implement GraphQL schema and resolvers"
|
|
271
|
-
/test "generate integration tests"
|
|
272
|
-
/review
|
|
273
|
-
/secure src/
|
|
269
|
+
/ai-sprint-plan "design GraphQL API for posts"
|
|
270
|
+
/ai-sprint-code "implement GraphQL schema and resolvers"
|
|
271
|
+
/ai-sprint-test "generate integration tests"
|
|
272
|
+
/ai-sprint-review
|
|
273
|
+
/ai-sprint-secure src/
|
|
274
274
|
```
|
|
275
275
|
|
|
276
276
|
### Example 3: Security Audit
|
|
277
277
|
```bash
|
|
278
|
-
/secure .
|
|
278
|
+
/ai-sprint-secure .
|
|
279
279
|
```
|
|
280
280
|
Scans codebase for vulnerabilities, secrets, dependencies.
|
|
281
281
|
|
|
@@ -311,7 +311,7 @@ Command workflow steps...
|
|
|
311
311
|
| Security scan fails | Install: `pip install snyk semgrep detect-secrets`. Get API tokens. Update `.env` |
|
|
312
312
|
| Tests don't run | Verify test framework installed. Check test file patterns. Ensure coverage tools available |
|
|
313
313
|
| Agent not found | Verify `.claude/agents/` directory. Check agent name in frontmatter. Restart Claude |
|
|
314
|
-
| Low code coverage | Use `/test` to auto-generate tests for uncovered code |
|
|
314
|
+
| Low code coverage | Use `/ai-sprint-test` to auto-generate tests for uncovered code |
|
|
315
315
|
| Deployment blocked | Check approval gates in `.claude/settings.json`. Review security findings |
|
|
316
316
|
|
|
317
317
|
## Key Principles
|
|
@@ -327,5 +327,5 @@ Command workflow steps...
|
|
|
327
327
|
1. Copy this template to your project
|
|
328
328
|
2. Update `.claude/settings.json` for your stack
|
|
329
329
|
3. Configure environment variables in `.env`
|
|
330
|
-
4. Start with `/auto "your first feature"`
|
|
330
|
+
4. Start with `/ai-sprint-auto "your first feature"`
|
|
331
331
|
5. Monitor `ai_context/memory/learning.md` for lessons
|