본문으로 건너뛰기
튜토리얼 · 3단계 / 6

CLI SDK 설치 & 초기화

CLI SDK 설치 & 초기화

텍스트 중심 가이드입니다 · 예상 소요 3분

입문시작하기3분읽기 약 2분업데이트 2026-04-14

ConnectBase CLI를 설치하고 프로젝트를 초기화하는 방법을 배웁니다.

먼저 완료하면 좋은 튜토리얼이 있어요

이 튜토리얼에서 배울 내용
ConnectBase CLI 설치 (npm)
connectbase init으로 프로젝트 초기화
설정 파일(connectbase.json) 이해
주요 CLI 명령어 사용법

CLI SDK 설치 & 초기화

ConnectBase CLI는 connectbase-client 패키지에 포함된 connectbase 명령어로, 정적 사이트 배포 / Public Key 기반 터널 / MCP 설정 / 문서 동기화 등을 처리합니다. 계정 로그인 방식이 아니라 Public Key + Secret Key 기반 으로 인증합니다.

1. 설치 또는 npx 실행

Node.js 18 이상이 필요합니다.

bash
# 글로벌 설치 (선택)
npm install -g connectbase-client

# 또는 설치 없이 바로 실행
npx connectbase --version

💡 패키지 이름은 connectbase-client 이지만 노출되는 바이너리는 connectbase (또는 connectbase-client) 둘 다 사용 가능합니다.

2. 프로젝트 초기화하기

프로젝트 폴더에서 init 을 실행하면 콘솔에서 발급한 Public Key 와 Web Storage ID 를 입력받아 .connectbaserc 파일을 생성합니다.

bash
cd my-app
npx connectbase init

대화형 프롬프트에서:

  1. Public Key (cb_pk_...) 입력 — 콘솔 → 앱 설정 → Public Keys
  2. Web Storage ID 입력 — 콘솔 → 스토리지 → 웹 스토리지 페이지의 ID
  3. (선택) Secret Key (cb_sk_...) — 터널 / private 작업에 필요

3. 설정 파일 이해하기

.connectbaserc (JSON 텍스트, 프로젝트 루트):

json
{
  "publicKey": "cb_pk_xxxxxxxxxxxx",
  "secretKey": "cb_sk_xxxxxxxxxxxx",
  "storageId": "stg_xxxxxxxxxxxx",
  "deployDir": "dist"
}
필드설명
publicKey앱별 Public Key (필수, deploy/docs 용)
secretKey사용자 Secret Key (선택, tunnel 등 인증 필요한 명령)
storageId배포 대상 웹 스토리지 ID (deploy 필수)
deployDir기본 배포 디렉터리 (인자로 override 가능)

📌 .connectbaserc 는 .gitignore 에 추가해 키 노출을 막으세요.

4. 클라이언트 SDK 설치하기

브라우저에서 사용할 connectbase-client 를 dependencies 로 설치합니다.

bash
npm install connectbase-client
typescript
import ConnectBase from 'connectbase-client'

const cb = new ConnectBase({
  appId: 'your-app-id',
  publicKey: 'cb_pk_...',  // 환경 변수 사용 권장
})

5. 주요 CLI 명령어

명령어설명
connectbase init프로젝트 초기화 (.connectbaserc 생성)
connectbase deploy [dir]웹 스토리지에 정적 사이트 배포
connectbase deploy --dev [dir]dev 배포 (별도 URL)
connectbase tunnel <port>로컬 포트를 인터넷에 노출 (Secret Key 필요)
connectbase updateCLAUDE.md / MCP 설정 / 문서 동기화
connectbase docs최신 사용자용 문서를 .connectbase/docs/ 로 다운로드
connectbase mcpClaude Desktop / Cursor 등의 MCP 설정 추가
connectbase --help전체 옵션 보기

💡 login / logs / env 같은 명령은 CLI 에 없습니다. 함수 로그 / 환경 변수 / 사용량 확인은 콘솔 에서 처리합니다.

다음 단계

이 튜토리얼이 도움이 됐나요?