omgkit 2.22.9 → 2.22.11
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 +18 -10
- package/lib/cli.js +4 -2
- package/package.json +1 -1
- package/plugin/commands/sprint/init.md +26 -1
- package/plugin/registry.yaml +2 -2
- package/templates/CLAUDE.md +31 -5
- package/templates/OMEGA.md +10 -0
- package/templates/artifacts/README.md +87 -0
- package/templates/config.yaml +1 -0
package/README.md
CHANGED
|
@@ -589,18 +589,21 @@ Build complete applications from idea to deployment.
|
|
|
589
589
|
|
|
590
590
|
### Artifacts System
|
|
591
591
|
|
|
592
|
-
Provide project context:
|
|
592
|
+
Provide project context with reference documents:
|
|
593
593
|
|
|
594
594
|
```
|
|
595
595
|
.omgkit/artifacts/
|
|
596
|
-
├──
|
|
597
|
-
├──
|
|
598
|
-
├──
|
|
599
|
-
├──
|
|
600
|
-
├──
|
|
601
|
-
|
|
596
|
+
├── README.md # How to use artifacts
|
|
597
|
+
├── data/ # Sample data, schemas, data dictionaries
|
|
598
|
+
├── docs/ # Requirements, user stories, PRDs
|
|
599
|
+
├── knowledge/ # Glossary, business rules, domain knowledge
|
|
600
|
+
├── research/ # Competitor analysis, market research
|
|
601
|
+
├── assets/ # Reference images, templates, mockups
|
|
602
|
+
└── examples/ # Code samples, reference implementations
|
|
602
603
|
```
|
|
603
604
|
|
|
605
|
+
**Note:** Artifacts are **reference materials only**, NOT execution instructions. They help AI understand your project context.
|
|
606
|
+
|
|
604
607
|
---
|
|
605
608
|
|
|
606
609
|
## Project Structure
|
|
@@ -619,11 +622,16 @@ your-project/
|
|
|
619
622
|
│ ├── docs/ # Generated docs
|
|
620
623
|
│ ├── logs/ # Activity logs
|
|
621
624
|
│ ├── devlogs/ # Development logs (git-ignored)
|
|
625
|
+
│ │ └── README.md
|
|
622
626
|
│ ├── stdrules/ # Project standards
|
|
627
|
+
│ │ ├── README.md
|
|
623
628
|
│ │ ├── BEFORE_COMMIT.md
|
|
624
|
-
│ │
|
|
625
|
-
│ └──
|
|
626
|
-
└──
|
|
629
|
+
│ │ ├── SKILL_STANDARDS.md
|
|
630
|
+
│ │ └── TESTING_STANDARDS.md
|
|
631
|
+
│ └── artifacts/ # Project context (reference only)
|
|
632
|
+
│ └── README.md
|
|
633
|
+
├── OMEGA.md # Project context file
|
|
634
|
+
└── CLAUDE.md # Claude Code instructions
|
|
627
635
|
```
|
|
628
636
|
|
|
629
637
|
---
|
package/lib/cli.js
CHANGED
|
@@ -373,7 +373,8 @@ export function initProject(options = {}) {
|
|
|
373
373
|
'.omgkit/docs',
|
|
374
374
|
'.omgkit/logs',
|
|
375
375
|
'.omgkit/devlogs',
|
|
376
|
-
'.omgkit/stdrules'
|
|
376
|
+
'.omgkit/stdrules',
|
|
377
|
+
'.omgkit/artifacts'
|
|
377
378
|
];
|
|
378
379
|
|
|
379
380
|
dirs.forEach(dir => {
|
|
@@ -397,7 +398,8 @@ export function initProject(options = {}) {
|
|
|
397
398
|
{ src: 'stdrules/README.md', dest: '.omgkit/stdrules/README.md' },
|
|
398
399
|
{ src: 'stdrules/SKILL_STANDARDS.md', dest: '.omgkit/stdrules/SKILL_STANDARDS.md' },
|
|
399
400
|
{ src: 'stdrules/BEFORE_COMMIT.md', dest: '.omgkit/stdrules/BEFORE_COMMIT.md' },
|
|
400
|
-
{ src: 'stdrules/TESTING_STANDARDS.md', dest: '.omgkit/stdrules/TESTING_STANDARDS.md' }
|
|
401
|
+
{ src: 'stdrules/TESTING_STANDARDS.md', dest: '.omgkit/stdrules/TESTING_STANDARDS.md' },
|
|
402
|
+
{ src: 'artifacts/README.md', dest: '.omgkit/artifacts/README.md' }
|
|
401
403
|
];
|
|
402
404
|
|
|
403
405
|
templates.forEach(({ src, dest }) => {
|
package/package.json
CHANGED
|
@@ -17,10 +17,35 @@ Create `.omgkit/` directory structure.
|
|
|
17
17
|
│ └── backlog.yaml
|
|
18
18
|
├── plans/
|
|
19
19
|
├── docs/
|
|
20
|
-
|
|
20
|
+
├── logs/
|
|
21
|
+
├── devlogs/
|
|
22
|
+
│ └── README.md
|
|
23
|
+
├── stdrules/
|
|
24
|
+
│ ├── README.md
|
|
25
|
+
│ ├── BEFORE_COMMIT.md
|
|
26
|
+
│ ├── SKILL_STANDARDS.md
|
|
27
|
+
│ └── TESTING_STANDARDS.md
|
|
28
|
+
└── artifacts/
|
|
29
|
+
└── README.md
|
|
21
30
|
OMEGA.md
|
|
31
|
+
CLAUDE.md
|
|
22
32
|
```
|
|
23
33
|
|
|
34
|
+
## Artifacts Folder
|
|
35
|
+
|
|
36
|
+
The `.omgkit/artifacts/` folder stores **reference documents** that provide context for AI-assisted development:
|
|
37
|
+
|
|
38
|
+
| Subfolder | Purpose |
|
|
39
|
+
|-----------|---------|
|
|
40
|
+
| `data/` | Sample data, schemas, data dictionaries |
|
|
41
|
+
| `docs/` | Requirements, user stories, PRDs |
|
|
42
|
+
| `knowledge/` | Glossary, business rules, domain knowledge |
|
|
43
|
+
| `research/` | Competitor analysis, market research |
|
|
44
|
+
| `assets/` | Reference images, templates, mockups |
|
|
45
|
+
| `examples/` | Code samples, reference implementations |
|
|
46
|
+
|
|
47
|
+
> **Note:** Artifacts are **reference materials only**, NOT execution instructions. They help AI understand your project context.
|
|
48
|
+
|
|
24
49
|
## Next Steps
|
|
25
50
|
1. `/vision:set` - Set your product vision
|
|
26
51
|
2. `/sprint:new` - Create first sprint
|
package/plugin/registry.yaml
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# OMGKIT Component Registry
|
|
2
2
|
# Single Source of Truth for Agents, Skills, Commands, Workflows, and MCPs
|
|
3
|
-
# Version: 2.22.
|
|
3
|
+
# Version: 2.22.10
|
|
4
4
|
# Updated: 2026-01-03
|
|
5
5
|
|
|
6
|
-
version: "2.22.
|
|
6
|
+
version: "2.22.10"
|
|
7
7
|
|
|
8
8
|
# =============================================================================
|
|
9
9
|
# OPTIMIZED ALIGNMENT PRINCIPLE (OAP)
|
package/templates/CLAUDE.md
CHANGED
|
@@ -15,17 +15,20 @@ This project uses **OMGKIT** - an AI Team System for Claude Code with 41 Agents,
|
|
|
15
15
|
├── stdrules/ # Standards and rules (MUST READ)
|
|
16
16
|
│ ├── TESTING_STANDARDS.md # Testing methodology
|
|
17
17
|
│ └── BEFORE_COMMIT.md # Pre-commit checklist
|
|
18
|
+
├── artifacts/ # Project context documents (reference only)
|
|
19
|
+
│ └── README.md # How to use artifacts
|
|
18
20
|
├── devlogs/ # Development logs (git-ignored)
|
|
19
21
|
└── settings.json # Local settings
|
|
20
22
|
```
|
|
21
23
|
|
|
22
24
|
## MANDATORY: Read Before Tasks
|
|
23
25
|
|
|
24
|
-
| Task Type | Read First |
|
|
25
|
-
|
|
26
|
-
| Writing Tests | `.omgkit/stdrules/TESTING_STANDARDS.md` |
|
|
27
|
-
| Before Commit | `.omgkit/stdrules/BEFORE_COMMIT.md` |
|
|
28
|
-
| New Feature | `.omgkit/config.yaml` for
|
|
26
|
+
| Task Type | Read First | Also Consider |
|
|
27
|
+
|-----------|------------|---------------|
|
|
28
|
+
| Writing Tests | `.omgkit/stdrules/TESTING_STANDARDS.md` | Spawn `tester` agent for complex tests |
|
|
29
|
+
| Before Commit | `.omgkit/stdrules/BEFORE_COMMIT.md` | Run `/quality:test-omega` |
|
|
30
|
+
| New Feature | `.omgkit/config.yaml` | Use `/dev:tdd` for TDD approach |
|
|
31
|
+
| Security Testing | `.omgkit/stdrules/TESTING_STANDARDS.md` | Run `/quality:test-security` |
|
|
29
32
|
|
|
30
33
|
## Development Workflow Rules
|
|
31
34
|
|
|
@@ -38,6 +41,15 @@ This project uses **OMGKIT** - an AI Team System for Claude Code with 41 Agents,
|
|
|
38
41
|
|
|
39
42
|
This folder is git-ignored and should NEVER be committed to the repository.
|
|
40
43
|
|
|
44
|
+
### `.omgkit/artifacts/` Folder
|
|
45
|
+
**REFERENCE CONTEXT**: This folder contains project initialization documents that provide context for development:
|
|
46
|
+
- Brainstorming notes and initial plans
|
|
47
|
+
- Project specs and requirements
|
|
48
|
+
- Research documents and analysis
|
|
49
|
+
- Sample data and schemas
|
|
50
|
+
|
|
51
|
+
These are **reference materials only**, NOT execution instructions. Read them to understand project context.
|
|
52
|
+
|
|
41
53
|
### Documentation (`docs/`)
|
|
42
54
|
The `docs/` folder is for public documentation only:
|
|
43
55
|
- User-facing documentation
|
|
@@ -94,6 +106,20 @@ Before completing any task:
|
|
|
94
106
|
|
|
95
107
|
## AUTOMATIC RULES: Testing (Always Apply)
|
|
96
108
|
|
|
109
|
+
### Quick Reference - Testing Commands
|
|
110
|
+
When user asks about testing, suggest these commands:
|
|
111
|
+
- `/dev:test-write <function>` - Write comprehensive tests (RECOMMENDED)
|
|
112
|
+
- `/dev:tdd <feature>` - Test-driven development
|
|
113
|
+
- `/quality:test-omega` - Run full 4D testing suite
|
|
114
|
+
- `/quality:test-property` - Property-based testing
|
|
115
|
+
- `/quality:test-security` - Security testing
|
|
116
|
+
- `/quality:test-mutate` - Mutation testing
|
|
117
|
+
|
|
118
|
+
### Agent & Workflow
|
|
119
|
+
For complex testing tasks, spawn the `tester` agent or run workflow:
|
|
120
|
+
- Agent: `tester` - Comprehensive testing specialist
|
|
121
|
+
- Workflow: `testing/comprehensive-testing`
|
|
122
|
+
|
|
97
123
|
When writing ANY test, Claude MUST automatically apply these rules:
|
|
98
124
|
|
|
99
125
|
### 1. Minimum Test Coverage (MANDATORY)
|
package/templates/OMEGA.md
CHANGED
|
@@ -50,6 +50,16 @@ OMGKIT provides 23 specialized agents organized into teams:
|
|
|
50
50
|
- API documentation required
|
|
51
51
|
- Architecture decisions in ADRs
|
|
52
52
|
|
|
53
|
+
## Project Artifacts
|
|
54
|
+
|
|
55
|
+
Reference documents in `.omgkit/artifacts/` provide context:
|
|
56
|
+
- **data/**: Sample data, schemas, data dictionaries
|
|
57
|
+
- **docs/**: Requirements, user stories, PRDs
|
|
58
|
+
- **knowledge/**: Glossary, business rules, domain knowledge
|
|
59
|
+
- **research/**: Competitor analysis, market research
|
|
60
|
+
|
|
61
|
+
See `.omgkit/artifacts/README.md` for details.
|
|
62
|
+
|
|
53
63
|
## Current Sprint
|
|
54
64
|
|
|
55
65
|
See `.omgkit/sprints/current.yaml`
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# Project Artifacts
|
|
2
|
+
|
|
3
|
+
This folder contains **reference documents** that provide context for AI-assisted development.
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
Artifacts are **input context** for Claude Code and OMGKIT to understand your project. They are NOT execution instructions - they help AI understand the background, goals, and constraints of your project.
|
|
8
|
+
|
|
9
|
+
## What Goes Here
|
|
10
|
+
|
|
11
|
+
| Subfolder | Content | Examples |
|
|
12
|
+
|-----------|---------|----------|
|
|
13
|
+
| `data/` | Sample data, schemas, data dictionaries | `schema.sql`, `sample-users.json`, `data-dictionary.md` |
|
|
14
|
+
| `docs/` | Requirements, user stories, PRDs | `prd.md`, `user-stories.md`, `requirements.docx` |
|
|
15
|
+
| `knowledge/` | Glossary, business rules, domain knowledge | `glossary.md`, `business-rules.md`, `domain-model.md` |
|
|
16
|
+
| `research/` | Competitor analysis, market research | `competitors.md`, `market-analysis.pdf` |
|
|
17
|
+
| `assets/` | Reference images, templates, mockups | `wireframes/`, `logos/`, `templates/` |
|
|
18
|
+
| `examples/` | Code samples, reference implementations | `api-example.py`, `integration-sample/` |
|
|
19
|
+
|
|
20
|
+
## How AI Uses These Artifacts
|
|
21
|
+
|
|
22
|
+
When you run OMGKIT commands, the AI team will:
|
|
23
|
+
|
|
24
|
+
1. **Read artifacts** to understand project context
|
|
25
|
+
2. **Reference business rules** when making implementation decisions
|
|
26
|
+
3. **Follow naming conventions** from glossary and data dictionaries
|
|
27
|
+
4. **Align with requirements** in PRDs and user stories
|
|
28
|
+
5. **Use examples** as reference for coding patterns
|
|
29
|
+
|
|
30
|
+
## Artifacts vs Other Folders
|
|
31
|
+
|
|
32
|
+
| Folder | Purpose | Git Status | AI Usage |
|
|
33
|
+
|--------|---------|------------|----------|
|
|
34
|
+
| **artifacts/** | Reference context (input) | Committed | Read for understanding |
|
|
35
|
+
| **devlogs/** | Development work logs | Git-ignored | Internal tracking |
|
|
36
|
+
| **plans/** | Formal implementation plans | Committed | Execution guidance |
|
|
37
|
+
| **docs/** | Generated documentation | Committed | Output documentation |
|
|
38
|
+
|
|
39
|
+
## Best Practices
|
|
40
|
+
|
|
41
|
+
### 1. Keep It Organized
|
|
42
|
+
|
|
43
|
+
Create subfolders for different types of content:
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
artifacts/
|
|
47
|
+
├── data/
|
|
48
|
+
│ ├── sample-users.json
|
|
49
|
+
│ └── schema.sql
|
|
50
|
+
├── docs/
|
|
51
|
+
│ ├── prd.md
|
|
52
|
+
│ └── user-stories.md
|
|
53
|
+
├── knowledge/
|
|
54
|
+
│ ├── glossary.md
|
|
55
|
+
│ └── business-rules.md
|
|
56
|
+
└── research/
|
|
57
|
+
└── competitor-analysis.md
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### 2. Use Clear Naming
|
|
61
|
+
|
|
62
|
+
- Descriptive filenames: `user-authentication-requirements.md`
|
|
63
|
+
- Date prefix for versioned docs: `2024-12-prd-v2.md`
|
|
64
|
+
- Keep extensions consistent: `.md` for markdown, `.json` for data
|
|
65
|
+
|
|
66
|
+
### 3. Keep It Relevant
|
|
67
|
+
|
|
68
|
+
- Remove outdated documents
|
|
69
|
+
- Update artifacts when requirements change
|
|
70
|
+
- Link related documents together
|
|
71
|
+
|
|
72
|
+
### 4. Don't Put Execution Work Here
|
|
73
|
+
|
|
74
|
+
Execution work belongs elsewhere:
|
|
75
|
+
- Implementation plans go in `plans/`
|
|
76
|
+
- Development logs go in `devlogs/`
|
|
77
|
+
- Generated docs go in `docs/`
|
|
78
|
+
|
|
79
|
+
## Quick Start
|
|
80
|
+
|
|
81
|
+
1. Copy your project documents into appropriate subfolders
|
|
82
|
+
2. Run `/context:index` to refresh codebase context
|
|
83
|
+
3. AI will automatically reference these when executing commands
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
*Artifacts provide the "why" and "what" - AI handles the "how".*
|