CLI Overview
Meerkit CLI의 명령 목록과 공통으로 알아 둘 것입니다.
Meerkit CLI(@snackcup/meerkit)는 프로젝트를 만들고, 세팅하고, 켜고, 점검하는 일을 명령어 하나씩으로 처리합니다. 설치할 필요 없이 npx로 바로 실행합니다.
bash
npx @snackcup/meerkit <명령> [옵션]
npx @snackcup/meerkit --help # 전체 명령 목록
npx @snackcup/meerkit <명령> --help # 그 명령의 자세한 사용법새 프로젝트는
npx create-meerkit my-app으로 만들 수도 있습니다. npx @snackcup/meerkit init my-app과 같은 명령입니다.명령 한눈에 보기
| 명령 | 하는 일 | 설명 페이지 |
|---|---|---|
init | 새 프로젝트를 만듭니다 | 시작하기 |
setup | 환경 점검, 설치, DB, 관리자 계정까지 한 번에 세팅하고 서버를 켭니다 | 시작하기 |
start | 세팅이 끝난 프로젝트의 서버만 켭니다 | 서버 |
stop | 이 프로젝트의 서버를 끕니다 | 서버 |
open | 브라우저로 화면이나 API 문서를 엽니다 | 서버 |
status | DB, 서버, 마이그레이션 상태를 한눈에 봅니다 | 점검 |
check | Node, npm, uv, Docker와 디스크 여유 공간을 점검합니다 | 점검 |
env check | backend/.env 설정을 점검합니다 | 점검 |
logs | setup 로그를 보여 줍니다 | 점검 |
db | 마이그레이션, 관리자 계정, DB 초기화 | 데이터베이스 |
add feature | 새 기능 뼈대를 만듭니다 | 개발 |
test | 백엔드와 프론트엔드 확인을 한 번에 돌립니다 | 개발 |
update | 새 킷 버전의 변경을 내 프로젝트로 가져옵니다 | 개발 |
공통으로 알아 둘 것
- 프로젝트 폴더 안에서 실행합니다. 다른 폴더의 프로젝트를 다룰 때는
--dir <폴더>를 붙입니다(setup,start,stop,status,db,update에서 쓸 수 있습니다). - 다시 실행해도 안전합니다.
setup은 끝난 단계를 건너뜁니다. - 비밀 값은 출력하지 않습니다. 로그와 점검 결과에 비밀번호나 키를 남기지 않습니다.
- 필요한 도구: Node.js 20 이상, uv, 실행 중인 Docker Desktop, 디스크 여유 공간 2GB 이상.
npx @snackcup/meerkit check로 한 번에 확인할 수 있습니다. - Windows:
stop은 아직 지원하지 않습니다. 서버를 띄운 터미널에서Ctrl+C를 누르세요.