koda-launcher
v1.0.5
Published
CLI launcher for koda-backend
Readme
koda-launcher (koda)
koda-launcher는 koda-backend를 터미널에서 간편하게 관리하기 위한 전역 CLI 도구입니다. pm2와 pnpm을 기반으로 백엔드 서비스의 설치, 실행, 업데이트, 삭제를 자동화합니다.
🚀 주요 특징
- Cross-Platform 지원: Windows, macOS, Linux 환경에서 동일하게 작동합니다.
- 프로세스 관리:
pm2를 사용하여 백엔드를 백그라운드 서비스로 안정적으로 실행합니다. - 자동 업데이트: 최신 소스코드를 다운로드하면서도 기존의
.env설정 파일을 자동으로 보존합니다. - 간편한 청소: 서비스 운영 중 생성된 출력 파일(
outputs)을 명령어 하나로 정리할 수 있습니다.
📦 설치 방법
먼저 이 패키지를 전역으로 설치합니다:
npm install -g koda-launcher설치가 완료되면 터미널에서 koda 명령어를 사용할 수 있습니다.
🛠 사용법
1. 초기 환경 설정
필요한 전역 의존성(pnpm, pm2)을 설치합니다.
koda setup2. 백엔드 설치
GitHub에서 최신 koda-backend를 다운로드하여 ~/.koda 디렉토리에 설치하고 의존성을 빌드합니다.
koda install3. 서비스 시작 및 정지
pm2를 통해 백엔드 서비스를 관리합니다.
koda start # 서비스 시작 (node main.js 실행)
koda stop # 서비스 중지4. 업데이트
최신 코드로 업데이트합니다. 이때 기존의 .env 파일은 유지됩니다.
koda update5. 데이터 정리
백엔드 작업 결과물이 저장되는 outputs 폴더 내부를 비웁니다.
koda clear6. 완전 삭제
실행 중인 프로세스를 종료하고 설치된 파일(~/.koda)을 모두 제거합니다.
koda uninstall📂 설치 경로
- 백엔드 소스 및 실행 위치:
~/.koda(사용자 홈 디렉토리의.koda폴더) - 출력 파일 위치:
~/.koda/outputs
⚠️ 요구 사항
- Node.js: 18.x 버전 이상 권장
- npm: 의존성 설치 및 전역 링크용
📄 라이선스
ISC License.
