spets 0.1.2 → 0.1.4

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.md CHANGED
@@ -5,10 +5,9 @@ Spec Driven Development Execution Framework - 유저가 정의한 스텝대로 S
5
5
  ## Installation
6
6
 
7
7
  ```bash
8
- # 글로벌 설치 (선택)
9
8
  npm install -g spets
10
9
 
11
- # 또는 npx로 바로 사용 (설치 불필요)
10
+ # 또는 npx로 바로 사용
12
11
  npx spets init
13
12
  ```
14
13
 
@@ -30,7 +29,7 @@ npx spets resume
30
29
 
31
30
  ## How it Works
32
31
 
33
- 1. **spets init** - `.sept/` 폴더에 설정과 스텝 템플릿 생성
32
+ 1. **spets init** - `.spets/` 폴더에 설정과 스텝 템플릿 생성
34
33
  2. **spets start** - 유저 쿼리로 워크플로우 시작, Claude가 각 스텝 문서 생성
35
34
  3. **approve/revise/reject** - 각 스텝마다 유저가 검토하고 승인
36
35
  4. **반복** - 모든 스텝 완료까지 진행
@@ -38,7 +37,7 @@ npx spets resume
38
37
  ## Directory Structure
39
38
 
40
39
  ```
41
- .sept/
40
+ .spets/
42
41
  ├── config.yml # 워크플로우 설정
43
42
  ├── steps/
44
43
  │ ├── 01-plan/
@@ -56,21 +55,59 @@ npx spets resume
56
55
 
57
56
  ## GitHub Integration
58
57
 
59
- PR/Issue 코멘트로 워크플로우 제어:
58
+ GitHub Issue/PR 연동하여 워크플로우를 실행합니다.
59
+
60
+ ### 설정
60
61
 
61
62
  ```bash
62
- # GitHub Actions 워크플로우 포함해서 초기화
63
+ # GitHub Actions + Issue 템플릿 포함해서 초기화
63
64
  npx spets init --github
65
+ ```
66
+
67
+ 이 명령어는 다음을 생성합니다:
68
+ - `.github/workflows/spets.yml` - GitHub Actions 워크플로우
69
+ - `.github/ISSUE_TEMPLATE/spets-task.yml` - Issue 템플릿
70
+ - `.spets/config.yml`에 `github.owner`, `github.repo` 자동 설정 (git remote에서 파싱)
71
+
72
+ ### Issue로 워크플로우 시작
73
+
74
+ 1. GitHub에서 **New Issue** → **Spets Task** 템플릿 선택
75
+ 2. Task Description 입력 (예: "사용자 인증 기능 추가")
76
+ 3. Branch Name 입력 (선택, 비워두면 `spets/<issue-number>` 자동 생성)
77
+ 4. Issue 생성 → GitHub Actions 자동 트리거
78
+
79
+ ### CLI로 워크플로우 시작
80
+
81
+ ```bash
82
+ # GitHub 모드 (기존 Issue/PR 자동 감지)
83
+ npx spets start "task" --github
84
+
85
+ # 새 Issue 생성하면서 시작
86
+ npx spets start "task" --issue
64
87
 
65
- # GitHub 플랫폼으로 시작
66
- npx spets start "task" --platform github --owner myorg --repo myrepo --issue 42
88
+ # 기존 Issue에 연결
89
+ npx spets start "task" --issue 42
90
+
91
+ # 새 PR 생성하면서 시작 (브랜치도 자동 생성)
92
+ npx spets start "task" --pr
93
+
94
+ # 기존 PR에 연결
95
+ npx spets start "task" --pr 42
67
96
  ```
68
97
 
69
- 코멘트 명령어:
70
- - `/approve` - 승인하고 다음 스텝
71
- - `/revise <feedback>` - 피드백과 함께 재생성
98
+ ### 코멘트 명령어
99
+
100
+ Issue/PR 코멘트로 워크플로우를 제어합니다:
101
+
102
+ - `/approve` - 현재 스텝 승인하고 다음 스텝 진행
103
+ - `/revise <feedback>` - 피드백과 함께 현재 스텝 재생성
72
104
  - `/reject` - 워크플로우 중단
73
105
 
106
+ ### 필요 설정
107
+
108
+ Repository Secrets에 추가:
109
+ - `ANTHROPIC_API_KEY` - Claude API 키
110
+
74
111
  ## Claude Code Plugin
75
112
 
76
113
  ```bash
@@ -81,17 +118,21 @@ npx spets plugin install claude
81
118
  /spets start "task description"
82
119
  ```
83
120
 
84
- 스킬이 설치되면 Claude Code 내에서 `npx spets` 명령어를 자동으로 실행합니다. 글로벌 설치 없이도 동작합니다.
85
-
86
121
  ## Configuration
87
122
 
88
- `.sept/config.yml`:
123
+ `.spets/config.yml`:
89
124
 
90
125
  ```yaml
91
126
  steps:
92
127
  - 01-plan
93
128
  - 02-implement
94
129
 
130
+ # GitHub 연동 (spets init --github 시 자동 설정)
131
+ github:
132
+ owner: your-org
133
+ repo: your-repo
134
+
135
+ # 훅 (선택)
95
136
  hooks:
96
137
  preStep: "./hooks/pre-step.sh"
97
138
  postStep: "./hooks/post-step.sh"
@@ -103,6 +144,7 @@ hooks:
103
144
 
104
145
  - Node.js >= 18
105
146
  - Claude CLI (`claude` command) or ANTHROPIC_API_KEY
147
+ - GitHub CLI (`gh`) - GitHub 연동 사용 시
106
148
 
107
149
  ## License
108
150
 
@@ -195,6 +195,8 @@ function loadTaskMetadata(taskId, cwd = process.cwd()) {
195
195
 
196
196
  export {
197
197
  getSpetsDir,
198
+ getStepsDir,
199
+ getOutputsDir,
198
200
  spetsExists,
199
201
  loadConfig,
200
202
  loadStepDefinition,