@bifos/dooray-cli 0.13.0 → 0.14.0

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.
@@ -5,685 +5,44 @@ description: Dooray 업무 관리 CLI. 프로젝트/업무/댓글/위키 조회
5
5
 
6
6
  # dooray-cli
7
7
 
8
- NHN Dooray REST API를 래핑한 CLI 도구. 업무 조회, 생성, 수정, 댓글, 위키 등을 터미널에서 수행한다.
8
+ NHN Dooray REST API를 래핑한 CLI 도구다.
9
+ 이 파일은 router다.
10
+ 작업하려는 영역에 맞는 reference를 먼저 읽고, 자연어 요청은 [intent-map.md](references/intent-map.md) 표로 커맨드를 찾는다.
9
11
 
10
- ## 설치
12
+ ## 먼저 읽을 것
11
13
 
12
- ```bash
13
- npm install -g @bifos/dooray-cli
14
- ```
15
-
16
- ## 초기 설정
17
-
18
- 대화형 마법사로 번에 설정:
19
-
20
- ```bash
21
- dooray setup # API endpoint 선택, API key 입력, 메일 설정까지 대화형으로 진행
22
- ```
23
-
24
- 또는 개별 수동 설정:
25
-
26
- ```bash
27
- dooray config set base-url https://api.dooray.com
28
- dooray config set api-key <YOUR_API_TOKEN> # https://{org}.dooray.com/setting/api/token
29
- dooray doctor # 설정 검증
30
- ```
31
-
32
- ## 출력 모드
33
-
34
- | 플래그 | 설명 | 용도 |
35
- |--------|------|------|
36
- | (없음) | 사람이 읽기 좋은 테이블 | 기본 |
37
- | `--json` | JSON 출력 (stdout) | 파싱, 체이닝 |
38
- | `--quiet` | ID만 출력 | 스크립팅 |
39
-
40
- **AI 에이전트는 `--json`을 사용하여 구조화된 데이터를 파싱하라.**
41
-
42
- ---
43
-
44
- ## 의도 → 커맨드 매핑
45
-
46
- 자연어 요청을 커맨드로 변환할 때 아래 표를 참고한다.
47
-
48
- > **공통 (post 하위 16개 명령)**: 아래 명령은 `<project> <number>` 외에도 `--id <postId>`, `--url <url>`, 또는 첫 인자에 Dooray URL 을 직접 받는다.
49
- > `post get`/`edit`/`done`/`workflow`, `post comment list`/`add`/`edit`/`delete`, `post file list`/`upload`/`download`/`download-all`/`delete`, `post comment file list`/`upload`/`download`/`delete`.
50
- >
51
- > 지원 URL 형식 3종 (positional 첫 인자 / `--url` 공통):
52
- > - `https://*.dooray.com/task/to/<postId>`
53
- > - `https://*.dooray.com/task/<projectId>/<postId>` — 브라우저 주소창 복사본
54
- > - `https://*.dooray.com/project/tasks/<postId>` — 프로젝트 업무 목록 → 업무 열기
55
- >
56
- > **사용자가 URL을 줬으면 그대로 첫 인자로 전달**하는 것이 가장 빠른 경로 (resolve 단계 단축).
57
-
58
- | 의도 | 커맨드 |
59
- |------|--------|
60
- | 초기 설정 (대화형) | `dooray setup` |
61
- | 프로젝트 찾기 | `dooray project list --search <keyword>` |
62
- | 개인 프로젝트 목록 | `dooray project list --type private` |
63
- | 프로젝트 멤버 보기 | `dooray project members <project>` 또는 `dooray member list <project>` (이름·organizationMemberId) |
64
- | 프로젝트 멤버 그룹 목록 | `dooray project groups <project>` (ID / Code) |
65
- | 프로젝트 태그 목록 | `dooray project tags <project>` (ID / Color / Name / Group / Mandatory) |
66
- | 프로젝트 템플릿 목록 | `dooray project templates <project>` (id / templateName) |
67
- | 멤버 상세 (organizationMemberId) | `dooray member get <organizationMemberId>` (cache 우회) |
68
- | organization 전체 멤버 검색 | `dooray member search <keyword>` (이름 기본), `--email`(이메일 exact), `--user-code`(사번 like), `--user-code-exact`(사번 exact), `--page`/`--size` |
69
- | 업무 목록 조회 | `dooray post list <project>` |
70
- | 업무 검색 | `dooray post search <project|projectId> "<keyword>"` — projectId (15+자리 numeric) 직접 입력 시 cache 우회 |
71
- | 업무 상세 보기 | `dooray post get <project> <number>` (번호) / `dooray post get --id <postId>` (internal ID) |
72
- | 업무 생성 | `dooray post create <project> --title "..." [--body "..." \| --body-file <path>]` (`--tag`/`--parent`/`--workflow`/`--milestone` 지원) |
73
- | 템플릿 기반 업무 생성 | `dooray post create <project> --template <name\|id>` — body/users/tags 자동 채움 (사용자 옵션 우선 override) |
74
- | 업무 제목/본문 수정 | `dooray post edit <project> <number> --title "..." --body "..."` 또는 `--body-file <path>` |
75
- | 업무 완료 처리 | `dooray post done <project> <number>` |
76
- | 업무 워크플로우 변경 | `dooray post workflow <project> <number> <workflow>` |
77
- | 댓글 조회 | `dooray post comment list <project> <number>` (`--sort`, `--reverse`, `--latest`, `--since`, `--from-author` 필터. table: Creator 자동 채움, `--json`: raw) |
78
- | 최신 댓글 조회 | `dooray post comment latest <project> <number>` — 최신 댓글 1개 빠른 조회. `-n <N>`으로 N개 지정 |
79
- | 단일 댓글 조회 | `dooray post comment get <project> <number> <comment-id>` — 본문·메타·attachments 직접 fetch. `--id`/`--url` + `--comment-id` 모드 지원 |
80
- | 댓글 추가 | `dooray post comment add <project> <number> --body "..."` 또는 `--body-file <path>` |
81
- | 댓글 수정 | `dooray post comment edit <project> <number> <comment-id> --body "..."` 또는 `--body-file <path>` |
82
- | 댓글 삭제 | `dooray post comment delete <project> <number> <comment-id>` |
83
- | 위키 목록 | `dooray wiki list` |
84
- | 위키 페이지 목록 | `dooray wiki pages <project>` |
85
- | 위키 페이지 상세 | `dooray wiki page get <project> <page-id>` |
86
- | 위키 페이지 생성 | `dooray wiki page create <project> --title "..." [--parent <page-id>] [--body "..."]` (--parent 생략 시 위키 home 페이지 아래 생성) |
87
- | 위키 페이지 수정 (제목) | `dooray wiki page edit <project> <page-id> --title "..."` |
88
- | 위키 페이지 수정 (본문) | `dooray wiki page edit <project> <page-id> --body "..."` 또는 `--body-file ./new.md` |
89
- | 위키 페이지 수정 (에디터) | `dooray wiki page edit <project> <page-id>` (플래그 없으면 $EDITOR 열림) |
90
- | 위키 페이지 삭제 | `dooray wiki page delete <project> <page-id>` (y/N 확인 기본, `--yes`로 자동화 시 생략. 하위 페이지는 상위 페이지로 재부착) |
91
- | 위키 페이지 첨부 목록 | `dooray wiki page file list <project> <page-id>` (general + inline 합산, type 컬럼) |
92
- | 위키 페이지 첨부 업로드 | `dooray wiki page file upload <project> <page-id> --file <path> [--type inline_image]` (multipart `type` 필드를 `file` 앞에 전송) |
93
- | 위키 페이지 첨부 다운로드 | `dooray wiki page file download <project> <page-id> --file-id <id> -o <dir>` |
94
- | 위키 페이지 첨부 일괄 다운로드 | `dooray wiki page file download-all <project> <page-id> -o <dir>` (files + images 전부) |
95
- | 위키 페이지 첨부 삭제 | `dooray wiki page file delete <project> <page-id> --file-id <id>` (confirm 없음) |
96
- | 위키 페이지 댓글 목록 | `dooray wiki page comment list <project> <page-id> [--latest N]` (최신순) |
97
- | 위키 페이지 최신 댓글 | `dooray wiki page comment latest <project> <page-id>` |
98
- | 위키 페이지 댓글 조회 | `dooray wiki page comment get <project> <page-id> <comment-id>` |
99
- | 위키 페이지 댓글 추가 | `dooray wiki page comment add <project> <page-id> --body "..."` ($EDITOR fallback) |
100
- | 위키 페이지 댓글 수정 | `dooray wiki page comment edit <project> <page-id> <comment-id> --body "..."` |
101
- | 위키 페이지 댓글 삭제 | `dooray wiki page comment delete <project> <page-id> <comment-id>` (confirm 없음) |
102
- | 메일 목록 조회 | `dooray mail list` |
103
- | 안읽은 메일 | `dooray mail list --unread` |
104
- | 메일 제목 검색 | `dooray mail list --search "<keyword>"` |
105
- | 메일 상세 | `dooray mail get <uid>` |
106
- | 메일 발송 | `dooray mail send --to "..." --subject "..." --body "..."` |
107
- | 메일 답장 | `dooray mail reply <uid> --body "..."` |
108
- | 메신저 1:1 다이렉트 메시지 | `dooray messenger send --to "<id\|email>" --body "..."` (`--to`는 id/이메일만, 이름 미지원) |
109
- | 메신저 대화방 메시지 | `dooray messenger channel-send --channel "<channelId\|이름>" --body "..."` (이름은 자신이 속한 방만 검색) |
110
- | 첨부파일 목록 | `dooray post file list <project> <number>` |
111
- | 첨부파일 다운로드 | `dooray post file download <project> <number> <file-id>` |
112
- | 전체 첨부파일 다운로드 | `dooray post file download-all <project> <number>` |
113
- | 첨부파일 업로드 | `dooray post file upload <project> <number> <file-path>` |
114
- | 첨부파일 삭제 | `dooray post file delete <project> <number> <file-id>` |
115
- | file 명령군 자동화 파싱 | `dooray post file <verb> ... --json` — `download` = `{outputPath,fileName,size}`, `download-all` = `{count,succeeded,failed}` (부분 실패 시 exit 1), `delete` = `{fileId,status}`, `upload` = `res.result` raw |
116
- | 댓글 첨부 목록 | `dooray post comment file list <project> <number> <comment-id>` |
117
- | 댓글 파일 업로드 | `dooray post comment file upload <project> <number> <comment-id> <path>` |
118
- | 댓글 파일 다운로드 | `dooray post comment file download <project> <number> <comment-id> <file-id>` |
119
- | 댓글 파일 삭제 | `dooray post comment file delete <project> <number> <comment-id> <file-id> --yes` |
120
- | 참조자(cc) 멤버/그룹 추가 | `dooray post edit <project> <number> --cc-group <code>` — 기존 참조자 유지 + 그룹 추가 (dedupe) |
121
- | 참조자 전체 교체 | `dooray post edit <project> <number> --cc-clear --cc <name>` — 기존 참조자 비우고 신규 멤버만 |
122
- | 신규 업무 + 그룹 cc | `dooray post create <project> --title "..." --cc-group <code>` — 생성 시 그룹 참조자 포함 |
123
- | `--cc-group <code\|id>` / `--mention-group <code\|id>` | 그룹 매칭 — 15+자리 numeric → id 직접 / 그 외 → code matchByName (부분일치) |
124
- | 상위 업무 설정/변경 | `dooray post edit <project> <number> --title "<원제목>" --parent <ref>` (`<ref>`: `<project>/<number>` 또는 raw postId. `--title` 필수, unset 미지원) |
125
- | `dooray post edit --id <postId> --tag <name>` | 태그 추가 (반복, dedupe) |
126
- | `dooray post edit --id <postId> --tag-clear --tag <name>` | 태그 전체 교체 |
127
- | `dooray post edit --id <postId> --tag-remove <name>` | 특정 태그 제거 |
128
-
129
- > **제목 옵션 네이밍**: `post` 와 `wiki page` 모두 `--title` 표준. `post`의 `--subject`는 deprecated alias로 당분간 동작하되, 새 코드에서는 `--title` 사용을 권장.
130
-
131
- ---
132
-
133
- ## 제약사항 (Dooray API 한계)
134
-
135
- CLI로 처리 **불가능한** 작업. 아래 항목을 요청받으면 웹 UI 사용을 안내할 것.
136
-
137
- | 작업 | 대체 경로 | 근거 |
138
- |---|---|---|
139
- | 위키 페이지 이동 (상위 페이지 변경) | 웹 UI (`https://{tenant}.dooray.com/wiki/...`) | Dooray REST API 미지원 |
140
- | 프로젝트 삭제 | 웹 UI (admin 페이지) | API 미지원 |
141
-
142
- 위키 페이지를 잘못 만든 경우(테스트/중복)는 `dooray wiki page delete <project> <page-id>` 로 정리한다.
143
- 공식 문서화된 endpoint 가 아니라 서버 정책이 바뀌면 동작이 달라질 수 있음에 유의한다.
144
-
145
- ---
146
-
147
- ## 워크플로우 판단 기준
148
-
149
- 1. **"내 프로젝트", "개인 프로젝트" 언급 시** → `dooray project list --type private --json` 으로 개인 프로젝트 먼저 조회
150
- 2. **프로젝트 코드를 모르면** → `dooray project list --search <keyword>` 로 먼저 찾기
151
- 3. **업무 번호를 모르면** → `dooray post search <project> "<keyword>"` 로 검색
152
- 4. **워크플로우 이름을 모르면** → `dooray project workflows <project>` 로 확인
153
- 5. **멤버 이름을 모르면** → `dooray member list <project>` (또는 `dooray project members <project>`) 로 확인
154
- 6. **org 전체 멤버를 찾으려면** → `dooray member search <keyword>` (이름), `--email <addr>`, `--user-code <code>` 중 하나 사용
155
- 7. **결과를 다음 액션에 사용하려면** → `--json` 플래그로 구조화된 데이터 획득
156
-
157
- ---
158
-
159
- ## 체이닝 예시
160
-
161
- ### 업무 찾아서 완료 처리
162
-
163
- ```bash
164
- # 1. 업무 검색으로 번호 확인
165
- dooray post search <project> "graceful shutdown" --json
166
- # → [{ "number": 42, "subject": "graceful shutdown 구현", ... }]
167
-
168
- # 2. 완료 처리
169
- dooray post done <project> 42
170
- ```
171
-
172
- ### 프로젝트 찾아서 업무 생성
173
-
174
- ```bash
175
- # 1. 프로젝트 코드 확인
176
- dooray project list --search "AI서비스" --json
177
- # → [{ "code": "ai-service-dev", ... }]
178
-
179
- # 2. 업무 생성
180
- dooray post create ai-service-dev \
181
- --title "주간보고 2026-W14" \
182
- --body "## 이번 주 성과\n- 항목1\n- 항목2" \
183
- --to "김철수"
184
- ```
185
-
186
- ### 업무 상세 조회 후 댓글 추가
187
-
188
- ```bash
189
- # 1. 업무 조회
190
- dooray post get <project> 42 --json
191
-
192
- # 2. 댓글 추가
193
- dooray post comment add <project> 42 --body "진행 상황 업데이트: 80% 완료"
194
- ```
195
-
196
- ### 시나리오 — 댓글에 스크린샷 자동 첨부
197
-
198
- 스크립트가 스크린샷을 댓글에 삽입하거나, 에이전트가 결과 파일을 첨부 댓글로 보고할 때 사용.
199
- Dooray REST API 가 댓글 전용 attachment endpoint 를 미지원하므로 내부적으로 post-level files API + 댓글 본문 PUT 합성으로 동작한다.
200
-
201
- ```bash
202
- # 1. 댓글을 먼저 만든다 (텍스트만, --json 으로 commentId 획득)
203
- COMMENT_ID=$(dooray post comment add <project> <post-num> --body "스크린샷 보고:" --json | jq -r '.id')
204
-
205
- # 2. 그 댓글에 파일을 첨부 (post-level 업로드 + 댓글 본문 markdown 자동 추가)
206
- dooray post comment file upload <project> <post-num> "$COMMENT_ID" ./screenshot.png
207
- ```
208
-
209
- ### 시나리오 — 배포 알림 메신저 자동 전송
210
-
211
- CI/배포 스크립트가 완료 알림을 담당자 DM 또는 팀 대화방에 자동으로 보낼 때 사용.
212
- 전송은 API 토큰 소유자 명의로 나가며, 본문은 plain text 만 지원한다.
213
-
214
- ```bash
215
- # 담당자 DM (id 또는 이메일만 가능 — 이름 검색 미지원)
216
- dooray messenger send --to "user@example.com" --body "배포가 완료되었습니다 (v1.2.3)."
217
-
218
- # 팀 대화방 (channelId 또는 자신이 속한 대화방 이름)
219
- dooray messenger channel-send --channel "배포 알림방" --body-file ./release-note.md
220
-
221
- # --json 으로 log-id 확인 (자동화 파이프라인에서 후속 처리 시)
222
- dooray messenger send --to <memberId> --body "..." --json
223
- ```
224
-
225
- ### 위키 페이지 조회
226
-
227
- ```bash
228
- # 1. 위키 페이지 목록
229
- dooray wiki pages <project> --json
230
- # → [{ "id": "<pageId>", "subject": "설계 문서", ... }]
231
-
232
- # 2. 페이지 내용 조회
233
- dooray wiki page get <project> <pageId> --json
234
- ```
235
-
236
- ### 첨부파일 일괄 다운로드 후 실패 분리
237
-
238
- ```bash
239
- # --json 으로 구조화 출력 → jq 로 성공/실패 분리
240
- RESULT=$(dooray post file download-all <project> <number> -o ./ --json)
241
- echo "$RESULT" | jq -r '.failed[] | "\(.fileId): \(.error)"' >&2
242
- echo "$RESULT" | jq -r '.succeeded[].path'
243
- # exit code 1 이 설정되어 있으면 실패 있는 상태
244
- ```
245
-
246
- ### 위키 페이지 첨부파일 — 스킬 파일 팀 공유
247
-
248
- **스킬 파일 팀 공유**: 팀 위키에 스킬 파일 (예: `SKILL.md`) 을 `wiki page file upload` 로 첨부 → 팀원이 `wiki page file download-all` 로 일괄 받아 `~/.claude/skills/` 에 그대로 설치.
249
-
250
- ```bash
251
- # 업로드 (일반 첨부)
252
- dooray wiki page file upload <project> <page-id> --file ~/.claude/skills/my-skill/SKILL.md
253
-
254
- # 팀원 쪽에서 일괄 다운로드
255
- dooray wiki page file download-all <project> <page-id> -o ~/.claude/skills/my-skill/
256
-
257
- # 첨부 목록 확인 (type 컬럼: general / inline_image)
258
- dooray wiki page file list <project> <page-id>
259
- ```
260
-
261
- ### 위키 페이지 인라인 이미지 업로드 후 본문 자동 삽입
262
-
263
- `--type inline_image` 로 업로드 시 `--json` 응답에 `markdownSnippet` 필드가 포함됩니다.
264
- jq 로 추출해 본문에 바로 삽입하는 자동화가 가능합니다.
265
-
266
- ```bash
267
- # 1. 인라인 이미지 업로드 — --json 으로 markdownSnippet 추출
268
- SNIPPET=$(dooray wiki page file upload <project> <page-id> \
269
- --file ./diagram.png --type inline_image --json \
270
- | jq -r '.markdownSnippet')
271
- # SNIPPET = "![diagram.png](/wikis/<wikiId>/files/<attachFileId>)"
272
-
273
- # 2. 기존 본문 조회
274
- CURRENT_BODY=$(dooray wiki page get <project> <page-id> --json | jq -r '.body.content')
275
-
276
- # 3. snippet 을 본문 끝에 추가해 업데이트
277
- NEW_BODY="${CURRENT_BODY}
278
-
279
- ${SNIPPET}"
280
- dooray wiki page edit <project> <page-id> --body "$NEW_BODY"
281
- ```
282
-
283
- **참고**: `general` 타입은 `markdownSnippet` 없음. `--quiet` 은 id 만 출력 (snippet 미포함).
284
-
285
- ### 위키 페이지 댓글 — 회의록 결정사항 자동 누적
286
-
287
- **회의록 결정사항 자동 누적**: 회의록 위키 페이지에 자동화 봇이 `wiki page comment add` 로 결정사항을 댓글로 누적, `wiki page comment list --latest 20` 으로 최근 토론 흐름 추적.
288
-
289
- ```bash
290
- # 결정사항 댓글 추가
291
- dooray wiki page comment add <project> <page-id> --body "결정: 배포일 2026-06-01 확정"
292
-
293
- # 최근 20개 토론 흐름 조회
294
- dooray wiki page comment list <project> <page-id> --latest 20
295
-
296
- # 최신 댓글 1건 shortcut
297
- dooray wiki page comment latest <project> <page-id>
298
- ```
299
-
300
- ## 단일 댓글 본문 fetch
301
-
302
- `post comment get <project> <post-number> <comment-id> --json` 으로 단일 댓글의 본문 + attachments 를 곧장 fetch. `comment list` 후 jq 필터링 우회 불필요.
303
-
304
- 본문 patch 흐름:
305
- 1. `dooray post comment get <p> <n> <id> --json | jq -r '.body.content' > current.md`
306
- 2. (편집)
307
- 3. `dooray post comment edit <p> <n> <id> --body-file current.md --no-confirm` (attachment guard 통과)
308
-
309
- ---
310
-
311
- ## 본문 수정 (attachment 보호)
312
-
313
- `post edit` / `post comment edit` 는 full-replace 방식이다. 자동화에서는 다음 중 하나를 선택:
314
-
315
- 1. **기존 attachment 보존**:
316
- - `post edit` 수정 전: `dooray post get <project> <post-number> --json` 으로 `.body.content` 에서 `/files/<id>` 패턴 추출
317
- - `post comment edit` 수정 전: `dooray post comment list <project> <post-number> --json` 으로 해당 댓글 본문에서 `/files/<id>` 패턴 추출
318
- 추출한 markdown reference 를 새 본문에 그대로 포함하여 전달
319
- 2. **명시적 제거**: attachment 가 더 이상 필요 없다고 판단하면 `--no-confirm` 으로 진행. 누락이 의도한 결과임을 명시
320
-
321
- ---
322
-
323
- ## 커맨드 상세
324
-
325
- ### 업무 식별 방식 (post 하위 16개 명령 공통)
326
-
327
- 아래 16개 명령은 4가지 입력을 모두 받는다:
328
- `post get`/`edit`/`done`/`workflow`, `post comment list`/`add`/`edit`/`delete`, `post file list`/`upload`/`download`/`download-all`/`delete`, `post comment file list`/`upload`/`download`/`delete`.
329
-
330
- ```bash
331
- # (1) 기존 positional — 가장 익숙한 형태 (<number> 는 업무 번호 #N)
332
- dooray post get <project> 42
333
-
334
- # (2) Dooray URL을 첫 인자로 — 사용자 메시지에서 URL을 그대로 복사할 때 최적
335
- # 지원 형식 3종 모두 동일하게 작동
336
- dooray post get https://x.dooray.com/task/to/<postId>
337
- dooray post get https://x.dooray.com/task/<projectId>/<postId>
338
- dooray post get https://x.dooray.com/project/tasks/<postId>
339
-
340
- # (3) --id <postId> — post create 결과의 .id 를 그대로 전달
341
- dooray post get --id <postId>
342
-
343
- # (4) --url <url> — URL 형식 3종 모두 지원
344
- dooray post get --url https://x.dooray.com/task/to/<postId>
345
- ```
346
-
347
- > ⚠️ **`post create` 결과 `.id` 는 internal postId (19자리 숫자)입니다.**
348
- > 이 숫자를 `<project> <업무번호>` 의 번호 자리에 넣으면 안내 에러가 발생합니다.
349
- > 후속 조회·수정·댓글은 반드시 **`--id <postId>`** 를 사용하세요.
350
- >
351
- > ```bash
352
- > POST_ID=$(dooray post create <project> --title "..." --json | jq -r '.id')
353
- > dooray post get --id "$POST_ID" # ✅ --id 사용
354
- > dooray post comment add --id "$POST_ID" --body "댓글" # ✅ --id 사용
355
- > # dooray post get <project> "$POST_ID" # ❌ 안내 에러 발생
356
- > ```
357
-
358
- **우선순위 / 충돌 규칙**: `--id`+`--url` 동시 지정 → 에러.
359
- `--id`/`--url`+positional 동시 지정 → 에러.
360
- URL/`--id`/`--url` 모드는 standalone API(`getPost(postId)`)로 resolve 단계를 단축.
361
-
362
- **sub-id 옵션화** (URL/`--id`/`--url` 모드에서 필수):
363
- ```bash
364
- # comment edit/delete: --comment-id
365
- dooray post comment edit --url <url> --comment-id <commentId> --body "..."
366
- dooray post comment delete --url <url> --comment-id <commentId>
14
+ | 상황 | 읽을 reference |
15
+ |------|----------------|
16
+ | 자연어 요청 → 커맨드 매핑 (마스터 표) | [intent-map.md](references/intent-map.md) |
17
+ | 설치, 초기 설정, 출력 모드, API 제약사항, 피드백 등록, 에러 핸들링, 캐시 | [common.md](references/common.md) |
18
+ | 업무(post) 식별·생성·수정, 참조자/담당자 변경, 본문 attachment 보호, 부모 지정, 태그 자동화 | [post.md](references/post.md) |
19
+ | 업무 댓글 추가/필터/단일 조회 | [comment.md](references/comment.md) |
20
+ | 위키 페이지 조회(트리 포함), 첨부파일, 인라인 이미지, 위키 댓글 | [wiki.md](references/wiki.md) |
21
+ | 그룹 멘션/cc 판단, 멘션·링크 자동 삽입, Dooray 마크다운 링크 형식 | [mention-link.md](references/mention-link.md) |
22
+ | 워크플로우 판단 기준, 정형 task 자동화, 체이닝 시나리오 | [workflow.md](references/workflow.md) |
367
23
 
368
- # file download/delete: --file-id
369
- dooray post file download --url <url> --file-id <fileId> -o ./downloads
370
- dooray post file delete --url <url> --file-id <fileId>
24
+ ## 공통 우선 규칙
371
25
 
372
- # file upload: --file (로컬 경로)
373
- dooray post file upload --url <url> --file ./report.pdf
374
- ```
375
-
376
- 기존 positional 3-arg(`comment edit <project> <number> <comment-id>`, `file upload <project> <number> <path>`)는 그대로 유지.
377
-
378
- ### 업무 생성 (non-interactive)
379
-
380
- ```bash
381
- dooray post create <project> \
382
- --title "제목" \
383
- --body "본문 마크다운" \
384
- --to "담당자이름" \ # 여러 명: --to "김철수" --to "이영희"
385
- --cc "참조자이름" \
386
- --priority normal \ # highest, high, normal, low, lowest
387
- --due-date "2026-04-30T18:00:00+09:00" \
388
- --tag "버그" --tag "긴급" \ # 반복 지정. mandatory 그룹은 클라이언트 사전 검증
389
- --parent "<project>/337" \ # "code/number" 또는 raw postId 두 형태만 허용
390
- --workflow "진행 중" \ # 이름 또는 class (registered/working/closed). 부분일치 모호 시 후보 + 에러
391
- --milestone "Sprint 12"
392
- ```
393
-
394
- 본문이 길면 파일로 (`--body`와 `--body-file`은 함께 사용 불가):
395
- ```bash
396
- dooray post create <project> --title "제목" --body-file ./content.md
397
- ```
398
-
399
- > **`--workflow` 동작 주의**: 워크플로우 설정은 post 생성 *후속* 호출.
400
- > resolve/설정에 실패해도 stderr 경고만 출력되고 **exit code는 0** (post는 이미 생성됨).
401
- > 자동화 스크립트에서 워크플로우 적용 여부를 보장해야 하면 stderr를 별도 점검할 것.
402
-
403
- ### 업무 수정 (non-interactive)
404
-
405
- ```bash
406
- # 제목만 변경
407
- dooray post edit <project> <number> --title "새 제목"
408
-
409
- # 본문만 변경
410
- dooray post edit <project> <number> --body "새 본문"
411
-
412
- # 제목 + 본문 동시 변경
413
- dooray post edit <project> <number> --title "새 제목" --body-file ./updated.md
414
- ```
415
-
416
- ### 참조자(cc) / 담당자(to) 변경 — 멤버 · 그룹
417
-
418
- ```bash
419
- # 기존 참조자 유지 + 그룹 추가 (dedupe: organizationMemberId / projectMemberGroupId)
420
- dooray post edit <project> <number> --cc-group dev-team
421
-
422
- # 기존 참조자 전부 비우고 신규 멤버만
423
- dooray post edit <project> <number> --cc-clear --cc 홍길동
424
-
425
- # 담당자(to)도 동일 패턴: --to / --to-group / --to-clear
426
- dooray post edit <project> <number> --to 김철수 --to-group qa-team
427
- ```
428
-
429
- dry-run 으로 변경 결과 미리보기 (API 호출 없음):
430
-
431
- ```bash
432
- dooray post edit --id "$POST_ID" --cc-group qa-team --dry-run --json \
433
- | jq '.users.cc'
434
- ```
435
-
436
- > interactive (`$EDITOR`) 모드에서는 위 옵션이 무시되고 stderr 경고가 출력됩니다.
437
-
438
- ## 동명이인 우회 — 이메일 / memberId 직접
439
-
440
- 이름이 동일한 멤버가 여러 명이라 `--cc 홍길동` 이 모호로 실패할 때:
441
-
442
- ```bash
443
- # 1) 이메일로 우회
444
- dooray post edit --id "$POST_ID" --cc user.specific@example.com
445
-
446
- # 2) 사전에 member search 로 ID 확보 후 직접
447
- MEMBER_ID=$(dooray member search 홍길동 --json | jq -r '.[] | select(.externalEmailAddress=="user.specific@example.com") | .id')
448
- dooray post edit --id "$POST_ID" --cc "$MEMBER_ID"
449
- ```
450
-
451
- `--to` / `--mention` 동일 분기 (resolveMember 인프라). 분기 규칙:
452
- - `^\d{15,}$` — memberId 직접 사용
453
- - 이메일 정규형 — searchMembers exact
454
- - 그 외 — 이름 부분일치
455
-
456
- ## 신규 업무 생성 후 그룹 cc 첨부
457
-
458
- 자동화 패턴:
459
- 1. audit 리포트 분석
460
- 2. 신규 업무 생성
461
- 3. 후속으로 특정 그룹을 참조에 추가
462
-
463
- ```bash
464
- # 1. 신규 업무 생성 (그룹 cc 포함)
465
- POST_ID=$(dooray post create <project> \
466
- --title "주간 audit 리포트" \
467
- --body-file ./report.md \
468
- --cc-group dev-team \
469
- --json | jq -r '.id')
470
-
471
- # 2. (필요 시) 후속으로 cc 추가
472
- dooray post edit --id "$POST_ID" --cc-group qa-team
473
- ```
474
-
475
- ---
476
-
477
- ## 자식 업무 먼저 → 후속 부모 지정
478
-
479
- ```bash
480
- # 1. 자식 업무 생성 (parent 모르고)
481
- CHILD_ID=$(dooray post create <project> --title "subtask A" --json | jq -r '.id')
482
-
483
- # 2. 부모 결정 후 후속 지정
484
- dooray post edit --id "$CHILD_ID" --title "subtask A" --parent <project>/<parent-number>
485
- ```
486
-
487
- **한계** (cmux-browser spike 결과): Dooray API 가 `unset-parent-post` 미제공 → CLI 로 parent 해제 불가. 필요 시 웹 UI 에서 처리.
488
-
489
- ---
490
-
491
- ## 태그 사후 분류 자동화
492
-
493
- 분류 분석 결과를 받아 태그를 재분류하는 자동화는 단독 호출 패턴이 효율적:
494
-
495
- ```bash
496
- # 분석 스크립트가 분류한 태그 이름을 cli 로 적용 — body fetch 불요
497
- POST_ID=$(...)
498
- CATEGORY=$(...)
499
- dooray post edit --id "$POST_ID" --tag "분류: $CATEGORY"
500
- ```
501
-
502
- 태그만 변경하는 시나리오에서 `--title` / `--body` 강제 없음.
503
- mandatory 그룹은 친절한 에러 메시지로 안내.
504
-
505
- ---
506
-
507
- ### 댓글 추가 (non-interactive)
26
+ - 자연어 요청이 오면 먼저 [intent-map.md](references/intent-map.md) 표에서 대응 커맨드를 찾는다.
27
+ - 사용자가 Dooray URL을 줬으면 그대로 첫 인자로 전달하는 것이 가장 빠른 경로다 (resolve 단계 단축).
28
+ - 구조화 출력이 필요하면 `--json`을 우선 사용한다.
29
+ - 결과를 다음 액션에 넘길 때는 `--quiet`로 ID만 뽑아 스크립팅한다.
30
+ - 이름 기반 조회(멤버/그룹/워크플로우/태그)는 부분일치를 지원하되, 모호하면 에러와 후보 목록이 출력된다 임의 선택하지 말고 사용자에게 확인한다.
31
+ - 파괴적 명령(위키 페이지 삭제, 파일 삭제 등)은 기본적으로 confirm이 있거나 즉시 실행됨이 reference마다 다르니 해당 reference에서 먼저 확인한다.
508
32
 
509
- ```bash
510
- dooray post comment add <project> <number> --body "댓글 내용"
511
- dooray post comment add <project> <number> --body-file ./comment.md
512
- ```
513
-
514
- ### 댓글 목록 필터 (non-interactive)
515
-
516
- ```bash
517
- # 최신 5개
518
- dooray post comment list <project> <number> --latest 5
519
- # 특정 날짜 이후
520
- dooray post comment list <project> <number> --since 2026-04-27
521
- # 작성자 필터
522
- dooray post comment list <project> <number> --from-author 홍길동
523
- # 최신 댓글 1개 빠른 조회
524
- dooray post comment latest <project> <number>
525
- ```
526
-
527
- ---
528
-
529
- ## 그룹 멘션 / cc 시 AI agent 동선
530
-
531
- 자연어 그룹명을 사용자가 지칭했을 때 AI agent 의 의사결정 순서:
532
-
533
- 1. **사용자가 명확한 code 를 줬으면 바로 시도**
534
- ```bash
535
- dooray post create <project> --mention-group "<code>"
536
- ```
537
- 부분일치 가능 (예: "AI-Data" → "AI-Data파트" 매칭).
538
-
539
- 2. **부분일치 모호 / 매칭 실패 시 후보 탐색**
540
- ```bash
541
- dooray project groups <project>
542
- ```
543
- ID + Code 표 출력.
544
- AI agent 가 자연어 의도와 가장 가까운 code 선택 후 재시도.
545
-
546
- 3. **모든 컬럼이 빈값일 때 (response shape 이상) 회피**
547
- - 최근 수정 이후 거의 발생 안 함 (`fetchAllMemberGroups` 가 nested array 정규화)
548
- - 만약 발생 시: 사용자에게 그룹 id (UI 의 그룹 URL 에서 19자리 numeric) 확인 요청
549
- - `--cc-group <id>` / `--mention-group <id>` 직접 입력
550
- - 또는 그룹 멤버를 개별 `--cc <member>` / `--mention <member>` 로 지정
551
-
552
- 4. **모호한 자연어 매핑은 사용자에게 확인**
553
- - 후보가 여러 개일 때 임의 선택 금지 — 사용자에게 선택지 제시
554
- - 예: "AI-Data파트 / AI-Data실험팀 — 어느 그룹인가요?"
555
-
556
- 순서 고정 — 멤버 먼저, 그룹 다음 (기존 정책 유지).
557
-
558
- ## 멘션·링크 자동 삽입 (first-class)
559
-
560
- `post create`, `post edit`, `post comment add`, `post comment edit` 모두 지원:
561
-
562
- - `--mention <name>` (반복) — 이름으로 멤버 resolve 후 dooray:// markdown prepend
563
- - `--mention-group <code>` (반복) — 그룹 코드로 resolve
564
- - `--link-task <project>/<number>` (반복) — 다른 업무 link 를 본문 끝에 append. 19자리 postId 도 가능
565
- - `--dry-run` — API 호출 없이 합성 결과만 stdout. CI / 자동화 검증용
33
+ ## 빠른 시작
566
34
 
567
35
  ```bash
568
- dooray post comment add P 1 --mention 홍길동 --mention-group 개발 --body "..."
569
- # 결과 본문: [@홍길동](dooray://orgId/members/m1 "member") [@P/개발](dooray://orgId/member-groups/g1) ...
570
- ```
571
-
572
- - 이름 부분일치 지원 (모호하면 에러 + 후보 목록 출력)
573
- - 멤버 먼저, 그룹 다음 순서 고정
574
- - interactive (`$EDITOR`) 모드의 `post edit` 는 mention/link-task 무시 + stderr 경고
575
-
576
- ## Dooray 마크다운 링크 형식 (멤버·그룹·업무 멘션)
577
-
578
- 댓글/본문 작성 시 다음 형식으로 마크업하면 Dooray 앱이 인식해 inline 멘션·navigation으로 렌더링한다.
579
- ID는 본인 환경 값으로 채워 사용 — `dooray member get` / `project groups` / `post get` 등으로 조회.
580
-
581
- ### 멤버 멘션
582
- ```markdown
583
- [@본인이름](dooray://{orgId}/members/{memberId} "me")
584
- [@타인이름](dooray://{orgId}/members/{memberId} "member")
585
- ```
586
- - title 속성: 본인은 `"me"`, 타인은 `"member"`
587
- - URL: `dooray://{orgId}/members/{memberId}`
588
-
589
- ### 그룹 멘션 (member-group)
590
- ```markdown
591
- [@projectCode/그룹명](dooray://{orgId}/member-groups/{groupId})
592
- ```
593
- - **`projects/{projectId}/` 경로 포함하지 않음** (직관과 반대 — 흔한 실수)
594
- - title 속성 **없음**
595
- - URL: `dooray://{orgId}/member-groups/{groupId}`
596
-
597
- ### 업무(task) 링크
598
- ```markdown
599
- [projectCode/{number} {subject}](dooray://{orgId}/tasks/{postId} "registered")
600
- ```
601
- - 표시 텍스트: `{project}/{number} {subject}`
602
- - URL: `dooray://{orgId}/tasks/{postId}`
603
- - title: workflow class — `registered` / `working` / `closed` / `backlog`
604
- - 클릭 시 외부 브라우저 안 열고 Dooray 앱 내부 navigation + workflow 상태 표시
605
-
606
- ### 필요 ID 조회 명령
607
-
608
- | ID | 조회 |
609
- |---|---|
610
- | `orgId` | Dooray 앱/웹 URL에서 추출 (`https://{org}.dooray.com/...`의 도메인 + 별도 확인 필요) |
611
- | `memberId` | `dooray member get <id>`, `dooray member search <name>`, `--email <addr>`, `--user-code <code>` 등으로 검색 |
612
- | `groupId` | `dooray project groups <project>` |
613
- | `postId` | `dooray post get <project> <number> --json` 의 `id` 필드 |
614
-
615
- ---
616
-
617
- ## 피드백 (GitHub Issue 등록)
618
-
619
- `dooray feedback` 명령으로 dooray-cli GitHub issue를 직접 등록한다 (`gh` CLI 위임).
620
-
621
- ```bash
622
- # 논인터랙티브 (non-interactive — 에이전트 자동화용)
623
- dooray feedback --title "버그 제목" --body "재현 방법" --label "bug"
624
-
625
- # --last 모드 (직전 에러 자동 첨부 — track-last-run 활성화 필요)
626
- dooray config set track-last-run true
627
- dooray feedback --last --title "에러 제목" --body "추가 설명" --dry-run # 미리보기
628
- dooray feedback --last --title "에러 제목" --body "추가 설명" # 실제 등록
629
- ```
630
-
631
- > **참고**: `--last` 모드는 `trackLastRun: true` (opt-in)가 설정된 경우에만 직전 실패 명령이 자동 기록됨.
632
- > argv는 시크릿 패턴(`--api-key`/`--token`/`Authorization`) 마스킹 후 저장.
633
-
634
- ## 에러 핸들링
635
-
636
- CLI 에러 발생 시 복구 방법:
637
-
638
- | 에러 메시지 | 원인 | 복구 방법 |
639
- |------------|------|-----------|
640
- | `프로젝트를 찾을 수 없습니다: xxx` | 프로젝트 코드/ID 오류 | `dooray project list --search "xxx"` 로 정확한 코드 확인 |
641
- | `복수의 멤버가 매칭됩니다: "김"` | 이름이 모호함 | 에러 메시지의 후보 목록에서 정확한 이름으로 재시도 |
642
- | `멤버를 찾을 수 없습니다: xxx` | 해당 프로젝트에 멤버 없음 | `dooray project members <project>` 로 멤버 목록 확인 |
643
- | `워크플로우를 찾을 수 없습니다: xxx` | 워크플로우 이름 오류 | `dooray project workflows <project>` 로 확인 |
644
- | `API 호출 실패 (401)` | API 키 만료/오류 | `dooray doctor` 로 설정 검증 |
645
-
646
- ---
647
-
648
- ## 정형 task 자동화
649
-
650
- 매주 같은 형식의 task 를 만드는 자동화는 템플릿 + override 패턴이 효율적:
651
-
652
- ```bash
653
- # 매주 월요일 실행되는 cron — "주간 릴리스 체크" 템플릿으로 자동 생성
654
- TODAY=$(date +%Y-%m-%d)
655
- POST_ID=$(dooray post create <project> \
656
- --template "주간 릴리스 체크" \
657
- --title "주간 릴리스 체크 — $TODAY" \
658
- --json | jq -r '.id')
36
+ npm install -g @bifos/dooray-cli
37
+ dooray setup # API endpoint, API key, 메일 설정까지 대화형 진행
38
+ dooray post list <project> --json
659
39
  ```
660
40
 
661
- 템플릿 본문의 `${year}` / `${month}` 등 매크로는 Dooray 가 자동 치환 (`interpolation=true` 기본).
662
- 사용자 정의 변수는 미지원 — 필요 시 client 측 string replace 로 처리.
663
-
664
- ## projectId 직접 입력 시나리오
665
-
666
- AI agent 가 `member=me` 응답에 없는 프로젝트의 업무를 다뤄야 할 때:
667
-
668
- 1. **사용자가 projectId (15+자리 numeric) 를 줬으면 그대로 명령에 사용**:
669
- ```bash
670
- dooray post search 1234567890123456789 "keyword"
671
- ```
41
+ ## 안전한 탐색 순서
672
42
 
673
- 2. **사용자가 코드만 줬고 cache 매칭 실패 (member 아닌 프로젝트)**:
674
- - 에러 메시지의 안내 확인
675
- - 사용자에게 "프로젝트 ID 가 필요합니다 — Dooray UI 의 프로젝트 URL 에서 확인 가능" 요청
676
- - 또는 `dooray project list --type private` 로 private 캐시 갱신 시도
677
-
678
- 3. **권한 없는 projectId 입력 시**: resolver 통과 후 후속 API 4xx 발생 — 에러 메시지에서 권한 부재 확인 후 사용자에게 보고
679
-
680
- 권한 검증이 resolver 단보다 한 단계 지연되는 trade-off — AI 친화적 자동화 우선.
681
-
682
- ## 캐시
683
-
684
- 프로젝트, 멤버, 워크플로우, 위키 정보는 `~/.dooray/cache/`에 캐시된다.
685
- 캐시가 오래된 것 같으면:
686
-
687
- ```bash
688
- dooray cache clear # 전체 캐시 삭제 (다음 실행 시 자동 갱신)
689
- ```
43
+ 1. [common.md](references/common.md)에서 설치·설정·출력 모드를 확인한다.
44
+ 2. 자연어 요청이면 [intent-map.md](references/intent-map.md)에서 커맨드를 찾는다.
45
+ 3. 대상 영역(post/comment/wiki/mention-link/workflow) reference를 읽는다.
46
+ 4. 조회 명령은 `--json`으로 먼저 실행해 구조를 확인한다.
47
+ 5. 쓰기 명령은 대상 id, `--dry-run`(지원 시), confirm 옵션을 명시한다.
48
+ 6. 실패하면 [common.md](references/common.md)의 에러 핸들링 표와 대조한다.