omgkit 2.9.0 → 2.9.1
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/lib/cli.js +3 -1
- package/package.json +1 -1
- package/templates/CLAUDE.md +84 -0
package/lib/cli.js
CHANGED
|
@@ -389,6 +389,7 @@ export function initProject(options = {}) {
|
|
|
389
389
|
const templates = [
|
|
390
390
|
{ src: 'config.yaml', dest: '.omgkit/config.yaml' },
|
|
391
391
|
{ src: 'OMEGA.md', dest: 'OMEGA.md' },
|
|
392
|
+
{ src: 'CLAUDE.md', dest: 'CLAUDE.md' },
|
|
392
393
|
{ src: 'vision.yaml', dest: '.omgkit/sprints/vision.yaml' },
|
|
393
394
|
{ src: 'backlog.yaml', dest: '.omgkit/sprints/backlog.yaml' },
|
|
394
395
|
{ src: 'settings.json', dest: '.omgkit/settings.json' },
|
|
@@ -578,7 +579,8 @@ export function doctor(options = {}) {
|
|
|
578
579
|
const files = [
|
|
579
580
|
'.omgkit/config.yaml',
|
|
580
581
|
'.omgkit/sprints/vision.yaml',
|
|
581
|
-
'OMEGA.md'
|
|
582
|
+
'OMEGA.md',
|
|
583
|
+
'CLAUDE.md'
|
|
582
584
|
];
|
|
583
585
|
|
|
584
586
|
files.forEach(f => {
|
package/package.json
CHANGED
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# CLAUDE.md - Project Instructions for Claude Code
|
|
2
|
+
|
|
3
|
+
## OMGKIT-Powered Project
|
|
4
|
+
|
|
5
|
+
This project uses **OMGKIT** - an AI Team System for Claude Code with 23 Agents, 58 Commands, 88 Skills, and 10 Modes.
|
|
6
|
+
|
|
7
|
+
## Project Structure
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
.omgkit/
|
|
11
|
+
├── config.yaml # Project settings and AI model routing
|
|
12
|
+
├── sprints/ # Sprint management files
|
|
13
|
+
│ ├── vision.yaml # Product vision and goals
|
|
14
|
+
│ └── backlog.yaml # Product backlog items
|
|
15
|
+
├── devlogs/ # Development logs (git-ignored)
|
|
16
|
+
└── settings.json # Local settings
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Development Workflow Rules
|
|
20
|
+
|
|
21
|
+
### `.omgkit/devlogs/` Folder
|
|
22
|
+
**IMPORTANT**: All development plans, ideas, upgrade plans, and internal notes MUST go in `.omgkit/devlogs/` folder:
|
|
23
|
+
- Implementation plans and upgrade plans
|
|
24
|
+
- Ideas and brainstorming notes
|
|
25
|
+
- Internal development logs
|
|
26
|
+
- Task breakdowns and analysis
|
|
27
|
+
|
|
28
|
+
This folder is git-ignored and should NEVER be committed to the repository.
|
|
29
|
+
|
|
30
|
+
### Documentation (`docs/`)
|
|
31
|
+
The `docs/` folder is for public documentation only:
|
|
32
|
+
- User-facing documentation
|
|
33
|
+
- API references
|
|
34
|
+
- Guides and tutorials
|
|
35
|
+
|
|
36
|
+
### Commit Standards
|
|
37
|
+
Use conventional commits with scope:
|
|
38
|
+
- `feat(scope): description` - New features
|
|
39
|
+
- `fix(scope): description` - Bug fixes
|
|
40
|
+
- `docs(scope): description` - Documentation changes
|
|
41
|
+
- `refactor(scope): description` - Code refactoring
|
|
42
|
+
- `test(scope): description` - Test additions/changes
|
|
43
|
+
- `chore(scope): description` - Maintenance tasks
|
|
44
|
+
|
|
45
|
+
## OMGKIT Quick Reference
|
|
46
|
+
|
|
47
|
+
### Essential Commands
|
|
48
|
+
```bash
|
|
49
|
+
/sprint:vision-set # Set product vision
|
|
50
|
+
/sprint:sprint-new # Create a new sprint
|
|
51
|
+
/sprint:team-run # Start the AI team
|
|
52
|
+
/dev:feature # Implement a feature
|
|
53
|
+
/dev:fix # Debug and fix issues
|
|
54
|
+
/git:commit # Commit changes
|
|
55
|
+
/git:pr # Create pull request
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Available Agents
|
|
59
|
+
- **planner** - Task decomposition and implementation planning
|
|
60
|
+
- **researcher** - Technology research and best practices
|
|
61
|
+
- **debugger** - Bug investigation and root cause analysis
|
|
62
|
+
- **tester** - Test creation and quality assurance
|
|
63
|
+
- **code-reviewer** - Code quality and security review
|
|
64
|
+
- **fullstack-developer** - Full implementation
|
|
65
|
+
- **git-manager** - Version control and PR automation
|
|
66
|
+
|
|
67
|
+
### Modes
|
|
68
|
+
Switch modes with `/context:mode <mode>`:
|
|
69
|
+
- `default` - Balanced assistance
|
|
70
|
+
- `omega` - Maximum AI capabilities
|
|
71
|
+
- `autonomous` - Minimal intervention
|
|
72
|
+
- `implementation` - Focused coding
|
|
73
|
+
|
|
74
|
+
## Quality Gates
|
|
75
|
+
|
|
76
|
+
Before completing any task:
|
|
77
|
+
- [ ] All tests pass
|
|
78
|
+
- [ ] No lint errors
|
|
79
|
+
- [ ] No security vulnerabilities
|
|
80
|
+
- [ ] Documentation updated if needed
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
*Think Omega. Build Omega. Be Omega.*
|