npm - aiwf - Versions diffs - 0.3.23 → 0.4.0 - Mend

aiwf 0.3.23 → 0.4.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.

Files changed (321) hide show

package/docs/GETTING_STARTED.ko.md DELETED Viewed

@@ -1,219 +0,0 @@
-# AIWF 시작하기
-[한국어](GETTING_STARTED.ko.md) | [English](GETTING_STARTED.md)
-> AIWF를 사용하여 AI 지원 개발을 시작하는 빠른 가이드
-## 📋 목차
-1. [설치](#설치)
-2. [첫 프로젝트 설정](#첫-프로젝트-설정)
-3. [기본 워크플로우](#기본-워크플로우)
-4. [핵심 개념](#핵심-개념)
-5. [다음 단계](#다음-단계)
-## 설치
-### 전역 설치 (권장)
-```bash
-npm install -g aiwf
-```
-### 프로젝트에 AIWF 설치
-프로젝트 디렉토리로 이동한 후:
-```bash
-aiwf install
-```
-설치 프로그램이 다음을 안내합니다:
-1. **언어 선택**: 한국어 또는 영어 선택
-2. **프로젝트 설정**: 현재 디렉토리에 AIWF 초기화
-3. **Claude 명령어**: 언어별 명령어 설치
-4. **문서**: 가이드 및 템플릿 다운로드
-## 첫 프로젝트 설정
-### 1. 새 프로젝트 생성
-```bash
-# 대화형 프로젝트 생성
-aiwf create-project
-# 템플릿 사용
-aiwf create-project my-api --template api-server
-aiwf create-project my-lib --template npm-library
-aiwf create-project my-app --template web-app
-```
-### 2. 기존 프로젝트에 AIWF 추가
-```bash
-cd my-existing-project
-aiwf install
-```
-### 3. 프로젝트 상태 초기화
-```bash
-aiwf state init
-```
-## 기본 워크플로우
-### 1. 마일스톤 계획
-```bash
-# PRD로부터 마일스톤 생성
-aiwf create-milestone-plan
-# 마일스톤으로부터 스프린트 생성
-aiwf create-sprints-from-milestone
-```
-### 2. 태스크 관리
-```bash
-# 일반 태스크 생성
-aiwf create-general-task "기능 구현" --description "사용자 인증 추가"
-# 스프린트에 태스크 추가
-aiwf add-sprint-task S01 "API 엔드포인트 구현"
-# 스마트 태스크 시작
-aiwf smart-start
-# 태스크 완료
-aiwf smart-complete
-```
-### 3. 상태 추적
-```bash
-# 상태 업데이트
-aiwf state update
-# 현재 상태 확인
-aiwf state show
-# 다음 추천 작업
-aiwf state next
-```
-### 4. YOLO 모드 (자율 실행)
-```bash
-# 전체 스프린트 자동 실행
-aiwf yolo
-# 안전 모드로 실행
-aiwf yolo --safe
-# 드라이런 (시뮬레이션)
-aiwf yolo --dry-run
-```
-## 핵심 개념
-### 📂 프로젝트 구조
-```
-my-project/
-├── .aiwf/                    # AIWF 구성 및 상태
-│   ├── config.json          # 프로젝트 설정
-│   ├── state/               # 상태 파일
-│   └── checkpoints/         # YOLO 체크포인트
-├── milestones/              # 마일스톤 정의
-├── sprints/                 # 스프린트 정의
-└── tasks/                   # 태스크 파일
-```
-### 🎯 워크플로우 단계
-1. **계획 (Planning)**
-   - PRD 작성
-   - 마일스톤 정의
-   - 스프린트 분할
-2. **개발 (Development)**
-   - 태스크 생성 및 할당
-   - 코드 구현
-   - 테스트 작성
-3. **리뷰 (Review)**
-   - 코드 리뷰
-   - 테스트 실행
-   - 품질 평가
-4. **배포 (Deployment)**
-   - 최종 검증
-   - 릴리스 준비
-   - 문서 업데이트
-### 🤖 AI 페르소나
-AIWF는 전문 AI 페르소나를 제공합니다:
-- **Architect**: 시스템 설계 및 아키텍처
-- **Backend**: 백엔드 개발 및 API
-- **Frontend**: UI/UX 및 프론트엔드
-- **Security**: 보안 검토 및 개선
-- **Data Analyst**: 데이터 분석 및 최적화
-페르소나 사용 예:
-```bash
-# 아키텍처 리뷰
-aiwf persona apply architect
-# 보안 검토
-aiwf persona apply security
-```
-### 💾 체크포인트 시스템
-YOLO 모드 실행 중 진행 상황 자동 저장:
-```bash
-# 체크포인트 목록
-aiwf checkpoint list
-# 특정 체크포인트에서 재개
-aiwf yolo --resume checkpoint-id
-```
-## 다음 단계
-### 📚 추천 문서
-1. **[명령어 가이드](COMMANDS_GUIDE.ko.md)** - 모든 AIWF 명령어 상세 설명
-2. **[상태 관리 가이드](STATE_MANAGEMENT_GUIDE.ko.md)** - 고급 상태 관리 기법
-3. **[AI 페르소나 가이드](guides/ai-personas-guide-ko.md)** - 페르소나 활용법
-4. **[독립 스프린트 가이드](guides/independent-sprint-guide-ko.md)** - YOLO 최적화 스프린트
-### 🎓 학습 경로
-1. **초급**: 기본 명령어와 워크플로우 익히기
-2. **중급**: 상태 관리와 AI 페르소나 활용
-3. **고급**: YOLO 모드와 커스터마이징
-### 💡 팁
-- 항상 `aiwf state update`로 상태 동기화
-- 큰 작업은 작은 태스크로 분할
-- YOLO 모드는 충분한 컨텍스트와 함께 사용
-- 정기적으로 체크포인트 확인
-## 🆘 도움말
-문제가 발생하면:
-1. `aiwf --help` 명령어 도움말 확인
-2. [문제 해결 가이드](TROUBLESHOOTING.ko.md) 참조
-3. [GitHub 이슈](https://github.com/moonklabs/aiwf/issues) 제출
----
-🎉 이제 AIWF로 AI 지원 개발을 시작할 준비가 되었습니다!

package/docs/GETTING_STARTED.md DELETED Viewed

@@ -1,476 +0,0 @@
-# Getting Started with AIWF
-Welcome to AIWF (AI Workflow Framework)! This guide will help you get up and running quickly with AIWF and Claude Code.
-## Table of Contents
-1. [Prerequisites](#prerequisites)
-2. [Quick Start](#quick-start)
-3. [Your First Project](#your-first-project)
-4. [Understanding the Structure](#understanding-the-structure)
-5. [Essential Commands](#essential-commands)
-6. [Working with Claude Code](#working-with-claude-code)
-7. [Best Practices](#best-practices)
-8. [Next Steps](#next-steps)
----
-## Prerequisites
-Before you begin, ensure you have:
-- **Node.js** version 14.0.0 or higher
-  ```bash
-  node --version  # Should output v14.0.0 or higher
-  ```
-- **npm** (comes with Node.js)
-  ```bash
-  npm --version
-  ```
-- **Git** for version control
-  ```bash
-  git --version
-  ```
-- **Claude Code** access ([claude.ai/code](https://claude.ai/code))
-## Quick Start
-### 1. Install AIWF
-```bash
-# Install globally (if not already installed)
-npm install -g aiwf
-# Navigate to your project directory
-cd my-project
-# Initialize AIWF in your project
-aiwf install
-```
-### 2. Choose Your Language
-During installation, you'll be prompted to select a language:
-```
-? Select your preferred language:
-❯ English
-  한국어 (Korean)
-```
-### 3. Verify Installation
-```bash
-# Check that AIWF directories were created
-ls -la .aiwf/
-ls -la .claude/commands/aiwf/
-```
-You should see:
-- `.aiwf/` - Project management directory
-- `.claude/commands/aiwf/` - Claude Code commands
-- `.cursor/rules/` - Cursor IDE rules (if using Cursor)
-- `.windsurf/rules/` - Windsurf IDE rules (if using Windsurf)
-## Your First Project
-Let's create a simple task management application to demonstrate AIWF workflow.
-### Step 1: Initialize the Project
-Open your project in Claude Code and run:
-```bash
-/project:aiwf:initialize
-```
-Claude will help you set up the project structure and create initial documentation.
-### Step 2: Define Your Project Vision
-```bash
-/project:aiwf:aiwf_create_prd "Task Manager" "A simple task management app with CRUD operations"
-```
-This creates:
-- Project manifest in `.aiwf/00_PROJECT_MANIFEST.md`
-- Project documentation in `.aiwf/01_PROJECT_DOCS/`
-### Step 3: Plan Your First Milestone
-```bash
-/project:aiwf:aiwf_create_milestone_plan "Basic Task Management"
-```
-Claude will guide you through:
-1. Defining milestone objectives
-2. Breaking down into features
-3. Setting acceptance criteria
-4. Estimating timeline
-Example milestone structure:
-```markdown
-## M01: Basic Task Management
-### Objectives
-- Create, read, update, delete tasks
-- Mark tasks as complete
-- Filter tasks by status
-- Basic UI for task management
-### Timeline: 2 weeks
-```
-### Step 4: Generate Sprints
-```bash
-/project:aiwf:create_sprints_from_milestone M01
-```
-This automatically creates sprint directories:
-- `S01_M01_backend_setup/` - API and database setup
-- `S02_M01_frontend_development/` - UI implementation
-- `S03_M01_integration_testing/` - Testing and polish
-### Step 5: Start Your First Task
-```bash
-# List tasks in current sprint
-/project:aiwf:list_tasks S01
-# Start a specific task
-/project:aiwf:do_task T01_S01
-```
-Claude will:
-1. Load task requirements
-2. Suggest implementation approach
-3. Help you write code
-4. Track progress
-## Understanding the Structure
-### Directory Layout
-```
-my-project/
-├── .aiwf/                          # AIWF project management
-│   ├── 00_PROJECT_MANIFEST.md      # Central tracking document
-│   ├── 01_PROJECT_DOCS/            # Project documentation
-│   │   └── OVERVIEW.md
-│   ├── 02_REQUIREMENTS/            # Milestone definitions
-│   │   └── M01_Basic_Task_Management/
-│   ├── 03_SPRINTS/                 # Sprint execution
-│   │   ├── S01_M01_backend_setup/
-│   │   ├── S02_M01_frontend_development/
-│   │   └── S03_M01_integration_testing/
-│   ├── 04_GENERAL_TASKS/           # Non-sprint tasks
-│   ├── 05_ARCHITECTURAL_DECISIONS/  # ADRs
-│   └── 99_TEMPLATES/               # Reusable templates
-├── .claude/commands/aiwf/          # Claude commands
-├── src/                            # Your source code
-└── package.json                    # Node.js project file
-```
-### File Naming Conventions
-- **Milestones**: `M01_`, `M02_`, etc.
-- **Sprints**: `S01_M01_`, `S02_M01_`, etc.
-- **Tasks**: `T01_S01_`, `T02_S01_`, etc.
-- **Features**: `FL001`, `FL002`, etc.
-- **Completed items**: Prefix with `X` (e.g., `XT01_S01_`)
-## Essential Commands
-### Project Management
-| Command | Description |
-|---------|-------------|
-| `/project:aiwf:initialize` | Initialize AIWF in your project |
-| `/project:aiwf:status` | View project status |
-| `/project:aiwf:review` | Comprehensive project review |
-### Milestone & Sprint Management
-| Command | Description |
-|---------|-------------|
-| `/project:aiwf:aiwf_create_milestone_plan` | Create a new milestone |
-| `/project:aiwf:create_sprints_from_milestone` | Generate sprints |
-| `/project:aiwf:sprint_status` | Check sprint progress |
-### Task Management
-| Command | Description |
-|---------|-------------|
-| `/project:aiwf:create_task` | Create a new task |
-| `/project:aiwf:do_task` | Work on a specific task |
-| `/project:aiwf:list_tasks` | List tasks in sprint |
-| `/project:aiwf:complete_task` | Mark task as done |
-### GitHub Integration
-| Command | Description |
-|---------|-------------|
-| `/project:aiwf:aiwf_issue_create` | Create GitHub issue |
-| `/project:aiwf:aiwf_pr_create` | Create pull request |
-### AI Personas
-AIWF includes an AI Persona system that optimizes Claude Code's behavior for different development tasks:
-| Command | Description |
-|---------|-------------|
-| `/project:aiwf:aiwf_persona_architect` | System design and architecture |
-| `/project:aiwf:aiwf_persona_security` | Security-focused development |
-| `/project:aiwf:aiwf_persona_frontend` | Frontend development |
-| `/project:aiwf:aiwf_persona_backend` | Backend development |
-| `/project:aiwf:aiwf_persona_data_analyst` | Data analysis and insights |
-#### Core Workflow Commands
-| Command | Description |
-|---------|-------------|
-| `/project:aiwf:aiwf_yolo` | Autonomous task execution |
-| `/project:aiwf:aiwf_code_review` | Automated code review |
-| `/project:aiwf:aiwf_test` | Run project tests |
-| `/project:aiwf:aiwf_validate_state` | Validate workflow state |
-See the [AI Personas Guide](guides/ai-personas-guide.md) for detailed information.
-### Context Management
-| Command | Description |
-|---------|-------------|
-| `/project:aiwf:compress_context:aggressive` | Maximum compression |
-| `/project:aiwf:compress_context:balanced` | Balanced compression |
-| `/project:aiwf:compress_context:conservative` | Minimal compression |
-## Working with Claude Code
-### 1. Effective Communication
-**Be Specific:**
-```bash
-# Good
-/project:aiwf:do_task T01_S01
-"Implement the POST /api/tasks endpoint with validation"
-# Less effective
-"Make the API"
-```
-### 2. Use Personas Appropriately
-AIWF's AI Persona system helps Claude Code focus on specific aspects of development:
-```bash
-# For design decisions
-/project:aiwf:ai_persona:architect
-"Design the database schema for tasks"
-# For bug fixing
-/project:aiwf:ai_persona:debugger
-"Fix the issue where completed tasks still appear as active"
-# For documentation
-/project:aiwf:ai_persona:documenter
-"Create API documentation for the task endpoints"
-# For performance optimization
-/project:aiwf:ai_persona:optimizer
-"Optimize the task query performance"
-# For code review
-/project:aiwf:ai_persona:reviewer
-"Review the authentication module for security issues"
-```
-**Auto-Detection Feature:**
-```bash
-# Enable automatic persona switching
-/project:aiwf:ai_persona:auto on
-# Claude will automatically switch personas based on your task
-"Debug the login error"  # → Automatically switches to debugger persona
-```
-**Check Persona Performance:**
-```bash
-# View current session metrics
-/project:aiwf:ai_persona:status
-# Generate performance report
-/project:aiwf:ai_persona:report
-# Check specific persona statistics
-/project:aiwf:ai_persona:stats debugger
-```
-### 3. Manage Context Efficiently
-For large codebases:
-```bash
-# Start with overview
-/project:aiwf:compress_context:aggressive
-"Show me the overall project structure"
-# Then focus on specifics
-/project:aiwf:compress_context:balanced
-"Now let's work on the user authentication module"
-```
-### 4. Track Progress
-```bash
-# Regular status checks
-/project:aiwf:status
-# Detailed sprint review
-/project:aiwf:sprint_status S01
-# Feature progress
-/project:aiwf:feature_status FL001
-```
-## Best Practices
-### 1. Commit Conventions
-Always reference features in commits:
-```bash
-git commit -m "feat(FL001): add task creation endpoint"
-git commit -m "fix(FL001): validate task title length"
-git commit -m "docs(FL001): update API documentation"
-```
-### 2. Task Breakdown
-Keep tasks small and focused:
-- ✅ "Implement GET /api/tasks endpoint"
-- ✅ "Add pagination to task list"
-- ❌ "Build entire API" (too large)
-### 3. Regular Reviews
-```bash
-# Daily
-/project:aiwf:sprint_status
-# Weekly
-/project:aiwf:review
-# Per milestone
-/project:aiwf:milestone_review M01
-```
-### 4. Documentation
-Document as you go:
-```bash
-# After implementing a feature
-/project:aiwf:ai_persona:documenter
-"Document the task API endpoints we just created"
-# Update architecture decisions
-/project:aiwf:create_adr "Use PostgreSQL for task storage"
-```
-## Next Steps
-### 1. Explore Advanced Features
-**Feature-Git Integration:**
-```bash
-# Link commits to features automatically
-/project:aiwf:install_git_hooks
-```
-**Performance Monitoring:**
-```javascript
-// Use built-in performance tools
-import { PerformanceBenchmark } from '@aiwf/performance';
-```
-**Team Collaboration:**
-```bash
-# Generate team reports
-/project:aiwf:team_status_report
-# Create shared documentation
-/project:aiwf:export_project_docs
-```
-### 2. Learn More
-- Read the [Commands Guide](COMMANDS_GUIDE.md) for all available commands
-- Check out [Examples](EXAMPLES.md) for real-world scenarios
-- Review [API Reference](API_REFERENCE.md) for programmatic usage
-- See [Troubleshooting](TROUBLESHOOTING.md) if you encounter issues
-### 3. Join the Community
-- **GitHub**: [github.com/moonklabs/aiwf](https://github.com/moonklabs/aiwf)
-- **Discord**: [discord.gg/aiwf](https://discord.gg/aiwf)
-- **Discussions**: Share your experiences and learn from others
-### 4. Customize for Your Workflow
-Create custom templates:
-```bash
-# Add your own templates
-cp my-template.md .aiwf/99_TEMPLATES/
-# Customize personas
-echo "Custom rules" > .aiwf/personas/custom.json
-```
-## Quick Reference Card
-```bash
-# Start new task
-/project:aiwf:aiwf_create_general_task "Feature Name"  # → T001
-git checkout -b feature/T001-feature-name
-# Work on tasks
-/project:aiwf:list_tasks S01
-/project:aiwf:do_task T01_S01
-# Switch personas
-/project:aiwf:ai_persona:architect    # Design
-/project:aiwf:ai_persona:developer     # Code
-/project:aiwf:ai_persona:debugger      # Debug
-/project:aiwf:ai_persona:reviewer      # Review
-/project:aiwf:ai_persona:documenter    # Document
-/project:aiwf:ai_persona:optimizer     # Optimize
-# Persona management
-/project:aiwf:ai_persona:auto on      # Enable auto-detection
-/project:aiwf:ai_persona:status        # Check current persona
-/project:aiwf:ai_persona:report        # Performance report
-# Manage context
-/project:aiwf:compress_context:aggressive    # Overview
-/project:aiwf:compress_context:balanced      # Normal work
-/project:aiwf:compress_context:conservative  # Detailed work
-# Track progress
-/project:aiwf:status                   # Overall
-/project:aiwf:sprint_status S01        # Sprint
-/project:aiwf:feature_status FL001     # Feature
-```
----
-## Congratulations! 🎉
-You now have the foundation to effectively use AIWF with Claude Code. Remember:
-1. **Start small** - Begin with simple tasks and gradually take on more complex features
-2. **Use the right tools** - Leverage personas and compression modes appropriately
-3. **Stay organized** - Follow the naming conventions and project structure
-4. **Collaborate** - Share your learnings with the community
-Happy coding with AIWF! 🚀