@axyl-tcb/create-template

npm create @axyl-tcb/template 명령으로 Axyl TCB Cloud Function 프로젝트를 스캐폴딩하는 CLI 패키지입니다.

사용법

npm create @axyl-tcb/template <project-name>

공개 npm 패키지이므로 별도 레지스트리 설정이나 인증이 필요 없습니다.

실행하면 테스트 파일 포함 여부를 묻습니다.

테스트 파일(예제·테스트·DB 셋업)을 포함하시겠습니까? (Y/n)

| 선택 | 생성 내용 | |---|---| | Y (기본) | 테마별 예제 함수 + 테스트 + DB 셋업 함수(createTables/createCollections) + INVOKE.md 포함 | | N | basic/index.ts 기본 핸들러 + lib + 문서만. 예제·테스트·셋업·INVOKE.md 제외 |

스캐폴딩 후 의존성(npm install)은 자동 설치됩니다.

cd <project-name>
cp .env.example .env   # DB 연결 정보 입력
npm test               # (테스트 포함 시)

비대화형(CI) 또는 명시 지정용 플래그:

npm create @axyl-tcb/template <project-name> -- --tests       # 테스트 포함 강제
npm create @axyl-tcb/template <project-name> -- --no-tests    # 최소 구성
npm create @axyl-tcb/template <project-name> -- --no-install  # 자동 설치 생략

플래그 미지정 + 비대화형 환경에서는 테스트 포함(Y) 이 기본입니다.

TCB 환경 프리셋 (--env-id / --region)

환경 ID·리전을 미리 알고 있으면(tcb env list 로 조회 — cloudbaserc 가 없는 디렉토리에서 실행) 스캐폴딩 시점에 주입할 수 있습니다. 대화형 실행 시 인자가 없으면 질문으로도 받습니다 (모르면 Enter 로 건너뜀 — 기존 동작과 동일):

npm create @axyl-tcb/template <project-name> -- --env-id=<envId> --region=<region>

• cloudbaserc.json 의 envId/region 이 채워집니다 — envId 가 빈 rc 가 있는 프로젝트 안에서는 tcb login 을 포함한 tcb CLI 가 동작하지 않으므로, 프리셋 사용을 권장합니다
• .env 가 자동 생성됩니다 — TCB_ENV_ID/TCB_REGION 과 DB_NAME(규약: DB 이름 = 환경 ID)은 채워지고, 나머지 연결 정보(DB 호스트/계정 등)만 채우면 됩니다
• AI 에이전트 워크플로우: 에이전트가 tcb env list 로 값을 조회해 이 플래그로 전달하면 .env 셋업 질의가 "나머지 연결 정보"로 압축됩니다

생성되는 프로젝트에 대한 안내

스캐폴딩된 프로젝트의 사용법은 생성된 디렉토리 안의 README.md 를 참고하세요.