aiwf 0.3.15 → 0.3.17
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.ko.md +4 -5
- package/README.md +90 -196
- package/docs/ADR_MANAGEMENT_GUIDE.ko.md +602 -0
- package/docs/ADR_MANAGEMENT_GUIDE.md +602 -0
- package/docs/API_REFERENCE_FULL.ko.md +1135 -0
- package/docs/API_REFERENCE_FULL.md +1135 -0
- package/docs/ARCHITECTURE.ko.md +314 -0
- package/docs/ARCHITECTURE.md +314 -0
- package/docs/EXAMPLES.ko.md +695 -0
- package/docs/EXAMPLES.md +12 -12
- package/docs/GETTING_STARTED.ko.md +219 -0
- package/docs/GETTING_STARTED.md +19 -26
- package/docs/MODULE_MANAGEMENT_GUIDE.ko.md +289 -0
- package/docs/MODULE_MANAGEMENT_GUIDE.md +289 -0
- package/docs/PERFORMANCE_GUIDELINES.ko.md +388 -0
- package/docs/PRD.ko.md +2 -2
- package/docs/PRD.md +2 -2
- package/docs/TROUBLESHOOTING.ko.md +366 -0
- package/docs/YOLO_SYSTEM_GUIDE.ko.md +542 -0
- package/docs/YOLO_SYSTEM_GUIDE.md +542 -0
- package/package.json +50 -2
- package/src/DEPENDENCY_MAP.md +90 -0
- package/src/lib/installer.js +1 -0
- package/src/lib/resources/templates/api-server/template/src/controllers/aiwfController.ts +0 -14
- package/src/lib/resources/templates/api-server/template/src/routes/aiwf.ts +0 -11
- package/src/lib/resources/templates/web-app/template/src/pages/AiwfDashboard.tsx +2 -5
- package/src/lib/resources/utils/token-reporter.js +2 -3
- package/src/utils/checkpoint-manager.js +11 -1
- package/src/utils/engineering-guard.js +11 -1
- package/templates/api-server/template/src/controllers/aiwfController.ts +0 -14
- package/templates/api-server/template/src/routes/aiwf.ts +0 -11
- package/templates/web-app/template/src/pages/AiwfDashboard.tsx +2 -5
- package/docs/guides/feature-git-integration-guide-ko.md +0 -481
- package/docs/guides/feature-git-integration-guide.md +0 -481
- package/src/commands/cache-templates.js +0 -209
- package/src/commands/create-offline.js +0 -86
- package/src/commands/state-refactored.js +0 -419
- package/src/lib/resources/commands/feature-ledger.js +0 -565
- package/src/lib/resources/commands/feature_commit_report.js +0 -370
- package/src/lib/resources/commands/scan_git_history.js +0 -234
- package/src/lib/resources/commands/sync_feature_commits.js +0 -154
- package/src/lib/resources/templates/web-app/template/src/components/aiwf/FeatureLedger.tsx +0 -93
- package/src/lib/resources/utils/feature-updater.js +0 -271
- package/src/utils/git-integration.js +0 -173
- package/templates/web-app/template/src/components/aiwf/FeatureLedger.tsx +0 -93
package/README.ko.md
CHANGED
|
@@ -131,7 +131,7 @@ your_project/
|
|
|
131
131
|
### 주요 명령어
|
|
132
132
|
|
|
133
133
|
- **초기화**: `/project:aiwf:initialize` - 프로젝트 초기 설정
|
|
134
|
-
- **계획**: `/project:aiwf:
|
|
134
|
+
- **계획**: `/project:aiwf:aiwf_create_milestone_plan` - 마일스톤 계획 수립
|
|
135
135
|
- **스프린트**: `/project:aiwf:create_sprints_from_milestone` - 스프린트 생성
|
|
136
136
|
- **작업**: `/project:aiwf:do_task` - 작업 실행
|
|
137
137
|
- **리뷰**: `/project:aiwf:code_review` - 코드 리뷰
|
|
@@ -153,9 +153,11 @@ your_project/
|
|
|
153
153
|
- [기능 Git 통합 가이드](docs/guides/feature-git-integration-guide-ko.md) - Git hooks 및 추적
|
|
154
154
|
|
|
155
155
|
### 기술 문서
|
|
156
|
+
- [아키텍처](docs/ARCHITECTURE.ko.md) - 시스템 아키텍처 및 설계
|
|
156
157
|
- [상태 관리 가이드](docs/STATE_MANAGEMENT_GUIDE.ko.md) - 워크플로우 기반 상태 시스템
|
|
157
158
|
- [AI 워크플로우](docs/AI-WORKFLOW.ko.md) - AI 통합 패턴
|
|
158
159
|
- [API 참조](docs/API_REFERENCE.md) - 프로그래머틱 사용
|
|
160
|
+
- [전체 API 참조](docs/API_REFERENCE_FULL.ko.md) - 포괄적인 API 문서
|
|
159
161
|
- [문제 해결](docs/TROUBLESHOOTING.md) - 일반적인 문제 및 해결책
|
|
160
162
|
|
|
161
163
|
## ✨ 주요 기능
|
|
@@ -173,7 +175,6 @@ your_project/
|
|
|
173
175
|
- 🎭 **AI 페르소나** - 5가지 전문 페르소나 (Architect, Security, Frontend, Backend, Data Analyst)
|
|
174
176
|
- 🧠 **페르소나 인식 압축** - 활성 페르소나에 최적화된 지능형 컨텍스트 압축
|
|
175
177
|
- 📈 **경량 평가 시스템** - 최소한의 부담으로 자동 백그라운드 품질 모니터링
|
|
176
|
-
- 🚀 **Feature Ledger** - 개발 진행 상황 추적을 위한 기능 ID 시스템
|
|
177
178
|
- 🔍 **AI 도구 템플릿** - GitHub Copilot, Cursor, Windsurf, Augment 지원
|
|
178
179
|
- 🪝 **Git Hooks 통합** - git 커밋과 함께 자동 기능 추적
|
|
179
180
|
- 🤖 **워크플로우 기반 상태 관리** - 지능적 작업 우선순위 지정 및 의존성 추적
|
|
@@ -238,7 +239,6 @@ aiwf/
|
|
|
238
239
|
├── commands/ # AIWF 명령어 구현
|
|
239
240
|
├── config/ # 설정 파일
|
|
240
241
|
├── docs/ # 프로젝트 문서
|
|
241
|
-
├── feature-ledger/ # 기능 추적 JSON 파일
|
|
242
242
|
├── hooks/ # 자동화된 워크플로우를 위한 Git hooks
|
|
243
243
|
├── lib/ # 핵심 라이브러리 모듈
|
|
244
244
|
├── personas/ # AI 페르소나 정의
|
|
@@ -251,8 +251,7 @@ aiwf/
|
|
|
251
251
|
|
|
252
252
|
### 주요 디렉토리
|
|
253
253
|
|
|
254
|
-
- **
|
|
255
|
-
- **hooks/**: 자동 기능 추적을 위한 git hooks (post-commit) 포함
|
|
254
|
+
- **hooks/**: 자동화 워크플로우를 위한 git hooks (post-commit) 포함
|
|
256
255
|
|
|
257
256
|
## 🔧 요구사항
|
|
258
257
|
|
package/README.md
CHANGED
|
@@ -8,10 +8,33 @@
|
|
|
8
8
|
|
|
9
9
|
## What is AIWF?
|
|
10
10
|
|
|
11
|
-
AIWF is
|
|
11
|
+
AIWF is an AI-powered workflow framework that enables autonomous software development with Claude Code. It provides intelligent command sets and workflow definitions that allow AI to manage entire project lifecycles - from planning to deployment - with minimal human intervention.
|
|
12
12
|
|
|
13
13
|
This project is an updated version of [Simone](https://github.com/Helmi/claude-simone).
|
|
14
14
|
|
|
15
|
+
## ✨ Core Features
|
|
16
|
+
|
|
17
|
+
### 🤖 **Agent-Based Autonomous Development**
|
|
18
|
+
Multi-agent architecture where AIWF acts as the master orchestrator managing entire development workflows, while Claude Code operates as specialized subagents handling specific tasks. YOLO mode enables completely autonomous development - AI handles planning, coding, testing, and deployment without human intervention. Built-in checkpoint system ensures resilience and recovery.
|
|
19
|
+
|
|
20
|
+
### 🧠 **Intelligent Task Management**
|
|
21
|
+
Workflow-based state management with dependency tracking, priority calculation, and smart task recommendations. AI understands project context and suggests optimal next actions.
|
|
22
|
+
|
|
23
|
+
### 🎭 **Specialized AI Personas**
|
|
24
|
+
Five expert personas (Architect, Security, Frontend, Backend, Data Analyst) with specialized knowledge bases and context-aware compression for domain-specific optimization.
|
|
25
|
+
|
|
26
|
+
### 🧬 **Advanced Context Engineering**
|
|
27
|
+
Intelligent context construction and optimization that maximizes AI effectiveness while minimizing token usage. Dynamic context compression, workflow-aware prompt engineering, and automatic relevance filtering ensure AI always has the right information at the right time.
|
|
28
|
+
|
|
29
|
+
### 💡 **Smart Context Management**
|
|
30
|
+
Token-efficient context strategies with automatic compression, intelligent chunking, and relevance scoring. Maintains comprehensive project understanding while optimizing for AI model limits and performance.
|
|
31
|
+
|
|
32
|
+
### 🔄 **Multi-Agent Architecture**
|
|
33
|
+
AIWF operates as the master orchestration agent that coordinates complex development workflows. Claude Code instances function as specialized subagents, each handling specific domains like coding, testing, or documentation. This distributed approach enables parallel processing, fault tolerance, and specialized expertise application.
|
|
34
|
+
|
|
35
|
+
### 🔗 **Seamless Integration**
|
|
36
|
+
Native support for Claude Code, Cursor, Windsurf, GitHub, and Git with automated hooks, issue creation, and PR management.
|
|
37
|
+
|
|
15
38
|
## 📦 Installation
|
|
16
39
|
|
|
17
40
|
### Global Installation (Recommended)
|
|
@@ -35,54 +58,88 @@ The installer will guide you through:
|
|
|
35
58
|
3. **Claude Commands**: Install language-specific commands
|
|
36
59
|
4. **Documentation**: Download guides and templates
|
|
37
60
|
|
|
38
|
-
## 🚀
|
|
39
|
-
|
|
40
|
-
### Basic Commands
|
|
61
|
+
## 🚀 Getting Started Guide
|
|
41
62
|
|
|
63
|
+
### Step 1: Installation
|
|
42
64
|
```bash
|
|
43
|
-
# Install
|
|
65
|
+
# Install globally
|
|
66
|
+
npm install -g aiwf
|
|
67
|
+
|
|
68
|
+
# Setup in your project directory
|
|
69
|
+
cd your-project
|
|
44
70
|
aiwf install
|
|
71
|
+
```
|
|
45
72
|
|
|
46
|
-
|
|
47
|
-
|
|
73
|
+
### Step 2: Project Planning Phase
|
|
74
|
+
Enter **Plan Mode** - describe what you want to build and your project goals. **Do not start coding yet.**
|
|
75
|
+
- Engage in thorough Q&A to clarify objectives
|
|
76
|
+
- Define project scope and requirements
|
|
77
|
+
- Set clear success criteria
|
|
48
78
|
|
|
49
|
-
|
|
50
|
-
|
|
79
|
+
### Step 3: Initialize Project Framework
|
|
80
|
+
```bash
|
|
81
|
+
# Create/update Claude configuration
|
|
82
|
+
/init
|
|
51
83
|
|
|
52
|
-
#
|
|
53
|
-
aiwf
|
|
84
|
+
# Initialize AIWF framework (creates first milestone)
|
|
85
|
+
/project:aiwf:aiwf_initialize
|
|
54
86
|
```
|
|
55
87
|
|
|
56
|
-
###
|
|
88
|
+
### Step 4: Create Sprint Plans
|
|
89
|
+
```bash
|
|
90
|
+
# Generate sprints from milestone (first sprint becomes active)
|
|
91
|
+
/project:aiwf:aiwf_create_sprints_from_milestone M01
|
|
57
92
|
|
|
93
|
+
# If only one milestone exists, you can omit the milestone code
|
|
94
|
+
/project:aiwf:aiwf_create_sprints_from_milestone
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Step 5: Review and Refine
|
|
98
|
+
Review generated plans and refine through Q&A until satisfied with the approach.
|
|
99
|
+
|
|
100
|
+
### Step 6: Generate Task Lists
|
|
58
101
|
```bash
|
|
59
|
-
#
|
|
60
|
-
aiwf
|
|
102
|
+
# Create detailed tasks for active sprint (first task becomes active)
|
|
103
|
+
/project:aiwf:aiwf_create_sprint_tasks
|
|
104
|
+
```
|
|
61
105
|
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
106
|
+
### Step 7: Execute Development
|
|
107
|
+
```bash
|
|
108
|
+
# Execute individual task
|
|
109
|
+
/project:aiwf:aiwf_do_task [task-id]
|
|
65
110
|
|
|
66
|
-
#
|
|
67
|
-
aiwf
|
|
111
|
+
# OR run autonomous development for entire sprint
|
|
112
|
+
/project:aiwf:aiwf_yolo
|
|
68
113
|
```
|
|
69
114
|
|
|
70
|
-
|
|
115
|
+
**YOLO Mode** orchestrates multiple Claude Code subagents to execute all sprint tasks continuously without interruption. The master agent coordinates planning while specialized subagents handle coding, testing, documentation, and commits automatically.
|
|
71
116
|
|
|
72
|
-
|
|
117
|
+
### Key Commands
|
|
118
|
+
|
|
119
|
+
- **Initialize**: `/project:aiwf:aiwf_initialize` - Initial project setup
|
|
120
|
+
- **Plan**: `/project:aiwf:aiwf_create_milestone_plan` - Create milestone plans
|
|
121
|
+
- **Sprint**: `/project:aiwf:aiwf_create_sprints_from_milestone` - Generate sprints
|
|
122
|
+
- **Task**: `/project:aiwf:aiwf_do_task` - Execute tasks
|
|
123
|
+
- **Review**: `/project:aiwf:aiwf_code_review` - Code review
|
|
124
|
+
- **GitHub Integration**: `/project:aiwf:aiwf_issue_create`, `/project:aiwf:aiwf_pr_create`
|
|
125
|
+
- **AI Personas**: `/project:aiwf:aiwf_ai_persona_architect`, `/project:aiwf:aiwf_ai_persona_debugger`, etc.
|
|
73
126
|
|
|
74
|
-
|
|
75
|
-
1. **Update**: Updates commands and docs only, preserves work content
|
|
76
|
-
2. **Complete Reinstall**: Fresh installation, overwrites existing project
|
|
77
|
-
3. **Skip**: Cancel installation
|
|
127
|
+
### 🚀 YOLO Mode - Autonomous AI Development
|
|
78
128
|
|
|
79
|
-
|
|
80
|
-
- `--force`: Skip all prompts and perform complete reinstall
|
|
129
|
+
Revolutionary multi-agent orchestration that enables completely autonomous development workflows. AIWF acts as the master agent coordinating multiple Claude Code subagents:
|
|
81
130
|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
131
|
+
```bash
|
|
132
|
+
# Full autonomous development - AI handles everything
|
|
133
|
+
/project:aiwf:aiwf_yolo
|
|
134
|
+
|
|
135
|
+
# Target specific sprint execution
|
|
136
|
+
/project:aiwf:aiwf_yolo S03
|
|
137
|
+
|
|
138
|
+
# Continuous multi-sprint development
|
|
139
|
+
/project:aiwf:aiwf_yolo sprint-all
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Master agent analyzes requirements and coordinates specialized subagents that create tasks, write code, run tests, and commit changes - achieving true multi-agent autonomous software development.
|
|
86
143
|
|
|
87
144
|
## 📁 What Gets Installed
|
|
88
145
|
|
|
@@ -121,47 +178,6 @@ Based on your language selection, you'll get:
|
|
|
121
178
|
- Korean documentation and templates
|
|
122
179
|
- Localized project management content
|
|
123
180
|
|
|
124
|
-
## 🎯 Getting Started
|
|
125
|
-
|
|
126
|
-
After installation:
|
|
127
|
-
|
|
128
|
-
1. Open your project in Claude Code
|
|
129
|
-
2. Use `/project:aiwf` commands to manage your project
|
|
130
|
-
3. Start with `/project:aiwf:initialize` to set up your project
|
|
131
|
-
|
|
132
|
-
### Key Commands
|
|
133
|
-
|
|
134
|
-
- **Initialize**: `/project:aiwf:initialize` - Initial project setup
|
|
135
|
-
- **Plan**: `/project:aiwf:plan_milestone` - Create milestone plans
|
|
136
|
-
- **Sprint**: `/project:aiwf:create_sprints_from_milestone` - Generate sprints
|
|
137
|
-
- **Task**: `/project:aiwf:do_task` - Execute tasks
|
|
138
|
-
- **Review**: `/project:aiwf:code_review` - Code review
|
|
139
|
-
- **GitHub Integration**: `/project:aiwf:issue_create`, `/project:aiwf:pr_create`
|
|
140
|
-
- **AI Personas**: `/project:aiwf:ai_persona:architect`, `/project:aiwf:ai_persona:debugger`, etc.
|
|
141
|
-
|
|
142
|
-
### 🚀 YOLO Mode - The Core Feature
|
|
143
|
-
|
|
144
|
-
YOLO mode is the heart of AIWF, enabling autonomous task execution:
|
|
145
|
-
|
|
146
|
-
```bash
|
|
147
|
-
# Basic YOLO - processes general tasks then sprint tasks
|
|
148
|
-
/project:aiwf:yolo
|
|
149
|
-
|
|
150
|
-
# Sprint-specific execution
|
|
151
|
-
/project:aiwf:yolo S03
|
|
152
|
-
|
|
153
|
-
# Execute all sprints continuously
|
|
154
|
-
/project:aiwf:yolo sprint-all
|
|
155
|
-
|
|
156
|
-
# Execute all milestones
|
|
157
|
-
/project:aiwf:yolo milestone-all
|
|
158
|
-
|
|
159
|
-
# Independent sprint creation (no milestone required)
|
|
160
|
-
aiwf sprint-independent --from-readme
|
|
161
|
-
aiwf sprint-independent --from-issue 123
|
|
162
|
-
aiwf sprint-independent "Quick Feature" --minimal
|
|
163
|
-
```
|
|
164
|
-
|
|
165
181
|
## 📚 Documentation
|
|
166
182
|
|
|
167
183
|
### Core Documentation
|
|
@@ -178,135 +194,13 @@ aiwf sprint-independent "Quick Feature" --minimal
|
|
|
178
194
|
- [Feature Git Integration Guide](docs/guides/feature-git-integration-guide.md) - Git hooks and tracking
|
|
179
195
|
|
|
180
196
|
### Technical Documentation
|
|
197
|
+
- [Architecture](docs/ARCHITECTURE.md) - System architecture and design
|
|
181
198
|
- [State Management Guide](docs/STATE_MANAGEMENT_GUIDE.md) - Workflow-based state system
|
|
182
199
|
- [AI Workflow](docs/AI-WORKFLOW.md) - AI integration patterns
|
|
183
200
|
- [API Reference](docs/API_REFERENCE.md) - Programmatic usage
|
|
201
|
+
- [Complete API Reference](docs/API_REFERENCE_FULL.md) - Comprehensive API documentation
|
|
184
202
|
- [Troubleshooting](docs/TROUBLESHOOTING.md) - Common issues and solutions
|
|
185
203
|
|
|
186
|
-
## ✨ Features
|
|
187
|
-
|
|
188
|
-
- 🌍 **Multi-language Support** - Complete English and Korean support
|
|
189
|
-
- 🎨 **Beautiful CLI** - User-friendly interface with colors and progress indicators
|
|
190
|
-
- 🔄 **Smart Updates** - Intelligent update detection with automatic backups
|
|
191
|
-
- 📦 **Direct Download** - Downloads directly from official GitHub repository
|
|
192
|
-
- 🚀 **Easy to Use** - Works with `npx` - no global installation needed
|
|
193
|
-
- 💾 **Safe Backups** - Creates timestamped backups when updating
|
|
194
|
-
- 🎯 **Language-Specific** - Language-specific commands and documentation
|
|
195
|
-
- 🔧 **IDE Integration** - Cursor and Windsurf development rules support
|
|
196
|
-
- 🔗 **GitHub Integration** - Automated issue and PR creation
|
|
197
|
-
- 📊 **Project Tracking** - Systematic management of milestones, sprints, and tasks
|
|
198
|
-
- 🎭 **AI Personas** - 5 specialized personas (Architect, Security, Frontend, Backend, Data Analyst)
|
|
199
|
-
- 🧠 **Persona-Aware Compression** - Intelligent context compression optimized for active persona
|
|
200
|
-
- 📈 **Lightweight Evaluation** - Automatic background quality monitoring with minimal overhead
|
|
201
|
-
- 🚀 **Feature Ledger** - Feature ID system for development progress tracking
|
|
202
|
-
- 🔍 **AI Tool Templates** - Support for GitHub Copilot, Cursor, Windsurf, and Augment
|
|
203
|
-
- 🪝 **Git Hooks Integration** - Automated feature tracking with git commits
|
|
204
|
-
- 🤖 **Workflow-Based State Management** - Intelligent task prioritization and dependency tracking
|
|
205
|
-
- 🎯 **Smart Task Recommendations** - AI-powered next action suggestions based on project state
|
|
206
|
-
- 🔄 **Adaptive Sprint Management** - Automatic sprint generation at 80% completion
|
|
207
|
-
- 🔍 **Dependency Analysis** - Circular dependency detection and blocking task identification
|
|
208
|
-
- 🏃 **Independent Sprints** - Create and run sprints without milestone dependencies
|
|
209
|
-
- 🛡️ **Overengineering Prevention** - Built-in guards to maintain simplicity and focus
|
|
210
|
-
- 💾 **Checkpoint System** - Save and restore YOLO execution state for resilience
|
|
211
|
-
|
|
212
|
-
## 🤖 Workflow-Based State Management (NEW!)
|
|
213
|
-
|
|
214
|
-
AIWF now includes an advanced state management system that helps AI maintain project context:
|
|
215
|
-
|
|
216
|
-
### State Management Commands
|
|
217
|
-
|
|
218
|
-
```bash
|
|
219
|
-
# Update project state index
|
|
220
|
-
aiwf state update
|
|
221
|
-
|
|
222
|
-
# Show current state and recommendations
|
|
223
|
-
aiwf state show
|
|
224
|
-
|
|
225
|
-
# Get AI-powered next task recommendations
|
|
226
|
-
aiwf state next
|
|
227
|
-
|
|
228
|
-
# Validate workflow consistency
|
|
229
|
-
aiwf state validate
|
|
230
|
-
|
|
231
|
-
# Mark task as started
|
|
232
|
-
aiwf state start <task-id>
|
|
233
|
-
|
|
234
|
-
# Mark task as completed
|
|
235
|
-
aiwf state complete <task-id>
|
|
236
|
-
```
|
|
237
|
-
|
|
238
|
-
### Key Features
|
|
239
|
-
|
|
240
|
-
- **Priority Matrix**: Tasks are scored based on urgency (40%), importance (30%), dependencies (20%), and effort (10%)
|
|
241
|
-
- **Dependency Tracking**: Automatically identifies blocking tasks and circular dependencies
|
|
242
|
-
- **80% Rule**: Recommends preparing next sprint when current sprint reaches 80% completion
|
|
243
|
-
- **Workflow Validation**: Ensures state consistency across milestones, sprints, and tasks
|
|
244
|
-
- **Smart Recommendations**: AI suggests optimal next actions based on project state
|
|
245
|
-
|
|
246
|
-
### Integration with YOLO Mode
|
|
247
|
-
|
|
248
|
-
The enhanced YOLO mode now uses workflow intelligence:
|
|
249
|
-
|
|
250
|
-
```bash
|
|
251
|
-
# Run YOLO with workflow-based task selection
|
|
252
|
-
/project:aiwf:yolo
|
|
253
|
-
|
|
254
|
-
# Sprint-specific with workflow optimization
|
|
255
|
-
/project:aiwf:yolo S03
|
|
256
|
-
|
|
257
|
-
# Adaptive sprint management
|
|
258
|
-
/project:aiwf:yolo sprint-all
|
|
259
|
-
```
|
|
260
|
-
|
|
261
|
-
### 🛡️ Overengineering Prevention
|
|
262
|
-
|
|
263
|
-
AIWF includes built-in guards to prevent overengineering:
|
|
264
|
-
|
|
265
|
-
- **Configurable Engineering Levels**: minimal, balanced, complete
|
|
266
|
-
- **Focus Rules**: requirement_first, simple_solution, no_gold_plating
|
|
267
|
-
- **Code Complexity Checks**: file size, function length, nesting depth limits
|
|
268
|
-
- **Design Pattern Limits**: prevents excessive abstraction
|
|
269
|
-
- **YAGNI Enforcement**: no future-proofing without current need
|
|
270
|
-
|
|
271
|
-
Configure in `.aiwf/yolo-config.yaml`:
|
|
272
|
-
|
|
273
|
-
```yaml
|
|
274
|
-
engineering_level: minimal
|
|
275
|
-
focus_rules:
|
|
276
|
-
requirement_first: true
|
|
277
|
-
simple_solution: true
|
|
278
|
-
no_gold_plating: true
|
|
279
|
-
```
|
|
280
|
-
|
|
281
|
-
## 📁 Project Structure
|
|
282
|
-
|
|
283
|
-
```
|
|
284
|
-
aiwf/
|
|
285
|
-
├── ai-tools/ # AI tool-specific configurations
|
|
286
|
-
├── commands/ # AIWF command implementations
|
|
287
|
-
├── config/ # Configuration files
|
|
288
|
-
├── docs/ # Project documentation
|
|
289
|
-
├── feature-ledger/ # Feature tracking JSON files
|
|
290
|
-
├── hooks/ # Git hooks for automated workflows
|
|
291
|
-
├── lib/ # Core library modules
|
|
292
|
-
├── personas/ # AI persona definitions
|
|
293
|
-
├── rules/ # Development rules and guidelines
|
|
294
|
-
├── scripts/ # Build and utility scripts
|
|
295
|
-
├── templates/ # Project templates (api-server, npm-library, web-app)
|
|
296
|
-
├── tests/ # Test suites
|
|
297
|
-
└── utils/ # Utility modules
|
|
298
|
-
```
|
|
299
|
-
|
|
300
|
-
### Key Directories
|
|
301
|
-
|
|
302
|
-
- **feature-ledger/**: Tracks feature development status and git commit relationships
|
|
303
|
-
- **hooks/**: Contains git hooks (post-commit) for automatic feature tracking
|
|
304
|
-
|
|
305
|
-
## 🔧 Requirements
|
|
306
|
-
|
|
307
|
-
- Node.js 14.0.0 or higher
|
|
308
|
-
- Internet connection to download from GitHub
|
|
309
|
-
|
|
310
204
|
## 📖 Source
|
|
311
205
|
|
|
312
206
|
This installer fetches the AIWF framework from:
|