aiwf 0.1.0 → 0.3.0

package/CHANGELOG.md

@@ -1 +1,45 @@
 # Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- 🌍 **Multi-language Support**
+  - Interactive language selection during installation (English/Korean)
+  - Language-specific command and documentation installation
+  - Localized content for both Korean and English users
+  
+- 📝 **Changelog Command** (`aiwf_changelog`)
+  - Automatic CHANGELOG.md generation from git history
+  - Semantic versioning support
+  - Categorization by commit type (feat, fix, docs, etc.)
+  - Integration with commit workflow
+  
+- 🔔 **Developer Experience Hooks**
+  - Stop hook: Audio notification on task completion (Glass.aiff)
+  - PostToolUse hook: Automatic test execution after file edits
+  - Enhanced development workflow automation
+
+### Changed
+- 📚 **Documentation Updates**
+  - Added NPM badges to README
+  - Improved structure and readability
+  - Unified English and Korean documentation
+  - Added installation options documentation
+  - Enhanced command guide with language-specific details
+
+- 🔧 **Settings Configuration**
+  - Added pre-commit hooks for linting and testing
+  - Integrated automation hooks for better developer experience
+
+### Technical Details
+- feat(settings): Stop 및 PostToolUse hooks 설정 추가
+- feat(commands): changelog 자동 생성 명령어 추가  
+- docs(readme,guides): 다국어 지원 및 설치 옵션 문서화
+- feat(hooks): add automatic lint and formatting hooks
+- refactor(i18n): remove redundant Korean command variants
+- feat(i18n): localize English command titles and content

package/CLAUDE.md

@@ -0,0 +1,220 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+This is **aiwf** (AI Workflow Framework), an NPM package that installs the AIWF project management framework for AI-assisted development. It's an updated version of the Simone framework, specifically designed for Claude Code integration.
+
+## Core Architecture
+
+### Main Components
+
+1. **CLI Installer (`index.js`)**: The main entry point that downloads and installs AIWF framework components from GitHub
+2. **AIWF Framework**: A markdown-based project management system located in `claude-code/aiwf/`
+3. **Rules System**: Development guidelines in `rules/global/` and `rules/manual/` for Cursor and Windsurf IDEs
+
+### Key Directories
+
+```text
+aiwf/
+├── index.js                    # Main CLI installer with GitHub API integration
+├── package.json               # NPM package configuration
+├── claude-code/aiwf/      # Complete AIWF framework
+│   ├── ko/                    # Korean language version
+│   │   ├── .claude/commands/   # Korean Claude Code custom commands
+│   │   └── .aiwf/             # Korean project management structure
+│   └── en/                    # English language version
+│       ├── .claude/commands/   # English Claude Code custom commands
+│       └── .aiwf/             # English project management structure
+└── rules/                     # IDE-specific development rules
+    ├── global/                # Always-apply rules
+    └── manual/                # On-demand rules
+```
+
+## Development Commands
+
+### Building and Testing
+
+```bash
+# Install dependencies
+npm install
+
+# Test the installer (creates .aiwf/ and .claude/ in current directory)
+node index.js
+
+# Test with force flag (skips prompts)
+node index.js --force
+
+# Publish to NPM
+npm publish
+```
+
+### Package Usage
+
+```bash
+# Install AIWF in any project (interactive language selection)
+npx aiwf
+
+# Force installation without prompts (defaults to Korean)
+npx aiwf --force
+```
+
+## Technical Implementation Details
+
+### GitHub Integration
+
+The installer (`index.js`) fetches content directly from the GitHub repository:
+
+- **API URL**: `https://api.github.com/repos/aiwf/aiwf`
+- **Raw Content**: `https://raw.githubusercontent.com/aiwf/aiwf/master`
+- **Content Prefix**: `claude-code/aiwf`
+- **Language Support**: Supports both Korean (`ko/`) and English (`en/`) versions
+
+### Installation Process
+
+1. **Language Selection**: Interactive prompt to choose between Korean and English
+2. **Detection**: Checks for existing `.aiwf/` or `.claude/commands/aiwf/`
+3. **Backup**: Creates timestamped backups of existing files (`.bak` format)
+4. **Download**: Fetches framework components from GitHub based on selected language
+5. **Setup**: Creates directory structure and copies files
+6. **Rules Processing**: Converts rules to IDE-specific formats:
+   - Cursor: `.mdc` files with frontmatter in `.cursor/rules/`
+   - Windsurf: Plain `.md` files in `.windsurf/rules/`
+
+### File Processing Logic
+
+- **CLAUDE.md files**: Always updated to latest version
+- **Commands**: Always updated from repository
+- **Templates**: Downloaded on fresh installs only
+- **User content**: Preserved during updates (sprints, tasks, etc.)
+
+## AIWF Framework Integration
+
+### Command Structure
+
+Available via `/project:aiwf:<command>` in Claude Code:
+
+- **Setup**: `initialize`, `prime`, `prime_context`
+- **Planning**: `plan_milestone`, `create_sprints_from_milestone`, `create_sprint_tasks`
+- **Development**: `do_task`, `commit`, `test`, `code_review`
+- **Automation**: `yolo` (autonomous execution)
+- **GitHub**: `issue_create`, `pr_create` (with `gh` CLI integration)
+- **Analysis**: `ultrathink_*`, `mermaid`, `project_review`
+
+### GitHub Issue Integration
+
+The framework supports seamless GitHub integration:
+
+- Tasks can be linked to GitHub issues via `github_issue` field
+- Automatic status synchronization using `gh` CLI
+- PR creation with issue linking
+- Commit message integration (`fixes #123`, `relates to #456`)
+
+### Project Structure Created
+
+```text
+target_project/
+├── .aiwf/                 # Project management root
+│   ├── 00_PROJECT_MANIFEST.md  # Central tracking
+│   ├── 02_REQUIREMENTS/        # Milestone requirements
+│   ├── 03_SPRINTS/            # Sprint execution
+│   ├── 04_GENERAL_TASKS/      # Standalone tasks
+│   ├── 98_PROMPTS/            # Useful prompts
+│   └── 99_TEMPLATES/          # Document templates
+├── .claude/commands/aiwf/ # Claude Code commands
+└── .cursor/rules/             # Cursor IDE rules
+```
+
+## Development Patterns
+
+### Error Handling
+
+- Network failures during GitHub API calls are handled gracefully
+- Backup/restore functionality for failed updates
+- User prompts for dangerous operations
+
+### CLI Design
+
+Uses modern Node.js libraries:
+
+- **commander**: CLI argument parsing
+- **chalk**: Colored terminal output
+- **ora**: Loading spinners
+- **prompts**: Interactive user input
+
+### File Management
+
+- Recursive directory creation with `fs.mkdir({ recursive: true })`
+- Stream-based file downloads using `pipeline()`
+- Atomic operations with backup/restore capability
+
+## Important Constraints
+
+### Installation Safety
+
+- Never overwrites user-created project content
+- Always creates backups before updates
+- Preserves existing work in sprints and tasks
+
+### GitHub Dependency
+
+- Requires internet connection for installation
+- All content fetched from live GitHub repository
+- Uses GitHub API rate limits (unauthenticated)
+
+### Node.js Requirements
+
+- Minimum Node.js 14.0.0
+- Uses ES modules (`"type": "module"`)
+- Requires `https` and `fs/promises` support
+
+## Working with This Codebase
+
+### Making Changes to Framework
+
+1. Modify files in `claude-code/aiwf/`
+2. Test locally with `node index.js`
+3. Commit and push to GitHub
+4. Framework updates are automatically available via `npx aiwf`
+
+### Adding New Commands
+
+1. Create command files in both language directories:
+   - Korean: `claude-code/aiwf/ko/.claude/commands/aiwf/`
+   - English: `claude-code/aiwf/en/.claude/commands/aiwf/`
+2. Follow naming conventions:
+   - Korean versions can use `_kr` suffix for clarity
+   - English versions use standard naming
+3. Update documentation in `docs/COMMANDS_GUIDE.md`
+
+### Modifying Installation Logic
+
+- Main installer logic is in `index.js`
+- Language selection and message handling in `messages` object
+- GitHub API integration in `fetchGitHubContent()` and `downloadFile()`
+- Directory processing in `downloadDirectory()`
+- Backup logic in `backupCommandsAndDocs()`
+- Language-specific path resolution using `GITHUB_CONTENT_LANGUAGE_PREFIX`
+
+## Multilingual Support
+
+### Language Structure
+
+The framework supports both Korean and English through:
+
+- **Separate directory structure**: `ko/` and `en/` folders contain language-specific content
+- **Interactive language selection**: Users choose their preferred language during installation
+- **Localized messages**: All installation messages are available in both languages
+- **Command localization**: Commands are available in both languages with appropriate naming
+
+### Adding New Languages
+
+To add support for additional languages:
+
+1. Create new language directory: `claude-code/aiwf/{lang_code}/`
+2. Copy and translate content from existing language directory
+3. Add language option to `messages` object in `index.js`
+4. Update language selection prompt in `installAIWF()` function
+
+The codebase is designed for stability and user safety, with extensive error handling and backup mechanisms to ensure reliable framework distribution across multiple languages.

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 moonklabs
+Copyright (c) 2025 aiwf
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.ko.md

@@ -1,28 +1,32 @@
-# aiwf
+# AIWF (AI Workflow Framework)
 
-이 프로젝트는 [Simone](https://github.com/Helmi/claude-simone)의 업데이트된 버전입니다.
+[Read in Korean (한국어로 보기)](README.ko.md)
 
-> 🚀 Claude Code용 Moonklabs 프로젝트 관리 프레임워크를 위한 빠른 설치 프로그램
+[![NPM Version](https://img.shields.io/npm/v/aiwf.svg)](https://www.npmjs.com/package/aiwf)
+[![License](https://img.shields.io/npm/l/aiwf.svg)](https://github.com/aiwf/aiwf/blob/main/LICENSE)
+[![Downloads](https://img.shields.io/npm/dm/aiwf.svg)](https://www.npmjs.com/package/aiwf)
 
-## Moonklabs Framework란 무엇인가요?
+## AIWF란?
 
-Moonklabs는 Claude Code를 사용한 AI 지원 개발을 위해 특별히 설계된 마크다운 기반 프로젝트 관리 프레임워크입니다. 소프트웨어 프로젝트를 관리 가능한 덩어리로 나누어 효과적인 AI 처리를 돕습니다.
+AIWF는 Claude Code와 함께 AI 기반 개발을 위해 특별히 설계된 마크다운 기반 프로젝트 관리 프레임워크입니다. 소프트웨어 프로젝트를 AI가 효과적으로 처리할 수 있는 관리 가능한 단위로 분해하여 생산성을 극대화합니다.
+이 프로젝트는 [Simone](https://github.com/Helmi/claude-simone)의 업데이트된 버전입니다.
 
-## 설치
+## 📦 설치
 
-모든 프로젝트 디렉토리에 Moonklabs를 설치하세요:
+프로젝트 디렉토리에서 AIWF 설치:
 
 ```bash
 npx aiwf
 ```
 
-이것으로 끝입니다! 설치 프로그램은 다음을 수행합니다:
+설치 프로그램의 동작:
 
-- 프로젝트 관리를 위한 `.moonklabs/` 디렉토리 구조 생성
-- 사용자 지정 Claude 명령어를 위한 `.claude/commands/moonklabs/` 설정
-- 최신 템플릿 및 문서 다운로드
+1. **언어 선택**: 한국어와 영어 중 선택
+2. **디렉토리 구성**: 프로젝트 관리를 위한 `.aiwf/` 디렉토리 구조 생성
+3. **명령어 설치**: 선택한 언어의 `.claude/commands/aiwf/` Claude 명령어 설정
+4. **콘텐츠 다운로드**: 선택한 언어의 최신 템플릿과 문서 다운로드
 
-## 사용법
+## 🚀 사용법
 
 ### 첫 설치
 
@@ -32,7 +36,7 @@ npx aiwf
 
 ### 기존 설치 업데이트
 
-Moonklabs가 이미 설치된 경우, 설치 프로그램이 이를 감지하고 다음 옵션을 제공합니다:
+AIWF가 이미 설치되어 있다면 설치 프로그램이 자동으로 감지하고 다음 옵션을 제공합니다:
 
 - 업데이트 (자동 백업 포함)
 - 설치 건너뛰기
@@ -40,76 +44,100 @@ Moonklabs가 이미 설치된 경우, 설치 프로그램이 이를 감지하고
 
 ### 강제 설치
 
-모든 프롬프트를 건너뛰고 강제로 설치합니다:
+모든 프롬프트를 건너뛰고 강제 설치 (기본값: 한국어):
 
 ```bash
 npx aiwf --force
 ```
 
-## 설치되는 항목
+### 언어별 설치
+
+설치 프로그램은 선택한 언어에 따라 적절한 언어 버전을 자동으로 선택합니다:
+
+- 한국어 버전: 한국어 명령어와 문서 포함 (기본값)
+- English version: English commands and documentation
+
+## 📁 설치 내용
+
+### 디렉토리 구조
 
 ```
-aiwf/
-├── AI-WORKFLOW.md
-├── CHANGELOG.md
-├── claude-code/
-│   ├── docker/
-│   │   └── Dockerfile
-│   ├── moonklabs/
-│   └── simone/
-│       ├── CHANGELOG.md
-│       ├── LICENSE
-│       ├── README.md
-│       ├── SYNC_GUIDE.md
-│       └── sync-simone.sh
-├── COMMANDS_GUIDE.md
-├── LICENSE
-├── package-lock.json
-├── package.json
-├── PRD.ko.md
-├── PRD.md
-├── README.ko.md
-├── README.md
-└── rules/
-    ├── global/
-    │   ├── code-style-guide.md
-    │   ├── coding-principles.md
-    │   ├── development-process.md
-    │   └── global-rules.md
-    └── manual/
-        └── generate-plan-docs.md
+your_project/
+├── .aiwf/                        # 프로젝트 관리 루트
+│   ├── 00_PROJECT_MANIFEST.md    # 중앙 추적 문서
+│   ├── 01_PROJECT_DOCS/          # 프로젝트 문서
+│   ├── 02_REQUIREMENTS/          # 마일스톤 요구사항
+│   ├── 03_SPRINTS/              # 스프린트 실행 추적
+│   ├── 04_GENERAL_TASKS/        # 독립 작업
+│   ├── 05_ARCHITECTURE_DECISIONS/ # ADR 문서
+│   ├── 10_STATE_OF_PROJECT/     # 프로젝트 상태 스냅샷
+│   ├── 98_PROMPTS/              # 유용한 AI 프롬프트
+│   └── 99_TEMPLATES/            # 문서 템플릿
+├── .claude/commands/aiwf/       # 언어별 Claude 명령어
+├── .cursor/rules/               # Cursor IDE 개발 규칙
+└── .windsurf/rules/             # Windsurf IDE 개발 규칙
 ```
 
-## 다음 단계
+### 언어별 콘텐츠
+
+선택한 언어에 따라 다음이 설치됩니다:
+
+**한국어 버전 (`ko/`)** (기본값):
+
+- 한국어 Claude 명령어 (`_kr` 접미사 포함)
+- 한국어 문서 및 템플릿
+- 현지화된 프로젝트 관리 콘텐츠
+
+**English Version (`en/`)**:
+
+- English Claude commands
+- English documentation and templates
+- Standard project management content
+
+## 🎯 시작하기
+
+설치 후 다음 단계:
+
+1. Claude Code에서 프로젝트를 엽니다
+2. `/project:aiwf` 명령어를 사용하여 프로젝트를 관리합니다
+3. `/project:aiwf:initialize` 명령어로 프로젝트 설정을 시작합니다
 
-설치 후:
+### 주요 명령어
 
-1.  Claude Code에서 프로젝트를 엽니다
-2.  `/project:moonklabs` 명령어를 사용하여 프로젝트를 관리합니다
-3.  `/project:moonklabs:initialize`로 시작하여 프로젝트를 설정합니다
+- **초기화**: `/project:aiwf:initialize` - 프로젝트 초기 설정
+- **계획**: `/project:aiwf:plan_milestone` - 마일스톤 계획 수립
+- **스프린트**: `/project:aiwf:create_sprints_from_milestone` - 스프린트 생성
+- **작업**: `/project:aiwf:do_task` - 작업 실행
+- **리뷰**: `/project:aiwf:code_review` - 코드 리뷰
+- **GitHub 연동**: `/project:aiwf:issue_create`, `/project:aiwf:pr_create`
 
-## 명령어 가이드
+## 📚 문서 참조
 
-Moonklabs의 전체 명령어 목록과 자세한 사용법은 [COMMANDS_GUIDE.md](COMMANDS_GUIDE.md) 문서를 참고하세요.
+전체 AIWF 명령어 목록과 자세한 사용법은 [COMMANDS_GUIDE.md](docs/COMMANDS_GUIDE.md)를 참조하세요.
 
-## 특징
+## ✨ 주요 기능
 
-- 🎨 색상과 진행 표시기가 있는 아름다운 CLI
-- 🔄 자동 백업 기능이 있는 스마트 업데이트 감지
-- 📦 공식 GitHub 리포지토리에서 직접 다운로드
-- 🚀 `npx`로 작동 - 전역 설치 필요 없음
-- 💾 업데이트 시 타임스탬프가 찍힌 백업 생성
+- 🌍 **다국어 지원** - 한국어와 영어 완전 지원
+- 🎨 **아름다운 CLI** - 컬러와 진행 표시기가 있는 사용자 친화적 인터페이스
+- 🔄 **스마트 업데이트** - 자동 백업과 함께 지능형 업데이트 감지
+- 📦 **직접 다운로드** - 공식 GitHub 저장소에서 직접 다운로드
+- 🚀 **간편한 사용** - `npx` 사용으로 전역 설치 불필요
+- 💾 **안전한 백업** - 업데이트 시 타임스탬프 백업 생성
+- 🎯 **언어별 맞춤** - 언어별 명령어와 문서
+- 🔧 **IDE 통합** - Cursor와 Windsurf 개발 규칙 지원
+- 🔗 **GitHub 연동** - 이슈 및 PR 생성 자동화
+- 📊 **프로젝트 추적** - 마일스톤, 스프린트, 작업 체계적 관리
 
-## 요구사항
+## 🔧 요구사항
 
 - Node.js 14.0.0 이상
 - GitHub에서 다운로드하기 위한 인터넷 연결
 
-## 소스
+## 📖 소스
 
-이 설치 프로그램은 다음에서 Moonklabs 프레임워크를 가져옵니다:
-https://github.com/moonklabs/aiwf
+이 설치 프로그램은 다음에서 AIWF 프레임워크를 가져옵니다:
+https://github.com/aiwf/aiwf
 
-## 라이선스
+## 📝 라이선스
 
 MIT