aiwf 0.3.17 → 0.3.19
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 +84 -0
- package/README.md +87 -0
- package/ai-tools/README.md +105 -0
- package/ai-tools/augment/README.md +371 -0
- package/ai-tools/augment/config.json +30 -0
- package/ai-tools/augment/template/.augment/aiwf-integration.md +387 -0
- package/ai-tools/augment/template/.augment/augment.yaml +347 -0
- package/ai-tools/augment/template/augment.config.json +64 -0
- package/ai-tools/claude-code/README.md +151 -0
- package/ai-tools/claude-code/config.json +28 -0
- package/ai-tools/claude-code/template/CLAUDE.md +91 -0
- package/ai-tools/cursor/README.md +314 -0
- package/ai-tools/cursor/config.json +29 -0
- package/ai-tools/cursor/template/.cursorrules +362 -0
- package/ai-tools/github-copilot/README.md +195 -0
- package/ai-tools/github-copilot/config.json +24 -0
- package/ai-tools/github-copilot/template/.github/copilot-instructions.md +202 -0
- package/ai-tools/windsurf/README.md +355 -0
- package/ai-tools/windsurf/config.json +29 -0
- package/ai-tools/windsurf/template/.windsurf/aiwf-rules.md +260 -0
- package/ai-tools/windsurf/template/.windsurf/windsurf.config.js +312 -0
- package/ai-tools/windsurf/template/windsurf.config.json +63 -0
- package/docs/CODE_CLEANUP_GUIDE.ko.md +415 -0
- package/docs/CODE_CLEANUP_GUIDE.md +415 -0
- package/docs/VALIDATOR_API.ko.md +324 -0
- package/docs/VALIDATOR_API.md +324 -0
- package/package.json +3 -2
- package/src/cli/index.js +338 -0
- package/src/config/file-lists.js +5 -5
- package/src/lib/backup-manager.js +4 -3
- package/src/lib/installer.js +126 -3
- package/src/lib/validator.js +78 -313
- package/src/utils/messages.js +16 -2
- package/src/utils/paths.js +1 -20
- package/templates/README.md +0 -78
- package/templates/api-server/config.json +0 -64
- package/templates/api-server/template/.aiwf/config.json +0 -56
- package/templates/api-server/template/.aiwf/feature-ledger.json +0 -42
- package/templates/api-server/template/.aiwf/personas/backend-engineer.json +0 -40
- package/templates/api-server/template/.aiwf/scripts/cli.js +0 -111
- package/templates/api-server/template/.env.example +0 -29
- package/templates/api-server/template/.eslintrc.json +0 -23
- package/templates/api-server/template/README.md +0 -171
- package/templates/api-server/template/jest.config.js +0 -26
- package/templates/api-server/template/nodemon.json +0 -9
- package/templates/api-server/template/package.json +0 -61
- package/templates/api-server/template/src/app.ts +0 -60
- package/templates/api-server/template/src/config/swagger.ts +0 -38
- package/templates/api-server/template/src/controllers/aiwfController.ts +0 -54
- package/templates/api-server/template/src/controllers/authController.ts +0 -128
- package/templates/api-server/template/src/controllers/statusController.ts +0 -28
- package/templates/api-server/template/src/index.ts +0 -28
- package/templates/api-server/template/src/middleware/aiwfMiddleware.ts +0 -50
- package/templates/api-server/template/src/middleware/authMiddleware.ts +0 -41
- package/templates/api-server/template/src/middleware/errorHandler.ts +0 -42
- package/templates/api-server/template/src/middleware/notFoundHandler.ts +0 -14
- package/templates/api-server/template/src/middleware/requestLogger.ts +0 -20
- package/templates/api-server/template/src/routes/aiwf.ts +0 -31
- package/templates/api-server/template/src/routes/index.ts +0 -13
- package/templates/api-server/template/src/routes/v1/index.ts +0 -67
- package/templates/api-server/template/src/utils/logger.ts +0 -37
- package/templates/api-server/template/tests/app.test.ts +0 -40
- package/templates/api-server/template/tsconfig.json +0 -43
- package/templates/npm-library/config.json +0 -61
- package/templates/npm-library/template/LICENSE +0 -21
- package/templates/npm-library/template/README.md +0 -201
- package/templates/npm-library/template/package.json +0 -78
- package/templates/web-app/config.json +0 -53
- package/templates/web-app/template/.aiwf/config.json +0 -54
- package/templates/web-app/template/.aiwf/feature-ledger.json +0 -37
- package/templates/web-app/template/.aiwf/personas/fullstack-developer.json +0 -40
- package/templates/web-app/template/.aiwf/scripts/cli.js +0 -110
- package/templates/web-app/template/.eslintrc.cjs +0 -20
- package/templates/web-app/template/README.md +0 -151
- package/templates/web-app/template/index.html +0 -14
- package/templates/web-app/template/package.json +0 -44
- package/templates/web-app/template/postcss.config.js +0 -6
- package/templates/web-app/template/public/vite.svg +0 -1
- package/templates/web-app/template/src/App.tsx +0 -21
- package/templates/web-app/template/src/components/Layout.tsx +0 -57
- package/templates/web-app/template/src/components/aiwf/ContextStatus.tsx +0 -107
- package/templates/web-app/template/src/components/aiwf/TokenUsage.tsx +0 -71
- package/templates/web-app/template/src/index.css +0 -60
- package/templates/web-app/template/src/main.tsx +0 -10
- package/templates/web-app/template/src/pages/AiwfDashboard.tsx +0 -57
- package/templates/web-app/template/src/pages/HomePage.tsx +0 -89
- package/templates/web-app/template/src/pages/NotFound.tsx +0 -25
- package/templates/web-app/template/src/stores/aiwfStore.ts +0 -126
- package/templates/web-app/template/src/types/global.d.ts +0 -9
- package/templates/web-app/template/src/vite-env.d.ts +0 -1
- package/templates/web-app/template/tailwind.config.js +0 -30
- package/templates/web-app/template/tsconfig.json +0 -37
- package/templates/web-app/template/tsconfig.node.json +0 -10
- package/templates/web-app/template/vite.config.ts +0 -23
- /package/rules/global/{code-style-guide.md → aiwf-code-style-guide.md} +0 -0
- /package/rules/global/{coding-principles.md → aiwf-coding-principles.md} +0 -0
- /package/rules/global/{development-process.md → aiwf-development-process.md} +0 -0
- /package/rules/global/{global-rules.md → aiwf-global-rules.md} +0 -0
- /package/rules/manual/{generate-plan-docs.md → aiwf-generate-plan-docs.md} +0 -0
package/README.ko.md
CHANGED
|
@@ -33,6 +33,7 @@ aiwf install
|
|
|
33
33
|
2. **프로젝트 설정**: 현재 디렉토리에 AIWF 초기화
|
|
34
34
|
3. **Claude 명령어**: 언어별 명령어 설치
|
|
35
35
|
4. **문서화**: 가이드 및 템플릿 다운로드
|
|
36
|
+
5. **검증**: 포괄적인 설치 검증 및 문제 해결
|
|
36
37
|
|
|
37
38
|
## 🚀 사용법
|
|
38
39
|
|
|
@@ -120,6 +121,42 @@ your_project/
|
|
|
120
121
|
- English documentation and templates
|
|
121
122
|
- Standard project management content
|
|
122
123
|
|
|
124
|
+
## 🛠️ CLI 도구
|
|
125
|
+
|
|
126
|
+
AIWF는 프로젝트 관리의 다양한 측면을 위한 여러 전문 CLI 도구를 제공합니다:
|
|
127
|
+
|
|
128
|
+
### 주요 CLI 명령어
|
|
129
|
+
- `aiwf install` - 현재 프로젝트에 AIWF 프레임워크 설치
|
|
130
|
+
- `aiwf create-project` - 템플릿에서 새 프로젝트 생성
|
|
131
|
+
- `aiwf compress` - 토큰 최적화를 위한 컨텍스트 압축
|
|
132
|
+
- `aiwf token` - 토큰 사용량 모니터링 및 관리
|
|
133
|
+
- `aiwf persona` - AI 페르소나 관리
|
|
134
|
+
- `aiwf evaluate` - AI 응답 및 코드 품질 평가
|
|
135
|
+
|
|
136
|
+
### 스프린트 관리 (`aiwf-sprint`)
|
|
137
|
+
- `aiwf-sprint create` - 새로운 독립 스프린트 생성
|
|
138
|
+
- `aiwf-sprint list` - 모든 스프린트 목록 조회
|
|
139
|
+
- `aiwf-sprint status` - 스프린트 상태 및 진행상황 표시
|
|
140
|
+
- `aiwf-sprint task create` - 스프린트에 작업 추가
|
|
141
|
+
- `aiwf-sprint task execute` - 스프린트 작업 실행
|
|
142
|
+
|
|
143
|
+
### 체크포인트 시스템 (`aiwf-checkpoint`)
|
|
144
|
+
- `aiwf-checkpoint create` - 롤백을 위한 프로젝트 체크포인트 생성
|
|
145
|
+
- `aiwf-checkpoint list` - 사용 가능한 모든 체크포인트 목록
|
|
146
|
+
- `aiwf-checkpoint restore` - 이전 체크포인트로 프로젝트 복원
|
|
147
|
+
|
|
148
|
+
### 언어 관리 (`aiwf-lang`)
|
|
149
|
+
- `aiwf-lang status` - 현재 언어 설정 확인
|
|
150
|
+
- `aiwf-lang set ko` - 한국어로 전환
|
|
151
|
+
- `aiwf-lang set en` - 영어로 전환
|
|
152
|
+
|
|
153
|
+
### 캐시 관리 (`aiwf-cache`)
|
|
154
|
+
- `aiwf-cache download` - 템플릿을 로컬 캐시에 다운로드
|
|
155
|
+
- `aiwf-cache list` - 캐시된 모든 템플릿 목록
|
|
156
|
+
- `aiwf-cache clean` - 캐시 저장소 정리
|
|
157
|
+
- `aiwf-cache update` - 캐시된 템플릿 업데이트
|
|
158
|
+
- `aiwf-cache status` - 캐시 상태 및 사용량 확인
|
|
159
|
+
|
|
123
160
|
## 🎯 시작하기
|
|
124
161
|
|
|
125
162
|
설치 후 다음 단계:
|
|
@@ -137,6 +174,51 @@ your_project/
|
|
|
137
174
|
- **리뷰**: `/project:aiwf:code_review` - 코드 리뷰
|
|
138
175
|
- **GitHub 연동**: `/project:aiwf:issue_create`, `/project:aiwf:pr_create`
|
|
139
176
|
|
|
177
|
+
## 🏗️ 코드 아키텍처
|
|
178
|
+
|
|
179
|
+
### 최적화된 검증 시스템
|
|
180
|
+
|
|
181
|
+
AIWF는 안정적인 설치와 운영을 보장하는 크게 개선된 검증 시스템을 특징으로 합니다:
|
|
182
|
+
|
|
183
|
+
#### v0.3.18+의 주요 개선사항
|
|
184
|
+
- **86% 코드 감소**: validator.js를 348줄에서 48줄로 간소화
|
|
185
|
+
- **통합 인터페이스**: 3개의 중복 메서드를 대체하는 단일 `validateInstallation()` 함수
|
|
186
|
+
- **상수 기반 구성**: 모든 검증 매개변수가 `VALIDATION_CONSTANTS`에 중앙화됨
|
|
187
|
+
- **향상된 오류 보고**: 상세한 진단을 포함한 구체적이고 실행 가능한 오류 메시지
|
|
188
|
+
|
|
189
|
+
#### VALIDATION_CONSTANTS 구조
|
|
190
|
+
```javascript
|
|
191
|
+
const VALIDATION_CONSTANTS = {
|
|
192
|
+
MIN_FILE_SIZE: 10, // 최소 파일 크기 요구사항
|
|
193
|
+
MIN_RULE_FILE_SIZE: 50, // AI 도구 규칙 파일의 최소 크기
|
|
194
|
+
MIN_FILE_COUNT: {
|
|
195
|
+
CURSOR_MDC: 2, // Cursor용 필수 .mdc 파일
|
|
196
|
+
WINDSURF_MD: 2, // Windsurf용 필수 .md 파일
|
|
197
|
+
CLAUDE_COMMANDS: 4 // Claude용 필수 명령 파일
|
|
198
|
+
}
|
|
199
|
+
};
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
#### 검증 기능
|
|
203
|
+
- **다중 도구 지원**: Claude Code, Cursor, Windsurf, Gemini CLI 검증
|
|
204
|
+
- **파일 무결성 검사**: 크기 검증, 접근성 확인, 구조 검증
|
|
205
|
+
- **지능적 오류 복구**: 실패한 검증에 대한 상세한 문제 해결 가이드
|
|
206
|
+
- **성능 최적화**: 감소된 메모리 사용량으로 더 빠른 실행
|
|
207
|
+
|
|
208
|
+
### 클린 아키텍처 원칙
|
|
209
|
+
|
|
210
|
+
코드베이스는 유지보수성과 확장성을 위한 클린 아키텍처 원칙을 따릅니다:
|
|
211
|
+
|
|
212
|
+
#### 코드 중복 제거
|
|
213
|
+
- **통합된 검증 로직**: 통합된 검증 함수가 중복성을 제거함
|
|
214
|
+
- **공유 상수**: 중앙화된 구성이 유지보수 오버헤드를 줄임
|
|
215
|
+
- **간소화된 오류 처리**: 모든 검증 유형에 걸쳐 일관된 오류 보고
|
|
216
|
+
|
|
217
|
+
#### 개선된 개발자 경험
|
|
218
|
+
- **명확한 관심사 분리**: 검증, 파일 관리, 오류 보고가 적절히 분리됨
|
|
219
|
+
- **유지보수 가능한 코드 구조**: 감소된 복잡성으로 코드베이스 이해와 수정이 더 쉬워짐
|
|
220
|
+
- **성능 이점**: 최적화된 코드 경로가 설치 속도와 안정성을 향상시킴
|
|
221
|
+
|
|
140
222
|
## 📚 문서
|
|
141
223
|
|
|
142
224
|
### 핵심 문서
|
|
@@ -158,6 +240,8 @@ your_project/
|
|
|
158
240
|
- [AI 워크플로우](docs/AI-WORKFLOW.ko.md) - AI 통합 패턴
|
|
159
241
|
- [API 참조](docs/API_REFERENCE.md) - 프로그래머틱 사용
|
|
160
242
|
- [전체 API 참조](docs/API_REFERENCE_FULL.ko.md) - 포괄적인 API 문서
|
|
243
|
+
- [Validator API 참조](docs/VALIDATOR_API.ko.md) - 검증 시스템 API 문서
|
|
244
|
+
- [코드 정리 가이드](docs/CODE_CLEANUP_GUIDE.ko.md) - 코드 정리 원칙과 패턴
|
|
161
245
|
- [문제 해결](docs/TROUBLESHOOTING.md) - 일반적인 문제 및 해결책
|
|
162
246
|
|
|
163
247
|
## ✨ 주요 기능
|
package/README.md
CHANGED
|
@@ -35,6 +35,9 @@ AIWF operates as the master orchestration agent that coordinates complex develop
|
|
|
35
35
|
### 🔗 **Seamless Integration**
|
|
36
36
|
Native support for Claude Code, Cursor, Windsurf, GitHub, and Git with automated hooks, issue creation, and PR management.
|
|
37
37
|
|
|
38
|
+
### ✅ **Robust Validation System**
|
|
39
|
+
Advanced installation validation with intelligent file checking, dependency verification, and automated troubleshooting. Enhanced validation architecture ensures reliable framework setup and operation.
|
|
40
|
+
|
|
38
41
|
## 📦 Installation
|
|
39
42
|
|
|
40
43
|
### Global Installation (Recommended)
|
|
@@ -57,6 +60,7 @@ The installer will guide you through:
|
|
|
57
60
|
2. **Project Setup**: Initialize AIWF in your current directory
|
|
58
61
|
3. **Claude Commands**: Install language-specific commands
|
|
59
62
|
4. **Documentation**: Download guides and templates
|
|
63
|
+
5. **Validation**: Comprehensive installation verification and troubleshooting
|
|
60
64
|
|
|
61
65
|
## 🚀 Getting Started Guide
|
|
62
66
|
|
|
@@ -141,6 +145,42 @@ Revolutionary multi-agent orchestration that enables completely autonomous devel
|
|
|
141
145
|
|
|
142
146
|
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.
|
|
143
147
|
|
|
148
|
+
## 🛠️ CLI Tools
|
|
149
|
+
|
|
150
|
+
AIWF provides several specialized CLI tools for different aspects of project management:
|
|
151
|
+
|
|
152
|
+
### Main CLI Commands
|
|
153
|
+
- `aiwf install` - Install AIWF framework in current project
|
|
154
|
+
- `aiwf create-project` - Create new project from templates
|
|
155
|
+
- `aiwf compress` - Context compression for token optimization
|
|
156
|
+
- `aiwf token` - Token usage monitoring and management
|
|
157
|
+
- `aiwf persona` - AI persona management
|
|
158
|
+
- `aiwf evaluate` - AI response and code quality evaluation
|
|
159
|
+
|
|
160
|
+
### Sprint Management (`aiwf-sprint`)
|
|
161
|
+
- `aiwf-sprint create` - Create new independent sprint
|
|
162
|
+
- `aiwf-sprint list` - List all sprints
|
|
163
|
+
- `aiwf-sprint status` - Show sprint status and progress
|
|
164
|
+
- `aiwf-sprint task create` - Add tasks to sprint
|
|
165
|
+
- `aiwf-sprint task execute` - Execute sprint tasks
|
|
166
|
+
|
|
167
|
+
### Checkpoint System (`aiwf-checkpoint`)
|
|
168
|
+
- `aiwf-checkpoint create` - Create project checkpoint for rollback
|
|
169
|
+
- `aiwf-checkpoint list` - List all available checkpoints
|
|
170
|
+
- `aiwf-checkpoint restore` - Restore project to previous checkpoint
|
|
171
|
+
|
|
172
|
+
### Language Management (`aiwf-lang`)
|
|
173
|
+
- `aiwf-lang status` - Check current language settings
|
|
174
|
+
- `aiwf-lang set ko` - Switch to Korean
|
|
175
|
+
- `aiwf-lang set en` - Switch to English
|
|
176
|
+
|
|
177
|
+
### Cache Management (`aiwf-cache`)
|
|
178
|
+
- `aiwf-cache download` - Download templates to local cache
|
|
179
|
+
- `aiwf-cache list` - List all cached templates
|
|
180
|
+
- `aiwf-cache clean` - Clean cache storage
|
|
181
|
+
- `aiwf-cache update` - Update cached templates
|
|
182
|
+
- `aiwf-cache status` - Check cache status and usage
|
|
183
|
+
|
|
144
184
|
## 📁 What Gets Installed
|
|
145
185
|
|
|
146
186
|
### Directory Structure
|
|
@@ -178,6 +218,51 @@ Based on your language selection, you'll get:
|
|
|
178
218
|
- Korean documentation and templates
|
|
179
219
|
- Localized project management content
|
|
180
220
|
|
|
221
|
+
## 🏗️ Code Architecture
|
|
222
|
+
|
|
223
|
+
### Optimized Validation System
|
|
224
|
+
|
|
225
|
+
AIWF features a significantly improved validation system that ensures reliable installation and operation:
|
|
226
|
+
|
|
227
|
+
#### Key Improvements in v0.3.18+
|
|
228
|
+
- **86% Code Reduction**: Streamlined validator.js from 348 lines to 48 lines
|
|
229
|
+
- **Unified Interface**: Single `validateInstallation()` function replaces 3 redundant methods
|
|
230
|
+
- **Constants-Based Configuration**: All validation parameters centralized in `VALIDATION_CONSTANTS`
|
|
231
|
+
- **Enhanced Error Reporting**: Specific, actionable error messages with detailed diagnostics
|
|
232
|
+
|
|
233
|
+
#### VALIDATION_CONSTANTS Structure
|
|
234
|
+
```javascript
|
|
235
|
+
const VALIDATION_CONSTANTS = {
|
|
236
|
+
MIN_FILE_SIZE: 10, // Minimum file size requirement
|
|
237
|
+
MIN_RULE_FILE_SIZE: 50, // Minimum size for AI tool rule files
|
|
238
|
+
MIN_FILE_COUNT: {
|
|
239
|
+
CURSOR_MDC: 2, // Required .mdc files for Cursor
|
|
240
|
+
WINDSURF_MD: 2, // Required .md files for Windsurf
|
|
241
|
+
CLAUDE_COMMANDS: 4 // Required command files for Claude
|
|
242
|
+
}
|
|
243
|
+
};
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
#### Validation Features
|
|
247
|
+
- **Multi-Tool Support**: Validates Claude Code, Cursor, Windsurf, and Gemini CLI
|
|
248
|
+
- **File Integrity Checks**: Size validation, accessibility verification, and structure validation
|
|
249
|
+
- **Intelligent Error Recovery**: Detailed troubleshooting guidance for failed validations
|
|
250
|
+
- **Performance Optimized**: Faster execution with reduced memory footprint
|
|
251
|
+
|
|
252
|
+
### Clean Architecture Principles
|
|
253
|
+
|
|
254
|
+
The codebase follows clean architecture principles for maintainability and extensibility:
|
|
255
|
+
|
|
256
|
+
#### Eliminated Code Duplication
|
|
257
|
+
- **Unified Validation Logic**: Consolidated validation functions eliminate redundancy
|
|
258
|
+
- **Shared Constants**: Centralized configuration reduces maintenance overhead
|
|
259
|
+
- **Streamlined Error Handling**: Consistent error reporting across all validation types
|
|
260
|
+
|
|
261
|
+
#### Improved Developer Experience
|
|
262
|
+
- **Clear Separation of Concerns**: Validation, file management, and error reporting are properly isolated
|
|
263
|
+
- **Maintainable Code Structure**: Reduced complexity makes the codebase easier to understand and modify
|
|
264
|
+
- **Performance Benefits**: Optimized code paths improve installation speed and reliability
|
|
265
|
+
|
|
181
266
|
## 📚 Documentation
|
|
182
267
|
|
|
183
268
|
### Core Documentation
|
|
@@ -199,6 +284,8 @@ Based on your language selection, you'll get:
|
|
|
199
284
|
- [AI Workflow](docs/AI-WORKFLOW.md) - AI integration patterns
|
|
200
285
|
- [API Reference](docs/API_REFERENCE.md) - Programmatic usage
|
|
201
286
|
- [Complete API Reference](docs/API_REFERENCE_FULL.md) - Comprehensive API documentation
|
|
287
|
+
- [Validator API Reference](docs/VALIDATOR_API.md) - Validation system API documentation
|
|
288
|
+
- [Code Cleanup Guide](docs/CODE_CLEANUP_GUIDE.md) - Code cleanup principles and patterns
|
|
202
289
|
- [Troubleshooting](docs/TROUBLESHOOTING.md) - Common issues and solutions
|
|
203
290
|
|
|
204
291
|
## 📖 Source
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# AIWF AI Tool Integration Templates
|
|
2
|
+
|
|
3
|
+
This directory contains integration templates for various AI development tools to work seamlessly with the AI Workflow Framework (AIWF).
|
|
4
|
+
|
|
5
|
+
## Available Tools
|
|
6
|
+
|
|
7
|
+
### 1. Claude Code (`claude-code`)
|
|
8
|
+
- **Description**: Official Anthropic Claude Code integration
|
|
9
|
+
- **Features**: Deep AIWF integration, feature ledger sync, AI personas
|
|
10
|
+
- **Installation**: `aiwf ai-tool install claude-code`
|
|
11
|
+
|
|
12
|
+
### 2. GitHub Copilot (`github-copilot`)
|
|
13
|
+
- **Description**: GitHub Copilot configuration for AIWF projects
|
|
14
|
+
- **Features**: Feature-aware suggestions, sprint task integration
|
|
15
|
+
- **Installation**: `aiwf ai-tool install github-copilot`
|
|
16
|
+
|
|
17
|
+
### 3. Cursor (`cursor`)
|
|
18
|
+
- **Description**: Cursor IDE integration with AIWF
|
|
19
|
+
- **Features**: Multi-file context, composer enhancement, task tracking
|
|
20
|
+
- **Installation**: `aiwf ai-tool install cursor`
|
|
21
|
+
|
|
22
|
+
### 4. Windsurf (`windsurf`)
|
|
23
|
+
- **Description**: Windsurf IDE with Cascade AI integration
|
|
24
|
+
- **Features**: Flow-based development, multi-agent support, visual progress
|
|
25
|
+
- **Installation**: `aiwf ai-tool install windsurf`
|
|
26
|
+
|
|
27
|
+
### 5. Augment (`augment`)
|
|
28
|
+
- **Description**: Augment Code with deep codebase understanding
|
|
29
|
+
- **Features**: Team collaboration, knowledge queries, smart refactoring
|
|
30
|
+
- **Installation**: `aiwf ai-tool install augment`
|
|
31
|
+
|
|
32
|
+
## Quick Start
|
|
33
|
+
|
|
34
|
+
1. **List available tools**:
|
|
35
|
+
```bash
|
|
36
|
+
aiwf ai-tool list
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
2. **Install a tool**:
|
|
40
|
+
```bash
|
|
41
|
+
aiwf ai-tool install <tool-name>
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
3. **Update installed tools**:
|
|
45
|
+
```bash
|
|
46
|
+
aiwf ai-tool update <tool-name>
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
4. **Verify installation**:
|
|
50
|
+
```bash
|
|
51
|
+
aiwf ai-tool verify <tool-name>
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Integration Features
|
|
55
|
+
|
|
56
|
+
All templates provide:
|
|
57
|
+
- ✅ Feature Ledger integration
|
|
58
|
+
- ✅ AI Persona support
|
|
59
|
+
- ✅ Sprint task management
|
|
60
|
+
- ✅ Context optimization
|
|
61
|
+
- ✅ Offline cache support
|
|
62
|
+
|
|
63
|
+
## Directory Structure
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
ai-tools/
|
|
67
|
+
├── claude-code/
|
|
68
|
+
│ ├── template/
|
|
69
|
+
│ ├── config.json
|
|
70
|
+
│ └── README.md
|
|
71
|
+
├── github-copilot/
|
|
72
|
+
│ ├── template/
|
|
73
|
+
│ ├── config.json
|
|
74
|
+
│ └── README.md
|
|
75
|
+
├── cursor/
|
|
76
|
+
│ ├── template/
|
|
77
|
+
│ ├── config.json
|
|
78
|
+
│ └── README.md
|
|
79
|
+
├── windsurf/
|
|
80
|
+
│ ├── template/
|
|
81
|
+
│ ├── config.json
|
|
82
|
+
│ └── README.md
|
|
83
|
+
└── augment/
|
|
84
|
+
├── template/
|
|
85
|
+
├── config.json
|
|
86
|
+
└── README.md
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Customization
|
|
90
|
+
|
|
91
|
+
Each tool template can be customized:
|
|
92
|
+
1. Edit the template files in the tool directory
|
|
93
|
+
2. Modify config.json for tool-specific settings
|
|
94
|
+
3. Add project-specific rules to the template files
|
|
95
|
+
|
|
96
|
+
## Support
|
|
97
|
+
|
|
98
|
+
For issues or questions:
|
|
99
|
+
- Check individual tool README files
|
|
100
|
+
- Visit [AIWF Documentation](https://aiwf.dev)
|
|
101
|
+
- Submit issues on GitHub
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
*AIWF AI Tool Integration System v1.0.0*
|
|
@@ -0,0 +1,371 @@
|
|
|
1
|
+
# Augment AIWF Integration Template
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
This template integrates Augment Code's deep codebase understanding and team collaboration features with AIWF's structured development framework. It creates a powerful combination for AI-assisted team development.
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
- **Deep Codebase Understanding**: Augment comprehends your entire AIWF structure
|
|
10
|
+
- **Team Collaboration**: Shared feature knowledge and task coordination
|
|
11
|
+
- **Intelligent Code Completion**: Context-aware suggestions based on features
|
|
12
|
+
- **Automated Documentation**: Generate docs aligned with AIWF standards
|
|
13
|
+
- **Smart Refactoring**: Feature-aware code improvements
|
|
14
|
+
- **Knowledge Queries**: Ask questions about your AIWF project
|
|
15
|
+
|
|
16
|
+
## Installation
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# Install Augment template
|
|
20
|
+
aiwf ai-tool install augment
|
|
21
|
+
|
|
22
|
+
# Or manually copy template files
|
|
23
|
+
cp -r .aiwf/ai-tools/augment/template/* .
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Configuration
|
|
27
|
+
|
|
28
|
+
The template includes:
|
|
29
|
+
|
|
30
|
+
1. **augment.config.json**: Main configuration
|
|
31
|
+
- AIWF integration settings
|
|
32
|
+
- Team collaboration options
|
|
33
|
+
- AI model preferences
|
|
34
|
+
- Automation rules
|
|
35
|
+
|
|
36
|
+
2. **.augment/aiwf-integration.md**: Integration guide
|
|
37
|
+
- Usage patterns
|
|
38
|
+
- Team features
|
|
39
|
+
- Best practices
|
|
40
|
+
- Command reference
|
|
41
|
+
|
|
42
|
+
## Core Capabilities
|
|
43
|
+
|
|
44
|
+
### 1. Feature-Aware Development
|
|
45
|
+
|
|
46
|
+
Augment understands your Feature Ledger:
|
|
47
|
+
|
|
48
|
+
```javascript
|
|
49
|
+
// Start typing code
|
|
50
|
+
function createUser() {
|
|
51
|
+
// Augment suggests:
|
|
52
|
+
// This relates to Feature FL-002 - User Management
|
|
53
|
+
// Dependencies: FL-001 (Authentication)
|
|
54
|
+
// Current status: in_progress
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### 2. Team Knowledge Sharing
|
|
59
|
+
|
|
60
|
+
Share understanding across your team:
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
@augment who implemented authentication?
|
|
64
|
+
// Alice implemented FL-001 last week
|
|
65
|
+
|
|
66
|
+
@augment show alice's patterns for error handling
|
|
67
|
+
// Shows consistent patterns from Alice's code
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### 3. Sprint Task Management
|
|
71
|
+
|
|
72
|
+
Stay aligned with sprints:
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
@augment my current tasks
|
|
76
|
+
// T13_S03 - AI Tool Integration (in_progress)
|
|
77
|
+
// T14_S03 - Performance Optimization (pending)
|
|
78
|
+
|
|
79
|
+
@augment suggest next task
|
|
80
|
+
// Based on your expertise and dependencies
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### 4. Intelligent Documentation
|
|
84
|
+
|
|
85
|
+
Auto-generate AIWF-compliant docs:
|
|
86
|
+
|
|
87
|
+
```javascript
|
|
88
|
+
// @augment document this class
|
|
89
|
+
/**
|
|
90
|
+
* UserService handles user management operations
|
|
91
|
+
*
|
|
92
|
+
* @feature FL-002 - User Management
|
|
93
|
+
* @sprint S03
|
|
94
|
+
* @implements Requirements from FL-002 specification
|
|
95
|
+
* @dependencies FL-001 (Authentication)
|
|
96
|
+
*
|
|
97
|
+
* @example
|
|
98
|
+
* const userService = new UserService();
|
|
99
|
+
* const user = await userService.createUser(data);
|
|
100
|
+
*/
|
|
101
|
+
class UserService {
|
|
102
|
+
// Implementation
|
|
103
|
+
}
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## Usage Examples
|
|
107
|
+
|
|
108
|
+
### 1. Feature Development
|
|
109
|
+
|
|
110
|
+
```javascript
|
|
111
|
+
// @augment implement FL-003 payment processing
|
|
112
|
+
|
|
113
|
+
// Augment provides:
|
|
114
|
+
// - Feature specification summary
|
|
115
|
+
// - Required methods from spec
|
|
116
|
+
// - Integration points with other features
|
|
117
|
+
// - Test requirements
|
|
118
|
+
// - Documentation template
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### 2. Code Review
|
|
122
|
+
|
|
123
|
+
```javascript
|
|
124
|
+
// @augment review this PR for FL-001 compliance
|
|
125
|
+
|
|
126
|
+
// Augment checks:
|
|
127
|
+
// ✓ Implements all required features
|
|
128
|
+
// ✓ Follows team patterns
|
|
129
|
+
// ✓ Has appropriate tests
|
|
130
|
+
// ⚠ Missing error handling for edge case X
|
|
131
|
+
// ⚠ Consider using established pattern from auth.js
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### 3. Refactoring
|
|
135
|
+
|
|
136
|
+
```javascript
|
|
137
|
+
// @augment refactor payment module for better feature separation
|
|
138
|
+
|
|
139
|
+
// Augment suggests:
|
|
140
|
+
// 1. Extract FL-003 logic to PaymentService
|
|
141
|
+
// 2. Move FL-001 auth checks to middleware
|
|
142
|
+
// 3. Create feature flags for gradual rollout
|
|
143
|
+
// 4. Add monitoring for new architecture
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### 4. Knowledge Queries
|
|
147
|
+
|
|
148
|
+
```
|
|
149
|
+
@augment how does our authentication flow work?
|
|
150
|
+
// Augment explains FL-001 implementation with code examples
|
|
151
|
+
|
|
152
|
+
@augment what depends on the user service?
|
|
153
|
+
// Features: FL-003 (payments), FL-004 (notifications)
|
|
154
|
+
// Files: 15 controllers, 8 services, 23 tests
|
|
155
|
+
|
|
156
|
+
@augment show architecture diagram
|
|
157
|
+
// Generates visual representation of feature dependencies
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
## Team Collaboration Features
|
|
161
|
+
|
|
162
|
+
### 1. Expertise Mapping
|
|
163
|
+
|
|
164
|
+
```
|
|
165
|
+
@augment team expertise
|
|
166
|
+
// Alice: FL-001 (auth), FL-002 (users) - Senior
|
|
167
|
+
// Bob: FL-003 (payments), FL-005 (analytics) - Expert
|
|
168
|
+
// Carol: FL-004 (notifications) - Intermediate
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### 2. Task Assignment
|
|
172
|
+
|
|
173
|
+
```
|
|
174
|
+
@augment assign T14_S03
|
|
175
|
+
// Recommends: Bob (payment expertise, available capacity)
|
|
176
|
+
// Alternative: Alice (general expertise, higher load)
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
### 3. Code Patterns
|
|
180
|
+
|
|
181
|
+
```
|
|
182
|
+
@augment show team patterns for error handling
|
|
183
|
+
// Consistent patterns across team:
|
|
184
|
+
// - Custom error classes per feature
|
|
185
|
+
// - Centralized error logging
|
|
186
|
+
// - User-friendly error messages
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### 4. Onboarding
|
|
190
|
+
|
|
191
|
+
```
|
|
192
|
+
@augment create onboarding guide for new developer
|
|
193
|
+
// Generates comprehensive guide:
|
|
194
|
+
// - Project structure
|
|
195
|
+
// - Feature overview
|
|
196
|
+
// - Team patterns
|
|
197
|
+
// - Development workflow
|
|
198
|
+
// - Key architecture decisions
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
## Advanced Features
|
|
202
|
+
|
|
203
|
+
### 1. Codebase Analysis
|
|
204
|
+
|
|
205
|
+
```
|
|
206
|
+
@augment analyze feature coverage
|
|
207
|
+
// FL-001: 95% implemented, 90% tested
|
|
208
|
+
// FL-002: 80% implemented, 85% tested
|
|
209
|
+
// FL-003: 60% implemented, 70% tested
|
|
210
|
+
|
|
211
|
+
@augment find technical debt
|
|
212
|
+
// - Duplicated auth logic in 3 files
|
|
213
|
+
// - Missing tests for edge cases in FL-002
|
|
214
|
+
// - Outdated dependencies in payment module
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
### 2. Architecture Insights
|
|
218
|
+
|
|
219
|
+
```
|
|
220
|
+
@augment analyze architecture
|
|
221
|
+
// - Clean separation between features
|
|
222
|
+
// - Some circular dependencies detected
|
|
223
|
+
// - Opportunity to extract shared utilities
|
|
224
|
+
// - Consider implementing event system
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### 3. Performance Analysis
|
|
228
|
+
|
|
229
|
+
```
|
|
230
|
+
@augment analyze performance bottlenecks
|
|
231
|
+
// - Database queries in user service (N+1)
|
|
232
|
+
// - Synchronous payment processing
|
|
233
|
+
// - Large bundle size from unused imports
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
### 4. Test Generation
|
|
237
|
+
|
|
238
|
+
```javascript
|
|
239
|
+
// @augment generate tests for UserService
|
|
240
|
+
|
|
241
|
+
describe('UserService (FL-002)', () => {
|
|
242
|
+
// Generates comprehensive test suite
|
|
243
|
+
// based on feature specifications
|
|
244
|
+
});
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
## Best Practices
|
|
248
|
+
|
|
249
|
+
### 1. Feature-First Approach
|
|
250
|
+
|
|
251
|
+
Always start with feature context:
|
|
252
|
+
- Check Feature Ledger before coding
|
|
253
|
+
- Reference features in all code
|
|
254
|
+
- Update feature status regularly
|
|
255
|
+
|
|
256
|
+
### 2. Team Alignment
|
|
257
|
+
|
|
258
|
+
Leverage team features:
|
|
259
|
+
- Share knowledge through Augment
|
|
260
|
+
- Follow team patterns
|
|
261
|
+
- Document decisions
|
|
262
|
+
|
|
263
|
+
### 3. Sprint Discipline
|
|
264
|
+
|
|
265
|
+
Stay focused on current work:
|
|
266
|
+
- Check sprint tasks daily
|
|
267
|
+
- Update progress regularly
|
|
268
|
+
- Complete tasks fully
|
|
269
|
+
|
|
270
|
+
### 4. Continuous Learning
|
|
271
|
+
|
|
272
|
+
Let Augment teach:
|
|
273
|
+
- Ask about unfamiliar code
|
|
274
|
+
- Learn team patterns
|
|
275
|
+
- Understand architecture
|
|
276
|
+
|
|
277
|
+
## Configuration Options
|
|
278
|
+
|
|
279
|
+
### 1. Model Selection
|
|
280
|
+
|
|
281
|
+
```json
|
|
282
|
+
{
|
|
283
|
+
"models": {
|
|
284
|
+
"completion": "augment-fast", // Quick suggestions
|
|
285
|
+
"understanding": "augment-deep", // Complex analysis
|
|
286
|
+
"documentation": "augment-doc", // Doc generation
|
|
287
|
+
"review": "augment-review" // Code review
|
|
288
|
+
}
|
|
289
|
+
}
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
### 2. Team Settings
|
|
293
|
+
|
|
294
|
+
```json
|
|
295
|
+
{
|
|
296
|
+
"team": {
|
|
297
|
+
"sync_interval": "5m",
|
|
298
|
+
"share_patterns": true,
|
|
299
|
+
"expertise_tracking": true,
|
|
300
|
+
"automated_assignment": false
|
|
301
|
+
}
|
|
302
|
+
}
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
### 3. Automation
|
|
306
|
+
|
|
307
|
+
```json
|
|
308
|
+
{
|
|
309
|
+
"automation": {
|
|
310
|
+
"auto_document": true,
|
|
311
|
+
"suggest_refactoring": true,
|
|
312
|
+
"update_feature_status": true,
|
|
313
|
+
"generate_tests": false
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
## Troubleshooting
|
|
319
|
+
|
|
320
|
+
### Common Issues
|
|
321
|
+
|
|
322
|
+
1. **Slow indexing**
|
|
323
|
+
```
|
|
324
|
+
@augment config set indexing.incremental true
|
|
325
|
+
@augment reindex --fast
|
|
326
|
+
```
|
|
327
|
+
|
|
328
|
+
2. **Team sync problems**
|
|
329
|
+
```
|
|
330
|
+
@augment team sync --reset
|
|
331
|
+
@augment team verify
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
3. **Feature recognition**
|
|
335
|
+
```
|
|
336
|
+
@augment feature reindex
|
|
337
|
+
@augment feature validate
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
### Performance Tips
|
|
341
|
+
|
|
342
|
+
1. Enable caching for faster responses
|
|
343
|
+
2. Use incremental indexing
|
|
344
|
+
3. Compress large contexts
|
|
345
|
+
4. Limit analysis scope when needed
|
|
346
|
+
|
|
347
|
+
## Updates
|
|
348
|
+
|
|
349
|
+
Keep Augment template current:
|
|
350
|
+
|
|
351
|
+
```bash
|
|
352
|
+
# Check version
|
|
353
|
+
aiwf ai-tool version augment
|
|
354
|
+
|
|
355
|
+
# Update template
|
|
356
|
+
aiwf ai-tool update augment
|
|
357
|
+
|
|
358
|
+
# Verify installation
|
|
359
|
+
aiwf ai-tool verify augment
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
## Resources
|
|
363
|
+
|
|
364
|
+
- [Augment Documentation](https://augmentcode.com/docs)
|
|
365
|
+
- [AIWF Documentation](https://aiwf.dev/docs)
|
|
366
|
+
- [Integration Examples](https://github.com/aiwf/augment-examples)
|
|
367
|
+
- [Team Playbook](https://aiwf.dev/guides/team-collaboration)
|
|
368
|
+
|
|
369
|
+
---
|
|
370
|
+
|
|
371
|
+
*Augment Integration Template v1.0.0*
|