lee-spec-kit 0.6.2 → 0.6.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.en.md CHANGED
@@ -209,10 +209,30 @@ npx lee-spec-kit context F001 --approve A --execute --execute-strict
209
209
  - `selectionFallback`: fallback used when branch auto-detection does not match (`none` | `open_features` | `all_features` | `done_features`)
210
210
  - `workflowPolicy`: current completion policy (`mode`, `requireIssue`, `requireBranch`, `requirePr`, `requireReview`)
211
211
  - `prePrReviewPolicy`: pre-PR review policy (`enabled`, `skills`, `fallback`, `blockOnFindings`)
212
+ - `requiredDocs`: CLI built-in docs to read before the current action (`id`, `command`)
212
213
  - `checkPolicy`: approval validation policy (`hint`, `policyOnly`, `token: "<LABEL>"`, `acceptedTokens`, `tokenPattern`, `validLabels`, `requireExplanationBeforeApproval`, `requiredExplanationFields`, `contextVersion`, ...)
213
214
 
214
215
  Error payloads (`status: "error"`) include `reasonCode` and labeled `suggestions` (`A/B/C`) (e.g. `INVALID_APPROVAL`, `CONTEXT_STALE`, `EXECUTION_FAILED`, `EXECUTION_NOT_COMMAND`).
215
216
 
217
+ ### Built-in Docs
218
+
219
+ If you do not restore `agents.md` into project docs, fetch CLI-managed guides directly:
220
+ `docs get create-issue|issue-template|create-pr|pr-template --json` also returns `contract` (required sections / artifact rules).
221
+
222
+ ```bash
223
+ # list built-in docs
224
+ npx lee-spec-kit docs list --json
225
+
226
+ # root agent guide
227
+ npx lee-spec-kit docs get agents --json
228
+
229
+ # issue/PR procedure + templates
230
+ npx lee-spec-kit docs get create-issue --json
231
+ npx lee-spec-kit docs get issue-template --json
232
+ npx lee-spec-kit docs get create-pr --json
233
+ npx lee-spec-kit docs get pr-template --json
234
+ ```
235
+
216
236
  ### View
217
237
 
218
238
  ```bash
@@ -266,15 +286,20 @@ npx lee-spec-kit github issue F001 --create --confirm OK --labels enhancement,fr
266
286
  # Generate PR body
267
287
  npx lee-spec-kit github pr F001
268
288
 
289
+ # Generate PR body (force screenshots/Mermaid sections)
290
+ npx lee-spec-kit github pr F001 --screenshots on --mermaid on
291
+
269
292
  # Generate + create PR + sync tasks.md metadata + merge with retry
270
293
  npx lee-spec-kit github pr F001 --create --merge --confirm OK --labels enhancement,frontend
271
294
  ```
272
295
 
273
296
  Key points:
274
297
  - Issue/PR helpers validate required body sections and related docs paths.
298
+ - `--json` output includes both `body` (inline markdown) and `bodyFile` (file path).
275
299
  - Labels are validated (at least one required).
276
300
  - `--create`/`--merge` are remote operations and require `--confirm OK`.
277
301
  - PR helper can sync `tasks.md` PR URL/PR Status automatically (`--no-sync-tasks` to skip).
302
+ - PR artifact sections are controlled by `--screenshots (auto|on|off)` and `--mermaid (auto|on|off)`.
278
303
  - Merge includes retry and automatic head-branch refresh (fetch/rebase/force-push) on out-of-date failures.
279
304
 
280
305
  ### Status
package/README.md CHANGED
@@ -230,11 +230,31 @@ npx lee-spec-kit context F001 --approve A --execute --execute-strict
230
230
  - `requiresUserCheck`: 사용자 확인 필요 여부 (에이전트는 **사용자 응답을 `<라벨>` 또는 `<라벨> OK` 형식(예: `A`, `A OK`)으로 제한**하는 것을 권장 / 설정의 `approval`로 오버라이드 가능)
231
231
  - `workflowPolicy`: 현재 완료 조건 정책 (`mode`, `requireIssue`, `requireBranch`, `requirePr`, `requireReview`)
232
232
  - `prePrReviewPolicy`: pre-PR 리뷰 정책 (`enabled`, `skills`, `fallback`, `blockOnFindings`)
233
+ - `requiredDocs`: 현재 액션 전에 읽어야 할 CLI 내장 문서 목록 (`id`, `command`)
233
234
 
234
235
  또한 `checkPolicy`가 포함되어, 에이전트가 사용자 확인 정책을 적용할 때 참고할 수 있습니다. (`docPath`, `hint`, `policyOnly`, `token: "<LABEL>"`, `acceptedTokens`, `tokenPattern`, `validLabels`, `requireExplanationBeforeApproval`, `requiredExplanationFields`, `contextVersion`, `config`)
235
236
 
236
237
  오류 응답(`status: "error"`)에는 `reasonCode`와 `suggestions`(라벨형 다음 동작: `A/B/C`)가 포함됩니다. (예: `INVALID_APPROVAL`, `CONTEXT_STALE`, `EXECUTION_FAILED`, `EXECUTION_NOT_COMMAND`)
237
238
 
239
+ ### CLI 내장 문서 조회
240
+
241
+ `agents.md`를 프로젝트에 복구하지 않는 환경에서는 아래 명령으로 내장 가이드를 직접 조회할 수 있습니다.
242
+ `docs get create-issue|issue-template|create-pr|pr-template --json` 응답에는 `contract`(필수 섹션/아티팩트 규칙)도 포함됩니다.
243
+
244
+ ```bash
245
+ # 조회 가능한 내장 문서 목록
246
+ npx lee-spec-kit docs list --json
247
+
248
+ # 루트 가이드
249
+ npx lee-spec-kit docs get agents --json
250
+
251
+ # 이슈/PR 절차 + 템플릿
252
+ npx lee-spec-kit docs get create-issue --json
253
+ npx lee-spec-kit docs get issue-template --json
254
+ npx lee-spec-kit docs get create-pr --json
255
+ npx lee-spec-kit docs get pr-template --json
256
+ ```
257
+
238
258
  ### View 대시보드
239
259
 
240
260
  ```bash
@@ -288,15 +308,20 @@ npx lee-spec-kit github issue F001 --create --confirm OK --labels enhancement,fr
288
308
  # PR 본문 생성
289
309
  npx lee-spec-kit github pr F001
290
310
 
311
+ # PR 본문 생성 (스크린샷/Mermaid 섹션 강제 포함)
312
+ npx lee-spec-kit github pr F001 --screenshots on --mermaid on
313
+
291
314
  # PR 본문 생성 + PR 생성 + tasks.md 메타데이터 동기화 + merge 재시도
292
315
  npx lee-spec-kit github pr F001 --create --merge --confirm OK --labels enhancement,frontend
293
316
  ```
294
317
 
295
318
  핵심 동작:
296
319
  - Issue/PR helper는 필수 섹션과 관련 문서 경로를 검증합니다.
320
+ - `--json` 출력에는 `body`(본문 문자열)와 `bodyFile`(파일 경로)가 함께 제공됩니다.
297
321
  - 라벨은 최소 1개 이상 필수입니다.
298
322
  - `--create`/`--merge`는 원격 작업이므로 `--confirm OK`가 필요합니다.
299
323
  - PR helper는 기본적으로 `tasks.md`의 `PR`/`PR Status`를 동기화합니다. (`--no-sync-tasks`로 비활성화)
324
+ - PR helper의 아티팩트 섹션은 `--screenshots (auto|on|off)`, `--mermaid (auto|on|off)`로 제어할 수 있습니다.
300
325
  - merge 시 head 브랜치가 뒤쳐진 경우 fetch/rebase/force-push 후 재시도합니다.
301
326
 
302
327
  ### 상태 확인