@litmers/cursorflow-orchestrator 0.1.0 → 0.1.1

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.
@@ -1,162 +1,162 @@
1
- # CursorFlow Clean
2
-
3
- ## Overview
4
- 브랜치, 워크트리, 로그 등을 정리합니다. 오래된 파일이나 실패한 실행의 잔여물을 제거합니다.
5
-
6
- ## Steps
7
-
8
- 1. **정리 타입 선택**
9
-
10
- | 타입 | 설명 |
11
- |------|------|
12
- | `branches` | Git 브랜치 정리 |
13
- | `worktrees` | Git worktree 정리 |
14
- | `logs` | 로그 파일 정리 |
15
- | `all` | 모두 정리 |
16
-
17
- 2. **브랜치 정리**
18
- ```bash
19
- cursorflow clean branches --pattern "feature/my-*"
20
- ```
21
-
22
- 3. **워크트리 정리**
23
- ```bash
24
- cursorflow clean worktrees --all
25
- ```
26
-
27
- 4. **로그 정리**
28
- ```bash
29
- cursorflow clean logs --older-than 30
30
- ```
31
-
32
- 5. **Dry run으로 확인**
33
- ```bash
34
- cursorflow clean all --dry-run
35
- ```
36
-
37
- ## 옵션
38
-
39
- | 옵션 | 설명 |
40
- |------|------|
41
- | `--pattern <pattern>` | 패턴 매칭 (예: "feature/*") |
42
- | `--older-than <days>` | N일 이상 항목만 (logs) |
43
- | `--dry-run` | 삭제할 항목만 표시 |
44
- | `--force` | 확인 없이 삭제 |
45
- | `--local-only` | 로컬만 (브랜치용) |
46
- | `--remote-only` | 원격만 (브랜치용) |
47
-
48
- ## 예제
49
-
50
- ### 브랜치 정리
51
-
52
- #### 패턴 매칭으로 삭제
53
- ```bash
54
- cursorflow clean branches --pattern "feature/dashboard-*"
55
- ```
56
-
57
- #### 모든 CursorFlow 브랜치
58
- ```bash
59
- cursorflow clean branches --pattern "feature/*" --dry-run
60
- ```
61
-
62
- #### 로컬 브랜치만
63
- ```bash
64
- cursorflow clean branches --pattern "feature/*" --local-only
65
- ```
66
-
67
- ### 워크트리 정리
68
-
69
- #### 모든 워크트리
70
- ```bash
71
- cursorflow clean worktrees --all
72
- ```
73
-
74
- #### 특정 패턴
75
- ```bash
76
- cursorflow clean worktrees --pattern "*-dashboard-*"
77
- ```
78
-
79
- ### 로그 정리
80
-
81
- #### 30일 이상 로그
82
- ```bash
83
- cursorflow clean logs --older-than 30
84
- ```
85
-
86
- #### 모든 로그
87
- ```bash
88
- cursorflow clean logs --all --force
89
- ```
90
-
91
- ### 전체 정리
92
-
93
- #### 모두 확인 후 삭제
94
- ```bash
95
- cursorflow clean all --dry-run
96
- cursorflow clean all --force
97
- ```
98
-
99
- ## 정리 결과
100
-
101
- ```
102
- 🧹 Cleaning CursorFlow Resources
103
- ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
104
-
105
- Branches to delete:
106
- - feature/dashboard-pipeline-abc123 (local)
107
- - feature/dashboard-pipeline-abc123 (remote)
108
- - feature/client-pipeline-def456 (local)
109
-
110
- Worktrees to remove:
111
- - .cursorflow/logs/worktrees/01-dashboard-pipeline-abc123
112
- - .cursorflow/logs/worktrees/02-client-pipeline-def456
113
-
114
- Logs to delete:
115
- - _cursorflow/logs/runs/01-dashboard-2025-12-10T10-00-00 (9 days old)
116
-
117
- Total: 5 branches, 2 worktrees, 1 log directory
118
-
119
- Proceed? [y/N]
120
- ```
121
-
122
- ## 주의사항
123
-
124
- 1. **백업**: 중요한 작업 중인 브랜치는 백업
125
- 2. **확인**: `--dry-run`으로 먼저 확인
126
- 3. **원격**: 원격 브랜치 삭제는 신중하게
127
- 4. **복구**: 삭제된 항목은 복구 어려움
128
-
129
- ## Checklist
130
- - [ ] 정리할 항목을 확인했는가?
131
- - [ ] 백업이 필요한가?
132
- - [ ] dry-run으로 먼저 확인했는가?
133
- - [ ] 다른 사람이 사용 중인 브랜치는 아닌가?
134
- - [ ] 원격 저장소에서도 삭제할 것인가?
135
-
136
- ## 트러블슈팅
137
-
138
- ### 브랜치 삭제 실패
139
- ```bash
140
- # 강제 삭제
141
- git branch -D <branch-name>
142
- git push origin --delete <branch-name>
143
- ```
144
-
145
- ### 워크트리 제거 실패
146
- ```bash
147
- # 강제 제거
148
- git worktree remove --force <worktree-path>
149
- ```
150
-
151
- ### 로그 디렉토리 권한 문제
152
- ```bash
153
- # 권한 확인
154
- ls -la _cursorflow/logs/
155
- # 권한 수정
156
- chmod -R u+w _cursorflow/logs/
157
- ```
158
-
159
- ## Next Steps
160
- 1. 정기적으로 로그 정리 (예: 월 1회)
161
- 2. CI/CD에 자동 정리 스크립트 추가
162
- 3. `.gitignore`에 로그 디렉토리 추가
1
+ # CursorFlow Clean
2
+
3
+ ## Overview
4
+ Clean up branches, worktrees, and logs. Remove stale files or remnants from failed runs.
5
+
6
+ ## Steps
7
+
8
+ 1. **Choose what to clean**
9
+
10
+ | Type | Description |
11
+ |------|------|
12
+ | `branches` | Clean Git branches |
13
+ | `worktrees` | Clean Git worktrees |
14
+ | `logs` | Clean log files |
15
+ | `all` | Clean everything |
16
+
17
+ 2. **Clean branches**
18
+ ```bash
19
+ cursorflow clean branches --pattern "feature/my-*"
20
+ ```
21
+
22
+ 3. **Clean worktrees**
23
+ ```bash
24
+ cursorflow clean worktrees --all
25
+ ```
26
+
27
+ 4. **Clean logs**
28
+ ```bash
29
+ cursorflow clean logs --older-than 30
30
+ ```
31
+
32
+ 5. **Verify with a dry run**
33
+ ```bash
34
+ cursorflow clean all --dry-run
35
+ ```
36
+
37
+ ## Options
38
+
39
+ | Option | Description |
40
+ |------|------|
41
+ | `--pattern <pattern>` | Pattern match (e.g., "feature/*") |
42
+ | `--older-than <days>` | Items older than N days (for logs) |
43
+ | `--dry-run` | Show items to delete without removing |
44
+ | `--force` | Delete without confirmation |
45
+ | `--local-only` | Local only (branches) |
46
+ | `--remote-only` | Remote only (branches) |
47
+
48
+ ## Examples
49
+
50
+ ### Branch cleanup
51
+
52
+ #### Delete by pattern
53
+ ```bash
54
+ cursorflow clean branches --pattern "feature/dashboard-*"
55
+ ```
56
+
57
+ #### All CursorFlow branches
58
+ ```bash
59
+ cursorflow clean branches --pattern "feature/*" --dry-run
60
+ ```
61
+
62
+ #### Local branches only
63
+ ```bash
64
+ cursorflow clean branches --pattern "feature/*" --local-only
65
+ ```
66
+
67
+ ### Worktree cleanup
68
+
69
+ #### All worktrees
70
+ ```bash
71
+ cursorflow clean worktrees --all
72
+ ```
73
+
74
+ #### Specific pattern
75
+ ```bash
76
+ cursorflow clean worktrees --pattern "*-dashboard-*"
77
+ ```
78
+
79
+ ### Log cleanup
80
+
81
+ #### Logs older than 30 days
82
+ ```bash
83
+ cursorflow clean logs --older-than 30
84
+ ```
85
+
86
+ #### All logs
87
+ ```bash
88
+ cursorflow clean logs --all --force
89
+ ```
90
+
91
+ ### Full cleanup
92
+
93
+ #### Review then delete
94
+ ```bash
95
+ cursorflow clean all --dry-run
96
+ cursorflow clean all --force
97
+ ```
98
+
99
+ ## Sample output
100
+
101
+ ```
102
+ 🧹 Cleaning CursorFlow Resources
103
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
104
+
105
+ Branches to delete:
106
+ - feature/dashboard-pipeline-abc123 (local)
107
+ - feature/dashboard-pipeline-abc123 (remote)
108
+ - feature/client-pipeline-def456 (local)
109
+
110
+ Worktrees to remove:
111
+ - .cursorflow/logs/worktrees/01-dashboard-pipeline-abc123
112
+ - .cursorflow/logs/worktrees/02-client-pipeline-def456
113
+
114
+ Logs to delete:
115
+ - _cursorflow/logs/runs/01-dashboard-2025-12-10T10-00-00 (9 days old)
116
+
117
+ Total: 5 branches, 2 worktrees, 1 log directory
118
+
119
+ Proceed? [y/N]
120
+ ```
121
+
122
+ ## Notes
123
+
124
+ 1. **Back up**: Save important branches before deleting.
125
+ 2. **Confirm**: Start with `--dry-run` to review changes.
126
+ 3. **Remote caution**: Be careful when deleting remote branches.
127
+ 4. **Irreversible**: Deleted items are hard to recover.
128
+
129
+ ## Checklist
130
+ - [ ] Have you reviewed items to clean?
131
+ - [ ] Do you need backups?
132
+ - [ ] Did you run a dry run first?
133
+ - [ ] Are other teammates using these branches?
134
+ - [ ] Do you also need to delete from the remote?
135
+
136
+ ## Troubleshooting
137
+
138
+ ### Branch deletion failed
139
+ ```bash
140
+ # Force delete
141
+ git branch -D <branch-name>
142
+ git push origin --delete <branch-name>
143
+ ```
144
+
145
+ ### Worktree removal failed
146
+ ```bash
147
+ # Force remove
148
+ git worktree remove --force <worktree-path>
149
+ ```
150
+
151
+ ### Log directory permission issues
152
+ ```bash
153
+ # Check permissions
154
+ ls -la _cursorflow/logs/
155
+ # Fix permissions
156
+ chmod -R u+w _cursorflow/logs/
157
+ ```
158
+
159
+ ## Next steps
160
+ 1. Clean logs regularly (e.g., monthly).
161
+ 2. Add an automated cleanup script to CI/CD.
162
+ 3. Add log directories to `.gitignore`.
@@ -1,67 +1,67 @@
1
- # CursorFlow Init
2
-
3
- ## Overview
4
- 프로젝트에 CursorFlow 초기화합니다. 설정 파일과 디렉토리 구조를 생성하고, 선택적으로 Cursor 커맨드와 예제 태스크를 설치합니다.
5
-
6
- ## Steps
7
-
8
- 1. **초기화 실행**
9
- ```bash
10
- cursorflow init
11
- ```
12
-
13
- 2. **옵션 선택**
14
- - `--example`: 예제 태스크 생성
15
- - `--config-only`: 설정 파일만 생성
16
- - `--no-commands`: Cursor 커맨드 설치 건너뛰기
17
- - `--force`: 기존 파일 덮어쓰기
18
-
19
- 3. **생성 확인**
20
- - `cursorflow.config.js` 파일 생성됨
21
- - `_cursorflow/tasks/` 디렉토리 생성됨
22
- - `_cursorflow/logs/` 디렉토리 생성됨
23
- - `.cursor/commands/cursorflow/` 커맨드 설치됨 (선택)
24
-
25
- 4. **설정 파일 검토**
26
- ```javascript
27
- // cursorflow.config.js
28
- module.exports = {
29
- tasksDir: '_cursorflow/tasks',
30
- logsDir: '_cursorflow/logs',
31
- baseBranch: 'main',
32
- // ... 기타 설정
33
- };
34
- ```
35
-
36
- ## 예제
37
-
38
- ### 기본 초기화
39
- ```bash
40
- cursorflow init
41
- ```
42
-
43
- ### 예제 태스크 포함
44
- ```bash
45
- cursorflow init --example
46
- ```
47
-
48
- ### 설정 파일만 생성
49
- ```bash
50
- cursorflow init --config-only
51
- ```
52
-
53
- ### 기존 파일 덮어쓰기
54
- ```bash
55
- cursorflow init --force
56
- ```
57
-
58
- ## Checklist
59
- - [ ] 설정 파일이 프로젝트 루트에 생성되었는가?
60
- - [ ] 필요한 디렉토리가 생성되었는가?
61
- - [ ] Cursor 커맨드가 설치되었는가?
62
- - [ ] 설정 내용이 프로젝트에 맞게 조정되었는가?
63
-
64
- ## Next Steps
65
- 1. `cursorflow.config.js` 파일을 프로젝트에 맞게 수정
66
- 2. Cursor IDE에서 `/` 입력하여 커맨드 확인
67
- 3. `cursorflow prepare MyFeature`로 태스크 생성 시작
1
+ # CursorFlow Init
2
+
3
+ ## Overview
4
+ Initialize CursorFlow in your project. Create the config file and directory structure, and optionally install Cursor commands and example tasks.
5
+
6
+ ## Steps
7
+
8
+ 1. **Run initialization**
9
+ ```bash
10
+ cursorflow init
11
+ ```
12
+
13
+ 2. **Choose options**
14
+ - `--example`: create example tasks
15
+ - `--config-only`: create only the config file
16
+ - `--no-commands`: skip installing Cursor commands
17
+ - `--force`: overwrite existing files
18
+
19
+ 3. **Verify created files**
20
+ - `cursorflow.config.js` created
21
+ - `_cursorflow/tasks/` directory created
22
+ - `_cursorflow/logs/` directory created
23
+ - `.cursor/commands/cursorflow/` commands installed (optional)
24
+
25
+ 4. **Review the config file**
26
+ ```javascript
27
+ // cursorflow.config.js
28
+ module.exports = {
29
+ tasksDir: '_cursorflow/tasks',
30
+ logsDir: '_cursorflow/logs',
31
+ baseBranch: 'main',
32
+ // ... other settings
33
+ };
34
+ ```
35
+
36
+ ## Examples
37
+
38
+ ### Basic initialization
39
+ ```bash
40
+ cursorflow init
41
+ ```
42
+
43
+ ### Include example tasks
44
+ ```bash
45
+ cursorflow init --example
46
+ ```
47
+
48
+ ### Generate only the config
49
+ ```bash
50
+ cursorflow init --config-only
51
+ ```
52
+
53
+ ### Overwrite existing files
54
+ ```bash
55
+ cursorflow init --force
56
+ ```
57
+
58
+ ## Checklist
59
+ - [ ] Was the config file created at the project root?
60
+ - [ ] Were the required directories created?
61
+ - [ ] Were Cursor commands installed?
62
+ - [ ] Is the configuration adjusted for the project?
63
+
64
+ ## Next steps
65
+ 1. Update `cursorflow.config.js` for your project.
66
+ 2. In Cursor IDE, type `/` to confirm the commands are available.
67
+ 3. Start generating tasks with `cursorflow prepare MyFeature`.