Project documentation structure generator for AI-assisted development
npm install lee-spec-kit
AI 에이전트 기반 개발을 위한 프로젝트 문서 구조 생성 CLI
Quick Start •
주요 기능 •
사용법 •
생성되는 구조
---
- Quick Start
- 주요 기능
- 사용법
- 설정 파일
- 오류 코드
- 생성되는 구조
- Feature 워크플로우
- 문제 해결
- 기여하기
- 라이선스
``bash1. 프로젝트 문서 구조 생성
npx lee-spec-kit init
주요 기능
$3
- 대화형 모드 또는 CLI 옵션으로 프로젝트 설정
- Single(단일 레포) / Multi(멀티 컴포넌트) 프로젝트 타입 지원 (
fullstack는 하위호환 alias)
- 한국어/영어 템플릿 선택$3
- spec.md, plan.md, tasks.md, decisions.md 자동 생성
- Fullstack 프로젝트의 경우 FE/BE 분리 지원
- GitHub Issue/PR 템플릿 연동
$3
- 전체 Feature 진행 상태 한눈에 확인
- 터미널 출력 또는 마크다운 파일로 저장
$3
- Context 기반 워크플로우 현황을 한 번에 확인
- 단일 Feature/전체 Feature 모두 조회 가능
$3
-
context + status + doctor를 한 번에 실행/요약
- 승인/실행 옵션을 그대로 전달해 원자 액션 자동화 가능$3
- docs 구조/설정/Feature 메타데이터를 점검하여 잠재 문제를 빠르게 탐지
-
--json 출력으로 에이전트 파이프라인에 쉽게 연동$3
- 최신 버전 체크 및 템플릿 업데이트 지원
사용법
$3
`bash
대화형 모드
npx lee-spec-kit init옵션 지정
npx lee-spec-kit init --name my-project --type multi
npx lee-spec-kit init --name my-project --type fullstack # alias
`옵션:
| 옵션 | 설명 | 기본값 |
| ------------------- | -------------------------------------------------------------------- | ------------------------- |
|
-n, --name | 프로젝트 이름 | 현재 폴더명 |
| -t, --type | single 또는 multi (fullstack alias 지원) | 대화형 선택 (--yes/--non-interactive면 single) |
| --components | multi 컴포넌트 목록 (쉼표 구분, 예: fe,be,worker) | fe,be |
| -l, --lang | ko (한국어) 또는 en (영어) | en |
| --workflow | 워크플로우 모드: github(issue/PR/review 포함) 또는 local(로컬 중심) | github |
| -d, --dir | 설치 디렉토리 | ./docs |
| --docs-repo | docs 레포 모드 (embedded 또는 standalone) | embedded |
| --project-root | standalone(single) 프로젝트 레포 경로 | - |
| --fe-project-root | standalone(multi) FE 레포 경로 | - |
| --be-project-root | standalone(multi) BE 레포 경로 | - |
| --push-docs | standalone docs 원격 push 사용 (--docs-remote와 함께 사용) | false |
| --docs-remote | standalone docs 원격 URL (--push-docs와 함께 사용) | - |
| -y, --yes | 대화형 입력을 대부분 스킵 (단, 대상 디렉토리가 비어있지 않으면 덮어쓰기 확인은 표시) | - |
| -f, --force | 대상 디렉토리가 비어있지 않아도 확인 없이 덮어쓰기 | false |
| --non-interactive | 사용자 입력이 필요하면 프롬프트 대신 즉시 실패 | false |>
init은 docs 생성 후 Git 초기화/커밋(git init, git add, git commit)을 자동 시도합니다. 환경에 따라 자동 커밋이 생략될 수 있습니다.$3
`bash
Single 프로젝트
npx lee-spec-kit feature user-authMulti 프로젝트
npx lee-spec-kit feature --repo be user-auth
npx lee-spec-kit feature --repo fe user-profile
npx lee-spec-kit feature --component worker queue-jobsFeature ID/설명 지정
npx lee-spec-kit feature payment --id F123 --desc "결제 플로우 개선"
`옵션:
| 옵션 | 설명 | 기본값 |
| ------------------- | -------------------------------------------- | ----------- |
|
-r, --repo | multi 대상 컴포넌트 (하위호환 alias) | 대화형 선택 |
| --component | multi 대상 컴포넌트 | 대화형 선택 |
| --id | Feature ID (F001 형식) | 자동 생성 |
| -d, --desc | spec.md의 목적(설명) 기본 문구 | 빈 문자열 |
| --non-interactive | 사용자 입력이 필요하면 프롬프트 대신 즉시 실패 | false |
| --json | JSON 출력 (featureId, featurePath, component) | false |$3
현재 작업 중인 Feature의 상태와 다음 할 일을 확인합니다. 특히 AI 에이전트가 프로세스를 준수하는 데 유용합니다.
단일 Feature 상세에서는 다음 작업을 항상
A/B/C 옵션으로 표시합니다.`bash
자동 감지 (Git 브랜치 기준)
npx lee-spec-kit context특정 Feature 지정
npx lee-spec-kit context user-authselector 지원: Feature ID / 폴더명
npx lee-spec-kit context F001
npx lee-spec-kit context F001-user-authmulti에서 컴포넌트 지정
npx lee-spec-kit context --repo fe
npx lee-spec-kit context --repo worker전체/완료 Feature 포함
npx lee-spec-kit context --all
npx lee-spec-kit context --done에이전트용 JSON 출력
npx lee-spec-kit context --json라벨 승인 선택 (검증만)
npx lee-spec-kit context F001 --approve A라벨 승인 + 단일 명령 실행
npx lee-spec-kit context F001 --approve "A OK" --execute승인 라벨이 instruction-only면 실패 처리
npx lee-spec-kit context F001 --approve A --execute --execute-strict
`옵션:
| 옵션 | 설명 |
| --------------- | ----------------------------------------------- |
|
--json | 에이전트용 JSON 출력 |
| --repo | multi에서 대상 컴포넌트 지정 (예: fe, be, worker) |
| --all | 자동 감지 실패 시 완료된 Feature까지 포함해서 표시 |
| --done | 완료(workflow-done) Feature만 표시 |
| --approve | 라벨 승인 응답 (A 또는 A OK)으로 단일 옵션 선택 |
| --execute | --approve로 선택한 옵션이 command일 때 1개만 실행 |
| --execute-strict | --execute와 함께 사용 시 instruction-only 옵션이면 실패 |--json 출력에는 다음 액션이 actions 배열로 포함됩니다.-
reasonCode: 상태 이유 코드 (SINGLE_MATCHED, MULTIPLE_ACTIVE_FEATURES 등)
- type: "command": scope(project|docs), cwd, cmd 제공 (복사하여 붙여넣기 가능한 형태로 cd ... && git ... 형태로 출력)
- type: "instruction": 사람이 수행해야 하는 안내 메시지
- actionOptions: label(A, B, C...)과 해당 action 매핑 + summary/approvalPrompt(라벨 설명 템플릿)
- category: 액션 분류 (자동화/반자동용 approval.mode: "category"에서 사용)
- requiresUserCheck: 사용자 확인 필요 여부 (에이전트는 사용자 응답을 <라벨> 또는 <라벨> OK 형식(예: A, A OK)으로 제한하는 것을 권장 / 설정의 approval로 오버라이드 가능)
- workflowPolicy: 현재 완료 조건 정책 (mode, requireIssue, requireBranch, requirePr, requireReview)또한
checkPolicy가 포함되어, 에이전트가 사용자 확인 정책을 적용할 때 참고할 수 있습니다. (docPath, hint, token: "