@skyreve/reve 1.0.1 → 1.0.2

package/README.md

@@ -1,50 +1,82 @@
-# Reve CLI - Command Line Interface
+# Reve - SkyReve Platform Command Line Tool
 
-Reve CLI는 Reve 프로젝트를 위한 커맨드라인 도구입니다.  
-이 문서는 Reve CLI를 설치하고 사용하는 방법을 설명합니다.
+Reve는 SkyReve 플랫폼과 GitHub 저장소를 연결하여 프로젝트와 환경을 관리하는 커맨드라인 도구입니다.
+
+## 📋 목차 (Table of Contents)
+
+1. [설치 방법](#1-설치-방법-installation)
+2. [개발 환경 설정](#2-개발-환경-설정-development-setup)
+3. [빌드](#3-빌드-build)
+4. [환경별 바이너리 설명](#4-환경별-바이너리-설명)
+5. [Reve CLI 사용법](#5-reve-cli-사용법-using-reve-cli)
+6. [개발 도구](#6-개발-도구-development-tools)
 
 ---
 
 ## **1. 설치 방법 (Installation)**
 
 ### **1.1 npm을 통한 설치 (권장)**
+
 다른 npm 프로젝트에서 Reve CLI를 사용하려면:
+
 ```bash
 npm install @skyreve/reve
 ```
 
 설치 후 `npx reve` 명령어로 실행할 수 있습니다:
+
 ```bash
 npx reve --help
-npx reve status
-npx reve init
+npx reve start
 ```
 
 ### **1.2 글로벌 설치**
+
 전역적으로 설치하려면:
+
 ```bash
 npm install -g @skyreve/reve
 ```
 
 설치 후 `reve` 명령어로 직접 실행할 수 있습니다:
+
 ```bash
 reve --help
-reve status
-reve init
+reve start
 ```
 
 ---
 
 ## **2. 개발 환경 설정 (Development Setup)**
 
-### **1.1 Go 설치**
+### **2.1 Go 설치**
+
 Reve CLI는 **Go**를 필요로 합니다. Go가 설치되지 않았다면 아래 명령어로 설치하세요:
+
+**macOS:**
+
 ```bash
 brew install go
 ```
 
-### **1.2 프로젝트 초기화**
+**Linux:**
+
+```bash
+# Ubuntu/Debian
+sudo apt update
+sudo apt install golang-go
+
+# CentOS/RHEL
+sudo yum install golang
+```
+
+**Windows:**
+[Go 공식 웹사이트](https://golang.org/dl/)에서 설치 파일을 다운로드하여 설치하세요.
+
+### **2.2 프로젝트 초기화**
+
 프로젝트를 클론하고 의존성을 설치합니다:
+
 ```bash
 git clone git@github.com:SkyReve/reve-cli.git
 cd reve-cli
@@ -53,83 +85,50 @@ go mod tidy
 
 ---
 
-## **2. 빌드 (Build)**
+## **3. 빌드 (Build)**
 
-### **2.1 npm 스크립트를 통한 빌드 (권장)**
-npm을 통해 다양한 환경별로 빌드할 수 있습니다:
+### **3.1 기본 빌드**
 
-#### **개발 환경 빌드**
-```bash
-npm run build-dev
-```
+현재 OS용 바이너리를 빌드하려면:
 
-#### **스테이징 환경 빌드**
 ```bash
-npm run build-staging
+make
 ```
 
-#### **운영 환경 빌드**
-```bash
-npm run build
-```
+또는:
 
-#### **정리**
 ```bash
-npm run clean
+make build
 ```
 
-### **2.2 Makefile을 통한 빌드**
+빌드가 완료되면 `bin/` 디렉토리에 `reve` 바이너리가 생성됩니다:
 
-#### **현재 OS에서 환경별 바이너리 빌드**
-현재 OS에서 **개발(debug), 스테이징(staging), 운영(release)** 환경별로 바이너리를 생성하려면:
-```bash
-make
-```
-또는 개별 환경별로:
-```bash
-make build-dev      # 개발 환경
-make build-stag     # 스테이징 환경  
-make build-prod     # 운영 환경
-```
-
-빌드가 완료되면, `bin/` 디렉토리에 아래 구조로 파일들이 생성됩니다:
 ```bash
 bin/
-├── debug/reve
-├── staging/reve
-└── release/reve
+└── reve
 ```
 
-#### **모든 OS(Linux, macOS, Windows)용 바이너리 빌드**
+### **3.2 모든 OS(Linux, macOS, Windows)용 바이너리 빌드**
+
+모든 플랫폼용 바이너리를 빌드하려면:
+
 ```bash
 make build-all
 ```
-또는 개별 환경별로:
-```bash
-make build-all-dev      # 개발 환경 (모든 OS)
-make build-all-stg      # 스테이징 환경 (모든 OS)
-make build-all-release  # 운영 환경 (모든 OS)
-```
 
 모든 OS에 대한 바이너리를 빌드하면 아래와 같은 구조로 파일이 생성됩니다:
+
 ```bash
 bin/
-├── debug/
-│   ├── linux/reve
-│   ├── darwin/reve
-│   └── windows/reve.exe
-├── staging/
-│   ├── linux/reve
-│   ├── darwin/reve
-│   └── windows/reve.exe
-└── release/
-    ├── linux/reve
-    ├── darwin/reve
-    └── windows/reve.exe
-```
-
-### **2.3 빌드된 바이너리 확인**
+├── linux/reve
+├── darwin/reve
+└── windows/reve.exe
+```
+
+### **3.3 빌드된 바이너리 확인**
+
 빌드된 바이너리는 `bin/` 디렉토리에 저장됩니다. 확인하려면:
+
 ```bash
 ls -la bin/
 # 또는
@@ -138,97 +137,181 @@ tree bin/
 
 ---
 
-## **3. 환경별 바이너리 설명**
-Reve CLI는 환경별로 다른 API 서버를 사용하도록 빌드됩니다.
+## **4. 환경별 실행**
 
-### **🔹 debug 환경 (개발)**
-- **바이너리 경로:** `bin/debug/reve` (단일 OS) 또는 `bin/debug/{os}/reve` (모든 OS)
-- **BaseURL:** `http://127.0.0.1:8000` (기본값)
-- **설명:** 개발 환경용 바이너리입니다. 새로운 기능을 테스트하고 디버깅할 때 사용합니다.
+Reve CLI는 환경 변수 `REVE_ENV`를 통해 다른 API 서버를 사용합니다.
+
+### **🔹 개발 환경 (dev)**
+
+```bash
+make run-dev
+# 또는
+REVE_ENV=dev ./bin/reve
+```
+
+- **BaseURL:** `http://localhost:8000`
+- **GitHub App:** [https://github.com/apps/skyreve-staging](https://github.com/apps/skyreve-staging)
+- **설명:** 개발 환경용입니다. 새로운 기능을 테스트하고 디버깅할 때 사용합니다.
+
+### **🔹 스테이징 환경 (staging)**
+
+```bash
+make run-staging
+# 또는
+REVE_ENV=staging ./bin/reve
+```
 
-### **🔹 staging 환경 (스테이징)**
-- **바이너리 경로:** `bin/staging/reve` (단일 OS) 또는 `bin/staging/{os}/reve` (모든 OS)
 - **BaseURL:** `https://api.hellreve.world`
-- **설명:** 스테이징 환경용 바이너리입니다. 운영 환경과 유사한 조건에서 최종 QA 및 검증에 사용됩니다.
+- **GitHub App:** [https://github.com/apps/skyreve-staging](https://github.com/apps/skyreve-staging)
+- **설명:** 스테이징 환경용입니다. 운영 환경과 유사한 조건에서 최종 QA 및 검증에 사용됩니다.
+
+### **🔹 운영 환경 (production)**
+
+```bash
+make run-production
+# 또는
+./bin/reve
+```
 
-### **🔹 release 환경 (운영)**
-- **바이너리 경로:** `bin/release/reve` (단일 OS) 또는 `bin/release/{os}/reve` (모든 OS)
 - **BaseURL:** `https://api.skyreve.cloud`
-- **GitHub Client ID:** `Iv23liCYhwlznxTEETKo`
-- **설명:** 운영(프로덕션) 환경용 바이너리입니다. 실제 사용자에게 제공되는 서비스 환경에서 사용됩니다.
+- **GitHub App:** [https://github.com/apps/skyreve](https://github.com/apps/skyreve)
+- **설명:** 운영(프로덕션) 환경용입니다. 실제 사용자에게 제공되는 서비스 환경에서 사용됩니다.
 
 ---
 
-## **4. Reve CLI 사용법 (Using `reve`)**
+## **5. Reve CLI 사용법 (Using `reve`)**
+
+### **5.1 npm을 통한 실행 (권장)**
 
-### **4.1 npm을 통한 실행 (권장)**
 npm으로 설치한 경우:
+
 ```bash
 npx reve [COMMAND] [OPTIONS]
 # 또는 글로벌 설치한 경우
 reve [COMMAND] [OPTIONS]
 ```
 
-### **4.2 바이너리 직접 실행**
+### **5.2 바이너리 직접 실행**
+
 빌드된 바이너리를 직접 실행하는 경우:
+
 ```bash
 # 개발 환경
-./bin/debug/reve [COMMAND] [OPTIONS]
+REVE_ENV=dev ./bin/reve [COMMAND] [OPTIONS]
 
-# 스테이징 환경  
-./bin/staging/reve [COMMAND] [OPTIONS]
+# 스테이징 환경
+REVE_ENV=staging ./bin/reve [COMMAND] [OPTIONS]
 
-# 운영 환경
-./bin/release/reve [COMMAND] [OPTIONS]
+# 운영 환경 (기본값)
+./bin/reve [COMMAND] [OPTIONS]
 ```
 
-### **4.3 도움말 확인**
+### **5.3 도움말 확인**
+
 ```bash
 reve --help
 # 또는
 npx reve --help
 ```
 
-### **4.4 주요 명령어**
-| 명령어 | 설명 |
-|--------|------|
-| `reve init` | SkyReve 프로젝트 초기화 |
-| `reve sync` | 원격 데이터와 동기화 |
-| `reve status` | 프로젝트 상태 확인 |
-| `reve deploy` | 프로젝트 배포 |
-| `reve switch` | 프로젝트 및 브랜치 전환 |
-| `reve github-init` | GitHub 연동 초기화 |
-| `reve github-link` | GitHub 저장소 연결 |
-| `reve github-unlink` | GitHub 저장소 연결 해제 |
+### **5.4 주요 명령어**
 
----
+#### **🔹 기본 명령어**
+
+| 명령어               | 설명                                   |
+| -------------------- | -------------------------------------- |
+| `reve start`         | 완전한 설정 과정을 거쳐 환경 관리 시작 |
+| `reve login [email]` | SkyReve 플랫폼에 로그인                |
+| `reve project`       | 작업할 SkyReve 프로젝트 선택           |
+
+#### **🔹 환경 관리 명령어 (`reve env`)**
 
-## **5. 기타 (Additional Information)**
+| 명령어                     | 설명                                                      |
+| -------------------------- | --------------------------------------------------------- |
+| `reve env`                 | 대화형 환경 관리 시작 (`reve env start`와 동일한 동작)    |
+| `reve env start`           | 대화형 환경 관리 시작                                     |
+| `reve env info`            | 프로젝트 정보, Git 저장소 정보, GitHub App 설치 상태 확인 |
+| `reve env list`            | 모든 Reve 환경과 연결된 GitHub 브랜치 정보 나열           |
+| `reve env link <reve_env>` | GitHub 브랜치를 특정 Reve 환경에 연결                     |
+| `reve env sync`            | 현재 저장소 브랜치를 Reve 환경과 동기화                   |
+| `reve env deploy`          | 현재 저장소 브랜치를 Reve 환경에 배포                     |
+
+#### **🔹 GitHub 관련 명령어 (`reve github`)**
+
+| 명령어                | 설명                                   |
+| --------------------- | -------------------------------------- |
+| `reve github login`   | GitHub에 Device Flow를 사용하여 로그인 |
+| `reve github install` | 현재 저장소에 GitHub App 설치          |
+
+### **5.5 사용 예시**
+
+#### **처음 사용하는 경우 (권장)**
 
-### **5.1 실행 방법**
-빌드된 바이너리를 실행하려면:
 ```bash
-# 개발 환경
-./bin/debug/reve --help
+# 1. 완전한 설정 과정을 거쳐 시작
+reve start
+```
 
-# 스테이징 환경
-./bin/staging/reve --help
+이 명령어는 다음 과정을 자동으로 수행합니다:
+
+1. SkyReve 플랫폼 로그인
+2. 프로젝트 선택/생성
+3. GitHub 로그인
+4. GitHub App 설치
+5. 환경 관리 시작
+
+#### **개별 설정**
+
+```bash
+# 1. SkyReve 플랫폼에 로그인
+reve login your-email@example.com
+
+# 2. 프로젝트 선택
+reve project
 
-# 운영 환경
-./bin/release/reve --help
+# 3. GitHub에 로그인
+reve github login
+
+# 4. GitHub App 설치
+reve github install
+
+# 5. 환경 관리 시작
+reve env start
 ```
 
-### **5.2 정리 (Clean)**
-불필요한 빌드 파일을 정리하려면:
+#### **일상적인 사용**
+
 ```bash
-# npm 스크립트 사용
-npm run clean
+# 환경 목록 확인
+reve env list
+
+# 특정 환경에 브랜치 연결
+reve env link main
+
+# 현재 브랜치 동기화
+reve env sync
+
+# 현재 브랜치 배포
+reve env deploy
+
+# 강제 배포 (충돌이 있어도)
+reve env deploy --force
+```
+
+---
+
+## **6. 개발 도구 (Development Tools)**
+
+### **6.1 정리 (Clean)**
 
-# 또는 Makefile 사용
+불필요한 빌드 파일을 정리하려면:
+
+```bash
 make clean
 ```
 
-### **5.3 테스트 및 린트**
+### **6.2 테스트 및 린트**
+
 ```bash
 # 테스트 실행
 make test
@@ -237,18 +320,52 @@ make test
 make lint
 ```
 
-### **5.4 개발 모드 실행**
+### **6.3 개발 모드 실행**
+
 개발 중 빠른 테스트를 위해:
+
 ```bash
 make run
 ```
 
-### **5.5 npm 패키지 배포**
-npm에 패키지를 배포하려면:
-```bash
-npm publish --access public
+---
+
+## **7. 프로젝트 구조**
+
+```
+reve-cli/
+├── cmd/                    # 명령어 정의
+│   ├── root.go            # 루트 명령어
+│   ├── start.go           # 완전한 설정 시작 명령어
+│   ├── login.go           # 로그인 명령어
+│   ├── project.go         # 프로젝트 선택 명령어
+│   ├── env.go             # 환경 관리 명령어
+│   ├── github.go          # GitHub 관련 명령어
+│   ├── env/               # 환경 관리 서브 명령어
+│   │   ├── start.go       # 환경 관리 시작
+│   │   ├── info.go        # 프로젝트 정보 확인
+│   │   ├── list.go        # 환경 목록
+│   │   ├── link.go        # 브랜치 연결
+│   │   ├── sync.go        # 동기화
+│   │   ├── deploy.go      # 배포
+│   │   └── common.go      # 공통 함수
+│   └── github/            # GitHub 서브 명령어
+│       ├── login.go       # GitHub 로그인
+│       └── install.go     # GitHub App 설치
+├── internal/              # 내부 패키지
+│   ├── config/           # 설정 관리
+│   ├── constants/        # 상수 정의
+│   ├── git/              # Git 관련 기능
+│   ├── github/           # GitHub API
+│   ├── logger/           # 로깅
+│   └── reve/             # Reve API 및 유틸리티
+├── main.go               # 메인 진입점
+├── go.mod               # Go 모듈 정의
+└── README.md           # 이 파일
 ```
 
 ---
 
-### **🛠 이제 SkyReve CLI를 사용할 준비가 완료되었습니다! 🚀**
+### **🛠 이제 SkyReve command line tool: `reve`를 사용할 준비가 완료되었습니다! 🚀**
+
+더 자세한 정보나 도움이 필요하시면 [GitHub Issues](https://github.com/SkyReve/reve-cli/issues)에서 문의해 주세요.

package/README.npm.md

@@ -1,12 +1,12 @@
-# Reve CLI
+# Reve
 
-Reve CLI는 Reve 플랫폼을 위한 커맨드라인 도구입니다.
+Reve는 Reve 플랫폼을 위한 커맨드라인 도구입니다.
 
 ## 설치 방법
 
 ### npm을 통한 설치 (권장)
 
-다른 npm 프로젝트에서 Reve CLI를 사용하려면:
+다른 npm 프로젝트에서 Reve를 사용하려면:
 ```bash
 npm install @skyreve/reve
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@skyreve/reve",
-  "version": "1.0.1",
-  "description": "Reve CLI - A command line tool for Reve platform",
+  "version": "1.0.2",
+  "description": "Reve - A command line tool for Reve platform",
   "main": "index.js",
   "scripts": {
     "reve": "node scripts/reve.js",