create-eastzoo-nest-app

eastzoo-nest-book 보일러플레이트를 기반으로 새 Nestjs 프로젝트를 손쉽게 생성하는 CLI 도구입니다.

사전 준비물

• node와 npm(또는 pnpm, yarn, bun)이 설치되어 있어야 합니다.
• git이 PATH에 등록되어 있어야 합니다. (git이 없으면 실행이 중단됩니다.)

빠른 시작

npx create-eastzoo-nest-app my-app

• my-app 디렉터리가 없으면 자동으로 생성하고, 내용이 있으면 실행을 중단합니다.
• 템플릿을 shallow clone 한 뒤 기존 git 이력을 제거합니다.
• 사용 가능한 패키지 매니저를 감지하여 의존성을 설치합니다.
• 기본적으로 git 저장소는 초기화하지 않으며, 필요 시 --git 옵션을 추가하여 초기화할 수 있습니다.
• 완료 후 실행 안내(cd my-app 및 <패키지 매니저> run dev)가 출력됩니다.

도움말 (help)

사용법과 옵션을 확인하려면:

npx create-eastzoo-nest-app -h
# 또는
npx create-eastzoo-nest-app --help

인자를 주지 않고 실행해도 도움말이 출력됩니다.

명령행 옵션

npx create-eastzoo-nest-app <target-dir> [options]
npx create-eastzoo-nest-app -h | --help

| 옵션 | 설명 | | ------------------- | ---------------------------------------------------------------------------------------------- | | <target-dir> | 생성할 프로젝트 디렉터리 (필수) | | --branch <branch> | 템플릿 저장소에서 클론할 브랜치를 지정합니다. 기본값은 저장소의 기본 브랜치입니다. | | --repo <url> | 사용할 템플릿 git 저장소 URL (기본값: https://github.com/eastZoo/insystem-nest-template.git) | | --no-install | 의존성 설치를 건너뜁니다. | | --git | 프로젝트에 새 git 저장소를 초기화합니다. | | --no-git | git 초기화를 수행하지 않습니다. (기본 동작) | | -h, --help | 사용법을 출력하고 종료합니다. |

브랜치 지정으로 클론하기

특정 브랜치의 템플릿만 받고 싶다면 --branch 옵션을 사용하세요:

npx create-eastzoo-nest-app my-app --branch main
npx create-eastzoo-nest-app my-app --branch develop

내부 동작 요약

1. 입력 인자를 파싱하여 대상 디렉터리와 옵션을 확정합니다.
2. 대상 디렉터리가 비어 있는지 확인하고, 없으면 생성합니다.
3. 지정한 저장소를 git clone --depth 1으로 복제합니다. 브랜치 옵션이 있으면 해당 브랜치로 복제합니다.
4. 복제된 디렉터리의 .git 폴더를 제거하여 기존 이력을 초기화합니다.
5. --git 옵션이 있을 때만 새 git 저장소를 생성하고 첫 커밋(chore: init from insystem-nest-template)을 만든 뒤 기본 브랜치를 main으로 변경합니다.
6. --no-install 옵션이 없으면 다음 순서로 패키지 매니저를 감지하여 의존성을 설치합니다.
   • 사용자 에이전트 기반: pnpm → yarn → bun → npm
   • 감지 실패 시 시스템 설치 여부 순서: pnpm → yarn → bun → npm
7. 완료 메시지와 다음 단계 실행 안내를 출력합니다.

문제 해결

• git 명령을 찾을 수 없다는 오류가 발생하면 Git이 설치되어 있는지, PATH에 추가되어 있는지 확인하세요.
• 대상 디렉터리에 이미 파일이 있다면 비우거나 다른 경로를 지정해야 합니다.
• 사내 프록시나 방화벽 환경에서는 git clone 및 패키지 설치가 실패할 수 있으니 네트워크 설정을 확인하세요. Package Sidebar Install npm i create-eastzoo-nest-app