omgkit 2.26.1 → 2.27.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 CHANGED
@@ -88,7 +88,37 @@ OMGKIT brings agile methodology to AI-assisted development:
88
88
  - **Sprints**: Time-boxed development cycles
89
89
  - **AI Team**: Autonomous execution with human oversight
90
90
 
91
- ### 4. Testing Automation (New)
91
+ ### 4. Reference-Aware Planning (New)
92
+
93
+ Use PRDs, specs, and design documents to inform sprint planning:
94
+
95
+ ```bash
96
+ # Create sprint with PRD reference
97
+ /sprint:sprint-new "Auth Sprint" --ref=.omgkit/artifacts/prd-auth.md
98
+
99
+ # Sprint with multiple references
100
+ /sprint:sprint-new "Payment" --ref=artifacts/prd.md,specs/api.yaml
101
+
102
+ # Sprint with AI proposal based on references
103
+ /sprint:sprint-new "MVP" --propose --ref=.omgkit/artifacts/
104
+ ```
105
+
106
+ Configure in `.omgkit/workflow.yaml`:
107
+
108
+ ```yaml
109
+ references:
110
+ enabled: true
111
+ auto_suggest: true
112
+ max_tokens: 10000
113
+ extract_sections:
114
+ - requirements
115
+ - user_stories
116
+ - acceptance_criteria
117
+ ```
118
+
119
+ References automatically propagate to `/sprint:team-run` and `/sprint:backlog-add`.
120
+
121
+ ### 5. Testing Automation
92
122
 
93
123
  OMGKIT includes a comprehensive testing automation system:
94
124
 
@@ -349,6 +379,13 @@ Commands are slash-prefixed actions organized by namespace.
349
379
  /sprint:team-status # Show team activity
350
380
  ```
351
381
 
382
+ **Reference-Aware Planning** (available on sprint commands):
383
+ ```bash
384
+ /sprint:sprint-new "Auth" --ref=artifacts/prd.md # Sprint with PRD context
385
+ /sprint:team-run --ref=specs/api.yaml # Add refs during execution
386
+ /sprint:backlog-add "Login" --ref=artifacts/prd.md # Task with ref context
387
+ ```
388
+
352
389
  ### Autonomous Development (`/auto:*`)
353
390
 
354
391
  ```bash
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "omgkit",
3
- "version": "2.26.1",
3
+ "version": "2.27.0",
4
4
  "description": "Omega-Level Development Kit - AI Team System for Claude Code. 41 agents, 160 commands, 161 skills, 69 workflows.",
5
5
  "keywords": [
6
6
  "claude-code",
@@ -1,21 +1,108 @@
1
1
  ---
2
- description: Add task to backlog
2
+ description: Add task to backlog with optional reference context
3
3
  allowed-tools: Read, Write
4
- argument-hint: <task> [--type TYPE] [--priority N]
4
+ argument-hint: <task> [--type TYPE] [--priority N] [--ref=<path>]
5
+ references:
6
+ supported: true
7
+ inherit_from_sprint: true
8
+ types: [file, folder, glob]
9
+ related_skills:
10
+ - autonomous/project-orchestration
11
+ - methodology/agile-sprint
12
+ related_commands:
13
+ - /sprint:sprint-new
14
+ - /sprint:backlog-show
15
+ - /sprint:backlog-prioritize
5
16
  ---
6
17
 
7
- # Backlog Add: $ARGUMENTS
18
+ # Backlog Add: $ARGUMENTS
8
19
 
9
- Add task to backlog.
20
+ Add a task to the backlog with optional reference context.
10
21
 
11
22
  ## Options
12
- - `--type` - feature, bugfix, docs, test, refactor, infra
13
- - `--priority` - 1-5 (1 = highest)
14
23
 
15
- ## Example
24
+ | Option | Description | Example |
25
+ |--------|-------------|---------|
26
+ | `--type` | Task type | `--type feature` |
27
+ | `--priority` | Priority 1-5 (1 = highest) | `--priority 1` |
28
+ | `--ref=<path>` | Reference source for task context | `--ref=artifacts/prd.md#auth` |
29
+ | `--req=<id>` | Link to requirement ID | `--req=REQ-001` |
30
+
31
+ ### Task Types
32
+
33
+ | Type | Description | Auto-generates Tests |
34
+ |------|-------------|---------------------|
35
+ | `feature` | New functionality | Yes |
36
+ | `bugfix` | Bug fix | Yes (regression) |
37
+ | `docs` | Documentation | No |
38
+ | `test` | Test task | No |
39
+ | `refactor` | Code refactoring | Yes |
40
+ | `infra` | Infrastructure | No |
41
+
42
+ ## Reference Options
43
+
44
+ The `--ref` parameter allows linking tasks to specific reference documents:
45
+
46
+ ```bash
47
+ # Link task to PRD requirement
48
+ /backlog:add "User login" --type feature --ref=artifacts/prd.md
49
+
50
+ # Link to specific section (anchor)
51
+ /backlog:add "OAuth flow" --ref=artifacts/prd.md#authentication
52
+
53
+ # Link to API spec
54
+ /backlog:add "Payment endpoint" --ref=specs/api-payment.yaml
16
55
  ```
17
- /backlog:add "Add user authentication" --type feature --priority 1
56
+
57
+ ### Requirement Linking
58
+
59
+ Use `--req` to link tasks directly to requirement IDs:
60
+
61
+ ```bash
62
+ /backlog:add "User authentication" --type feature --req=REQ-AUTH-001
18
63
  ```
19
64
 
65
+ This enables:
66
+ - Traceability from requirements to implementation
67
+ - Coverage tracking for requirements
68
+ - Impact analysis for requirement changes
69
+
20
70
  ## Output
21
- Generates task ID and saves to `.omgkit/sprints/backlog.yaml`
71
+
72
+ Generates task ID and saves to `.omgkit/sprints/backlog.yaml`:
73
+
74
+ ```yaml
75
+ backlog:
76
+ - id: TASK-042
77
+ title: "User login"
78
+ type: feature
79
+ priority: 1
80
+ status: pending
81
+ reference:
82
+ source: "artifacts/prd.md"
83
+ requirement_id: "REQ-AUTH-001"
84
+ created: 2025-01-07
85
+ ```
86
+
87
+ ## Examples
88
+
89
+ ```bash
90
+ # Basic task
91
+ /backlog:add "Add user authentication" --type feature --priority 1
92
+
93
+ # Task with reference
94
+ /backlog:add "Implement OAuth" --type feature --ref=artifacts/prd-auth.md
95
+
96
+ # Task linked to requirement
97
+ /backlog:add "Rate limiting" --type feature --req=REQ-API-005
98
+
99
+ # Task with all options
100
+ /backlog:add "Payment gateway" --type feature --priority 1 --ref=specs/api.yaml --req=REQ-PAY-001
101
+ ```
102
+
103
+ ## Best Practices
104
+
105
+ 1. **Link to requirements** - Use `--req` for traceability
106
+ 2. **Reference specs** - Use `--ref` for implementation context
107
+ 3. **Set appropriate type** - Enables correct test generation
108
+ 4. **Prioritize consistently** - 1 = critical, 5 = nice-to-have
@@ -1,24 +1,101 @@
1
1
  ---
2
- description: Create new sprint
2
+ description: Create new sprint with optional reference sources
3
3
  allowed-tools: Task, Read, Write, Grep, Glob
4
- argument-hint: "[name] [--propose]"
4
+ argument-hint: "[name] [--propose] [--ref=<path>]"
5
+ references:
6
+ supported: true
7
+ types: [file, folder, glob]
8
+ default_paths:
9
+ - ".omgkit/artifacts/"
10
+ related_skills:
11
+ - autonomous/project-orchestration
12
+ - methodology/agile-sprint
13
+ related_commands:
14
+ - /sprint:sprint-start
15
+ - /sprint:team-run
16
+ - /sprint:backlog-add
5
17
  ---
6
18
 
7
- # 🏃 Sprint New: $ARGUMENTS
19
+ # Sprint New: $ARGUMENTS
8
20
 
9
- Create new sprint.
21
+ Create a new sprint with optional reference sources for context-aware planning.
10
22
 
11
23
  ## Options
12
- - `--propose` - AI analyzes codebase and proposes tasks
13
24
 
14
- ## AI Proposal Analyzes
25
+ | Option | Description | Example |
26
+ |--------|-------------|---------|
27
+ | `--propose` | AI analyzes codebase and proposes tasks | `--propose` |
28
+ | `--ref=<path>` | Reference source(s) for planning context | `--ref=artifacts/prd.md` |
29
+
30
+ ## Reference Options
31
+
32
+ The `--ref` parameter allows you to specify reference sources that provide context for sprint planning:
33
+
34
+ ### Single File Reference
35
+ ```bash
36
+ /sprint:sprint-new "Auth Sprint" --ref=.omgkit/artifacts/prd-auth.md
37
+ ```
38
+
39
+ ### Multiple Files Reference
40
+ ```bash
41
+ /sprint:sprint-new "Payment Sprint" --ref=artifacts/prd.md,specs/api.yaml
42
+ ```
43
+
44
+ ### Folder Reference (all files)
45
+ ```bash
46
+ /sprint:sprint-new "MVP Sprint" --ref=.omgkit/artifacts/
47
+ ```
48
+
49
+ ### Glob Pattern Reference
50
+ ```bash
51
+ /sprint:sprint-new "API Sprint" --ref="specs/*.yaml"
52
+ ```
53
+
54
+ ## Reference Types
55
+
56
+ | Type | File Patterns | Extracted Sections |
57
+ |------|---------------|-------------------|
58
+ | PRD | `**/prd*.md`, `**/requirements*.md` | Requirements, User Stories, Acceptance Criteria |
59
+ | Spec | `**/spec*.md`, `**/technical*.md` | Technical specs, Architecture |
60
+ | OpenAPI | `**/*.yaml`, `**/*.yml` | Endpoints, Schemas |
61
+ | Design | `**/design*.md` | UI/UX flows, Mockups |
62
+
63
+ ## How References Work
64
+
65
+ ```
66
+ /sprint:sprint-new "Feature X" --ref=artifacts/prd.md
67
+
68
+ ┌─────────────────────────────────────────────────────────┐
69
+ │ 1. Load Reference Sources │
70
+ │ └── Read artifacts/prd.md │
71
+ │ │
72
+ │ 2. Extract Relevant Sections │
73
+ │ ├── Requirements │
74
+ │ ├── User Stories │
75
+ │ ├── Acceptance Criteria │
76
+ │ └── Technical Constraints │
77
+ │ │
78
+ │ 3. Inject into Planning Context │
79
+ │ └── AI plans with full context │
80
+ │ │
81
+ │ 4. Store Reference in Sprint │
82
+ │ └── sprint.yaml includes ref sources │
83
+ └─────────────────────────────────────────────────────────┘
84
+ ```
85
+
86
+ ## AI Proposal Analysis (with --propose)
87
+
88
+ When using `--propose`, AI analyzes:
89
+
15
90
  - TODOs and FIXMEs in code
16
91
  - Test coverage gaps
17
92
  - Documentation gaps
18
93
  - Features aligned with vision
19
94
  - Technical debt
95
+ - **Reference documents** (when --ref provided)
20
96
 
21
97
  ## Output
98
+
22
99
  Save to: `.omgkit/sprints/current.yaml`
23
100
 
24
101
  ```yaml
@@ -27,5 +104,46 @@ sprint:
27
104
  status: planning
28
105
  start_date: null
29
106
  end_date: null
107
+
108
+ # Reference sources (when --ref used)
109
+ references:
110
+ - source: ".omgkit/artifacts/prd-auth.md"
111
+ type: prd
112
+ sections: [requirements, stories, acceptance]
113
+
30
114
  tasks: []
31
115
  ```
116
+
117
+ ## Context Propagation
118
+
119
+ References set in sprint are automatically propagated to:
120
+
121
+ - `/sprint:team-run` - Agents receive reference context
122
+ - `/sprint:backlog-add` - New tasks can inherit sprint refs
123
+ - `/dev:feature` - Implementation aligned with specs
124
+
125
+ ## Examples
126
+
127
+ ```bash
128
+ # Basic sprint without references
129
+ /sprint:sprint-new "Sprint 1"
130
+
131
+ # Sprint with AI-proposed tasks
132
+ /sprint:sprint-new "MVP Sprint" --propose
133
+
134
+ # Sprint with PRD reference
135
+ /sprint:sprint-new "Auth Sprint" --ref=.omgkit/artifacts/prd-auth.md
136
+
137
+ # Sprint with multiple references and AI proposal
138
+ /sprint:sprint-new "Payment Sprint" --propose --ref=artifacts/prd.md,specs/api.yaml
139
+
140
+ # Sprint with entire artifacts folder
141
+ /sprint:sprint-new "Full Feature" --ref=.omgkit/artifacts/
142
+ ```
143
+
144
+ ## Best Practices
145
+
146
+ 1. **Use specific references** - Point to relevant documents, not entire folders
147
+ 2. **Combine with --propose** - Let AI analyze refs and propose aligned tasks
148
+ 3. **Keep artifacts updated** - Reference docs should reflect current requirements
149
+ 4. **Link tasks to requirements** - Use `requirement_ref` in tasks for traceability
@@ -1,13 +1,19 @@
1
1
  ---
2
2
  description: Run AI team on sprint tasks with configurable test enforcement
3
3
  allowed-tools: Task, Read, Write, Bash, Grep, Glob
4
- argument-hint: "[--mode MODE] [--no-test] [--test-level LEVEL]"
4
+ argument-hint: "[--mode MODE] [--no-test] [--test-level LEVEL] [--ref=<path>]"
5
+ references:
6
+ supported: true
7
+ inherit_from_sprint: true
8
+ types: [file, folder, glob]
5
9
  related_skills:
6
10
  - methodology/test-enforcement
7
11
  - methodology/test-task-generation
8
12
  - omega/omega-sprint
13
+ - autonomous/project-orchestration
9
14
  related_commands:
10
15
  - /sprint:team-status
16
+ - /sprint:sprint-new
11
17
  - /quality:verify-done
12
18
  - /quality:coverage-check
13
19
  testing:
@@ -44,6 +50,24 @@ This command respects project testing configuration from `.omgkit/workflow.yaml`
44
50
  | `--no-test` | Skip test enforcement (soft mode only) | `/sprint:team-run --no-test` |
45
51
  | `--test-level <level>` | Override enforcement level | `/sprint:team-run --test-level strict` |
46
52
  | `--with-test` | Force test enforcement | `/sprint:team-run --with-test` |
53
+ | `--ref=<path>` | Additional reference sources | `/sprint:team-run --ref=specs/api.yaml` |
54
+
55
+ ### Reference Options
56
+
57
+ The `--ref` parameter provides additional context for task execution:
58
+
59
+ ```bash
60
+ # Use sprint references (inherited automatically)
61
+ /sprint:team-run
62
+
63
+ # Add additional references for this run
64
+ /sprint:team-run --ref=docs/architecture.md
65
+
66
+ # Override sprint references
67
+ /sprint:team-run --ref=specs/api-v2.yaml
68
+ ```
69
+
70
+ **Reference Inheritance**: By default, team-run inherits references from the current sprint. Use `--ref` to add or override.
47
71
 
48
72
  ### Enforcement Levels
49
73
 
@@ -36,6 +36,60 @@ output:
36
36
  artifacts_dir: .omgkit/artifacts
37
37
  verbose: false
38
38
 
39
+ # Reference settings
40
+ references:
41
+ # Enable reference loading in sprints and commands
42
+ enabled: true
43
+
44
+ # Auto-suggest relevant artifacts when planning
45
+ auto_suggest: true
46
+
47
+ # Default paths to search for references
48
+ default_paths:
49
+ - ".omgkit/artifacts/"
50
+ - "docs/"
51
+
52
+ # Maximum tokens to include from references
53
+ max_tokens: 10000
54
+
55
+ # File type mappings for smart extraction
56
+ type_mappings:
57
+ prd:
58
+ patterns:
59
+ - "**/prd*.md"
60
+ - "**/requirements*.md"
61
+ - "**/product*.md"
62
+ sections:
63
+ - requirements
64
+ - user_stories
65
+ - acceptance_criteria
66
+ spec:
67
+ patterns:
68
+ - "**/spec*.md"
69
+ - "**/technical*.md"
70
+ - "**/architecture*.md"
71
+ sections:
72
+ - overview
73
+ - api
74
+ - data_model
75
+ openapi:
76
+ patterns:
77
+ - "**/*.yaml"
78
+ - "**/*.yml"
79
+ - "**/openapi.*"
80
+ sections:
81
+ - paths
82
+ - components
83
+ design:
84
+ patterns:
85
+ - "**/design*.md"
86
+ - "**/ui*.md"
87
+ - "**/ux*.md"
88
+ sections:
89
+ - flows
90
+ - components
91
+ - interactions
92
+
39
93
  # MCP settings
40
94
  mcp:
41
95
  context7: true
@@ -176,3 +176,46 @@ feature_flags:
176
176
 
177
177
  # Default state for new flags
178
178
  default_state: false
179
+
180
+ # =============================================================================
181
+ # REFERENCE-AWARE PLANNING
182
+ # =============================================================================
183
+ references:
184
+ # Enable reference loading in sprints
185
+ enabled: true
186
+
187
+ # Auto-suggest relevant artifacts when creating sprints
188
+ auto_suggest: true
189
+
190
+ # Maximum tokens for reference content (prevent context overflow)
191
+ max_tokens: 10000
192
+
193
+ # Section extraction settings for PRD/spec files
194
+ extract_sections:
195
+ - requirements
196
+ - user_stories
197
+ - acceptance_criteria
198
+ - constraints
199
+ - api_endpoints
200
+
201
+ # Propagate references to child commands
202
+ propagation:
203
+ # Pass sprint refs to team-run
204
+ to_team_run: true
205
+
206
+ # Pass sprint refs to individual tasks
207
+ to_tasks: true
208
+
209
+ # Pass refs to feature/fix commands
210
+ to_dev_commands: true
211
+
212
+ # Reference validation
213
+ validation:
214
+ # Check if referenced files exist
215
+ check_exists: true
216
+
217
+ # Warn if references are outdated (modified after sprint creation)
218
+ check_freshness: true
219
+
220
+ # Maximum file age in days before warning
221
+ max_age_days: 30