codesyncer 1.1.0 → 2.0.1

package/README.ko.md

@@ -13,7 +13,15 @@
 
 ## 🎯 CodeSyncer란?
 
-CodeSyncer는 여러 레포지토리에서 AI 코딩 어시스턴트와 효율적으로 협업할 수 있도록 도와주는 CLI 도구입니다. 프로젝트 구조, 코딩 규칙, 비즈니스 결정 사항을 체계적으로 문서화하여 AI가 이해할 수 있게 만듭니다.
+CodeSyncer는 AI 코딩 어시스턴트(Claude Code 등)가 멀티 레포지토리 워크스페이스에 지능형 협업 시스템을 구축할 수 있도록 **프레임워크와 규칙**을 제공합니다.
+
+**작동 방식:**
+1. **사용자가** CodeSyncer CLI 설치
+2. **사용자가** AI 어시스턴트 실행 (Claude Code, Cursor 등)
+3. **사용자가** `codesyncer init` 실행
+4. **AI가** 프로젝트를 분석하고 CodeSyncer 구조에 따라 문서 생성
+
+CodeSyncer는 문서가 **어디에, 어떻게** 만들어져야 하는지 정의합니다. AI 어시스턴트는 실제 코드를 분석하여 **무엇을** 작성할지 결정합니다.
 
 ### 주요 기능
 
@@ -26,6 +34,20 @@ CodeSyncer는 여러 레포지토리에서 AI 코딩 어시스턴트와 효율
 
 ---
 
+## ⚠️ 사전 요구사항
+
+**CodeSyncer는 AI 코딩 어시스턴트가 활성화되어 있어야 합니다.**
+
+현재 지원:
+- ✅ **Claude Code** (권장)
+- 🚧 Cursor (곧 지원 예정)
+- 🚧 GitHub Copilot (곧 지원 예정)
+- 🚧 Continue.dev (곧 지원 예정)
+
+**중요**: CodeSyncer를 사용하기 전에 AI 코딩 어시스턴트를 **실행하고 활성화**해주세요. AI가 프로젝트를 분석하고 정확한 문서를 생성하는 데 도움을 줍니다.
+
+---
+
 ## 📦 설치
 
 ```bash
@@ -57,7 +79,23 @@ npm install -g codesyncer@latest
 
 ## 🚀 빠른 시작
 
-### 1. 워크스페이스 루트로 이동
+### 1단계: CodeSyncer 설치
+
+```bash
+npm install -g codesyncer
+```
+
+### 2단계: AI 어시스턴트 실행
+
+AI 코딩 어시스턴트를 실행하세요:
+- **Claude Code** (권장)
+- Cursor
+- GitHub Copilot
+- 또는 다른 AI 코딩 도구
+
+반드시 **활성화되어 실행 중**이어야 합니다.
+
+### 3단계: 워크스페이스로 이동
 
 ```bash
 cd /path/to/your/workspace
@@ -71,38 +109,73 @@ workspace/
 └── mobile/
 ```
 
-### 2. 초기화 실행
+### 4단계: CodeSyncer 초기화
 
 ```bash
 codesyncer init
 ```
 
-### 3. 설치 모드 선택
+다음을 입력합니다:
+- 언어 선택 (한글/English)
+- 프로젝트 이름
+- GitHub 사용자명
+
+**실행 과정:**
+1. CodeSyncer가 레포지토리 스캔
+2. 기술 스택과 프로젝트 타입 자동 감지
+3. 발견한 레포 정보와 함께 `.codesyncer/SETUP_GUIDE.md` 생성
+
+**CodeSyncer는 여기까지만 합니다!** 프레임워크와 규칙만 제공하고, 이제 AI가 직접 설정합니다.
+
+---
 
-**⚡ 퀵 설치** (권장)
-- 모든 레포 자동 감지
-- 한 번에 협업 시스템 생성
-- 모든 의논 키워드 자동 활성화
+## ⚠️ 중요: 5단계 - AI가 모든 설정 완료
 
-**🔧 전문가 설치**
-- 모든 옵션 세부 설정
-- 특정 키워드 카테고리 선택
-- 커스텀 키워드 추가
+> **🎯 이 단계를 건너뛰지 마세요!** 여기서 마법이 일어납니다.
+
+**Claude Code 실행** (또는 선호하는 AI 어시스턴트)하고 다음과 같이 말하세요:
+
+```
+".codesyncer/SETUP_GUIDE.md 파일을 읽고 지시사항대로 설정해줘"
+```
 
-### 4. 언어 선택
+### 이후 자동으로 진행되는 작업:
 
-한글 또는 English 선택
+**1️⃣ AI가 코드 분석**
+- 각 레포지토리의 실제 파일 읽기
+- 기술 스택, 패턴, 구조 파악
+- 프로젝트 아키텍처 이해
 
-### 5. 완료!
+**2️⃣ AI가 중요한 질문** (절대 추론하지 않음!)
+- ❓ "API 엔드포인트가 뭐예요?"
+- ❓ "가격 정책과 비즈니스 로직은 어떻게 되나요?"
+- ❓ "어떤 인증 방식을 사용하나요?"
+- ❓ "데이터베이스 스키마는 어떻게 구성되어 있나요?"
+- ❓ "어떤 외부 서비스와 연동하나요?"
+
+**3️⃣ AI가 완전한 문서 생성**
+- `.codesyncer/MASTER_CODESYNCER.md` → 멀티 레포 네비게이션
+- `<repo>/.claude/CLAUDE.md` → 코딩 규칙
+- `<repo>/.claude/ARCHITECTURE.md` → 프로젝트 구조
+- `<repo>/.claude/DECISIONS.md` → 의사결정 기록
+- `<repo>/.claude/COMMENT_GUIDE.md` → 주석 태그 가이드
+
+> **💡 왜 이게 효과적인가**: AI가 여러분의 실제 코드를 분석하고 질문합니다. 생성된 문서는 일반적인 템플릿이 아닌, 여러분의 프로젝트에 맞춤화된 내용입니다.
+
+---
+
+### 6단계: 코딩 시작!
+
+설정이 완료되면 AI에게 다음과 같이 말하세요:
+```
+"CLAUDE.md 읽어줘"
+```
 
-CodeSyncer가 자동으로:
-- 레포 스캔 및 감지 (Java, Python, Node.js, React 등)
-- 워크스페이스 루트에 마스터 문서 생성 (`.codesyncer/MASTER_CODESYNCER.md`)
-- 각 레포에 협업 파일 생성 (`.claude/` 폴더)
-  - `CLAUDE.md` - 코딩 가이드라인
-  - `COMMENT_GUIDE.md` - 주석 태그 사용 가이드
-  - `ARCHITECTURE.md` - 프로젝트 구조 (자동 업데이트)
-  - `DECISIONS.md` - 의사결정 기록
+AI 어시스턴트가:
+- 프로젝트의 코딩 규칙 준수
+- 올바른 기술 스택 패턴 사용
+- 중요한 결정 전 질문
+- 모든 결정을 `@codesyncer-*` 태그로 기록
 
 ---
 

package/README.md

@@ -13,7 +13,15 @@
 
 ## 🎯 What is CodeSyncer?
 
-CodeSyncer is a CLI tool that sets up an intelligent collaboration system between you and AI coding assistants across multiple repositories. It helps AI understand your project structure, coding standards, and business decisions through a structured documentation system.
+CodeSyncer provides the **framework and rules** for AI coding assistants (like Claude Code) to set up an intelligent collaboration system across your multi-repository workspace.
+
+**How it works:**
+1. **You install** CodeSyncer CLI
+2. **You launch** your AI assistant (Claude Code, Cursor, etc.)
+3. **You run** `codesyncer init`
+4. **AI analyzes** your projects and generates documentation following CodeSyncer's structure
+
+CodeSyncer defines **WHERE** and **HOW** documentation should be created. Your AI assistant fills in the **WHAT** by analyzing your actual code.
 
 ### Key Features
 
@@ -26,6 +34,20 @@ CodeSyncer is a CLI tool that sets up an intelligent collaboration system betwee
 
 ---
 
+## ⚠️ Prerequisites
+
+**CodeSyncer requires an AI coding assistant to be active.**
+
+Currently supported:
+- ✅ **Claude Code** (Recommended)
+- 🚧 Cursor (Coming soon)
+- 🚧 GitHub Copilot (Coming soon)
+- 🚧 Continue.dev (Coming soon)
+
+**Important**: Make sure your AI coding assistant is **running and active** before using CodeSyncer. The AI will analyze your projects and help generate accurate documentation.
+
+---
+
 ## 📦 Installation
 
 ```bash
@@ -57,7 +79,23 @@ npm install -g codesyncer@latest
 
 ## 🚀 Quick Start
 
-### 1. Navigate to your workspace root
+### Step 1: Install CodeSyncer
+
+```bash
+npm install -g codesyncer
+```
+
+### Step 2: Launch your AI assistant
+
+Open your AI coding assistant:
+- **Claude Code** (Recommended)
+- Cursor
+- GitHub Copilot
+- Or any other AI coding tool
+
+Make sure it's **active and running**.
+
+### Step 3: Navigate to your workspace
 
 ```bash
 cd /path/to/your/workspace
@@ -71,38 +109,73 @@ workspace/
 └── mobile/
 ```
 
-### 2. Run initialization
+### Step 4: Initialize CodeSyncer
 
 ```bash
 codesyncer init
 ```
 
-### 3. Choose setup mode
+You'll be asked:
+- Language preference (Korean/English)
+- Project name
+- GitHub username
+
+**What happens:**
+1. CodeSyncer scans your repositories
+2. Detects tech stacks and project types
+3. Creates `.codesyncer/SETUP_GUIDE.md` with discovered repository information
+
+**That's all CodeSyncer does!** It provides the framework and rules. Now your AI takes over.
+
+---
 
-**⚡ Quick Setup** (Recommended)
-- Auto-detects all repositories
-- Creates collaboration system in one step
-- Enables all discussion keywords automatically
+## ⚠️ IMPORTANT: Step 5 - Let AI Set Everything Up
 
-**🔧 Expert Setup**
-- Full customization options
-- Select specific keyword categories
-- Add custom keywords
+> **🎯 Don't skip this step!** This is where the magic happens.
+
+**Launch Claude Code** (or your preferred AI assistant) and say:
+
+```
+"Read .codesyncer/SETUP_GUIDE.md and follow the instructions to set up"
+```
 
-### 4. Select language
+### What happens next (automatically):
 
-Choose between Korean (한글) or English
+**1️⃣ AI Analyzes Your Code**
+- Reads actual files in each repository
+- Detects tech stack, patterns, and structure
+- Understands your project architecture
 
-### 5. That's it!
+**2️⃣ AI Asks Critical Questions** (Never assumes!)
+- ❓ "What are your API endpoints?"
+- ❓ "What's your pricing and business logic?"
+- ❓ "Which authentication method do you use?"
+- ❓ "What's your database schema?"
+- ❓ "Which external services do you integrate?"
+
+**3️⃣ AI Generates Complete Documentation**
+- `.codesyncer/MASTER_CODESYNCER.md` → Multi-repo navigation
+- `<repo>/.claude/CLAUDE.md` → Coding rules
+- `<repo>/.claude/ARCHITECTURE.md` → Project structure
+- `<repo>/.claude/DECISIONS.md` → Decision log
+- `<repo>/.claude/COMMENT_GUIDE.md` → Comment tag guide
+
+> **💡 Why this works**: AI analyzes YOUR actual code and asks YOU questions. The generated docs are tailored to your specific project, not generic templates.
+
+---
+
+### Step 6: Start Coding!
+
+Once setup is complete, just tell your AI:
+```
+"Read CLAUDE.md"
+```
 
-CodeSyncer will:
-- Scan and detect your repositories (Java, Python, Node.js, React, etc.)
-- Create master document at workspace root (`.codesyncer/MASTER_CODESYNCER.md`)
-- Generate collaboration files in each repo (`.claude/` folder)
-  - `CLAUDE.md` - Coding guidelines
-  - `COMMENT_GUIDE.md` - Comment tag usage guide
-  - `ARCHITECTURE.md` - Project structure (auto-updated)
-  - `DECISIONS.md` - Decision log
+Your AI assistant will then:
+- Follow your project's coding rules
+- Use the correct tech stack patterns
+- Ask before making critical decisions
+- Record all decisions with `@codesyncer-*` tags
 
 ---
 

package/dist/commands/init.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAoH,MAAM,UAAU,CAAC;AAMzJ,wBAAsB,WAAW,CAAC,OAAO,EAAE,WAAW,iBAkErD"}
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAY,MAAM,UAAU,CAAC;AAIjD,wBAAsB,WAAW,CAAC,OAAO,EAAE,WAAW,iBAuNrD"}