CLI 온보딩 가이드

설치 단계와 이 플러그인의 전체 마크다운 가이드를 포함한 설정 프롬프트를 복사하세요.

빠른 개요

Capgo CLI는 Capacitor 앱에 대한 실시간 업데이트를 설정하기 위한 인터랙티브 온보딩을 제공합니다. 다음을 수행하실 것입니다:

✅ Capgo에 앱을 등록합니다.
🔌 업데이터 플러그인을 설치하고 구성합니다.
🚀 첫 번째 실시간 업데이트 배포
📱 장치에서 업데이트 테스트

예상 시간: 10-20분 (인터넷 속도 및 빌드 시간에 따라 다름)

온보딩 시작

API 키와 함께 온보딩 명령을 실행하세요:

npx @capgo/cli@latest init [APIKEY]

__CAPGO_KEEP_0__의 welcomes 메시지를 보실 수 있습니다.

Capgo onboarding 🛫

온보딩 중 발생하는 일

CLI는 13개의 인터랙티브 스텝을 통해 여러분을 안내하겠습니다.

설정 단계 (1-6 단계):

개발 환경을 확인하세요 (Xcode/Android Studio)
Capgo에 앱을 추가하고 프로덕션 채널을 생성하세요.
__CAPGO_KEEP_0__를 설치하세요. @capgo/capacitor-updater __CAPGO_KEEP_0__ 플러그인을 설치하세요.
code를 앱에 주입하세요.
선택적으로 앱에서 끝까지의 암호화 기능을 활성화하세요.
iOS 또는 Android 플랫폼을 선택하세요.

테스트 단계 (7-12 단계):

앱을 빌드하고 디바이스/에뮬레이터에서 실행하세요.
code에 자동 또는 수동으로 변경된 code를 확인하세요.
Capgo에 업데이트된 배포본을 업로드하세요.
실시간으로 디바이스에서 변경된 내용을 확인하세요.

완료 (13 단계):

실시간 업데이트 준비 완료! 🎉

13 단계 온보딩 프로세스

1 단계: 사전 조건 확인

CLI 환경이 설치되어 있는지 확인합니다.

What’s checked:

Xcode (macOS only) - iOS 개발을 위해
Android SDK - Android 개발을 위해

Possible outcomes:

✅ Both environments found:

✅ Xcode detected - iOS development ready
✅ Android SDK detected - Android development ready

⚠️ No environment found:

⚠️ Xcode not found
⚠️ Android SDK not found
❌ No development environment detected

📱 To develop mobile apps with Capacitor, you need:
   • For iOS: Xcode (macOS only) - https://developer.apple.com/xcode/
   • For Android: Android Studio - https://developer.android.com/studio

__CAPGO_KEEP_0__에 대한 질문이 있을 수 있습니다.

2단계: 앱 추가

CLI은 Capgo에 로그인하고 앱을 계정에 추가합니다.

(spinner) Running: npm @capgo/cli@latest login ***
Login Done ✅

❓ Add {appId} in Capgo?

앱 ID가 이미 사용 중인 경우:

CLI은 대안을 제안합니다.

❌ App ID "com.example.app" is already taken
💡 Here are some suggestions:
   1. com.example.app2
   2. com.example.app3
   3. com.example.app.new
   4. com.example.app.app

❓ What would you like to do?

대안을 선택하거나 사용자 지정 앱 ID를 입력할 수 있습니다.

Step 3: Production 채널 만들기

채널은 앱의 업데이트를 관리하는 데 도움이 됩니다.

❓ Create default channel production for {appId} in Capgo?

If you select Yes:

(spinner) Running: npm @capgo/cli@latest channel add production {appId} --default
Channel add Done ✅  (or "Channel already added ✅")

A production channel will be created and set as default. This is the recommended option for most users.

If you select No:

If you change your mind, run it for yourself with: "npm @capgo/cli@latest channel add production {appId} --default"

You’ll need to create and configure channels manually later. Alternatively, you can:

채널을 설정하는 capacitor.config.ts 파일
JavaScript setChannel() 방법을 사용하여 동적으로 채널을 설정
Capgo 웹 콘솔에서 채널을 나중에 구성

4단계: 업데이터 플러그인 설치

CLI 버전과 호환되는 플러그인을 CLI가 설치할 것입니다. @capgo/capacitor-updater plugin compatible with your Capacitor version.

❓ Automatic Install "@capgo/capacitor-updater" dependency in {appId}?

__CAPGO_KEEP_0__ 5

Capacitor 5v5 @capgo/capacitor-updater __CAPGO_KEEP_0__ 6
Capacitor 6v6 @capgo/capacitor-updater __CAPGO_KEEP_0__ 7
Capacitor 7: 설치합니다. @capgo/capacitor-updater v7
Capacitor 8+: 최신 버전을 설치합니다.

즉시 업데이트 옵션:

설치 후, 다음과 같은 질문이 나옵니다:

❓ Do you want to set instant updates in {appId}?
   Read more: https://capgo.app/docs/live-updates/update-behavior/#applying-updates-immediately

Yes를 선택하면:

앱이 배경화면과 다시 열릴 때 즉시 업데이트를 적용하도록 업데이트가 구성됩니다.
autoUpdate: 'always' 그리고 autoSplashscreen: true config에 추가됩니다.
Your capacitor.config.ts 자동으로 업데이트됩니다.
Delta updates 자동으로 활성화됩니다 - 이 경우 업데이트는 전체 배ंडल 대신 업데이트 간에 변경된 파일만 전송하여 업데이트가 훨씬 빠르게 수행됩니다.

No를 선택하면:

업데이트는 표준 동작을 사용합니다 (배경에서 다운로드, 다음 재시작 시 적용)
__CAPGO_KEEP_0__를 나중에 수정하여 항상 즉시 업데이트 기능을 활성화할 수 있습니다. capacitor.config.ts

Step 5: Code 통합 추가하기

CLI는 자동으로 필요한 code를 메인 애플리케이션 파일에 주입합니다.

❓ Automatic Add "CapacitorUpdater.notifyAppReady()" code and import in {appId}?

추가되는 내용:

import { CapacitorUpdater } from '@capgo/capacitor-updater'

CapacitorUpdater.notifyAppReady()

프로젝트 유형 감지:

Nuxt.js: 생성 plugins/capacitorUpdater.client.ts
기타 프레임워크: 메인 진입 파일에 추가

자동 주입이 실패하면 code을 직접 메인 애플리케이션 파일에 추가할 수 있습니다.

Nuxt.js의 경우: 생성 plugins/capacitorUpdater.client.ts:

import { CapacitorUpdater } from '@capgo/capacitor-updater'

export default defineNuxtPlugin(() => {
  CapacitorUpdater.notifyAppReady()
})

다른 프레임워크의 경우: 메인 진입점 파일 (예: main.ts, index.js, App.tsx):

import { CapacitorUpdater } from '@capgo/capacitor-updater'

CapacitorUpdater.notifyAppReady()

이 code을 임포트 후 앱 초기화 전에 추가하세요. 자세한 내용은 App 추가 가이드를 참조하세요. Add an App guide.

6단계: 암호화 설정 (선택사항)

업데이트에 대한 끝에서 끝까지의 암호화는 추가적인 보안层를 제공합니다.

🔐 End-to-end encryption
   ✅ Use this for: Banking, healthcare, or apps with legal encryption requirements
   ⚠️  Note: Makes debugging harder - skip if you don't need it

❓ Enable end-to-end encryption for {appId} updates?

암호화를 활성화하면 CLI가 다음을 수행합니다.

암호화 키를 생성합니다.
Capacitor 구성 동기화를 제안합니다.

7단계: 플랫폼 선택

__CAPGO_KEEP_0__을 선택하여 온보딩 중에 테스트할 플랫폼을 선택하세요.

📱 Platform selection for onboarding
   This is just for testing during onboarding - your app will work on all platforms

❓ Which platform do you want to test with during this onboarding?
   Options:
   - iOS
   - Android

8단계: 프로젝트 만들기

CLI은 앱을 빌드하고 Capacitor과 동기화합니다.

❓ Automatic build {appId} with "npm run build"?

__CAPGO_KEEP_4__

__CAPGO_KEEP_5__
__CAPGO_KEEP_6__
Executes npx cap sync {platform}

If build script is missing:

이 빌드 스크립트가 없으면: package.json.

9. 기기에서 실행하기

기기나 시뮬레이터에서 앱의 초기 버전을 테스트하세요.

❓ Run {appId} on {PLATFORM} device now to test the initial version?

이 경우: Yes:

(spinner) Running: npx cap run {platform}
(device picker appears)
App started ✅
📱 Your app should now be running on your {platform} device with Capgo integrated
🔄 This is your baseline version - we'll create an update next

10. 테스트 변경 사항 만들기

Capgo의 업데이트 시스템을 테스트하기 위해 Capgo의 변경 사항을 표시할 수 있는 변경을 만들 시간입니다.

🎯 Now let's test Capgo by making a visible change and deploying an update!

❓ How would you like to test the update?
   Options:
   - Auto: Let Capgo CLI make a visible change for you
   - Manual: I'll make changes myself

자동 모드: CLI는 자동으로 파일을 수정하여 표시할 수 있는 테스트 배너를 추가하거나 변경합니다.

수동 모드: 자신이 변경 사항을 만들 수 있습니다(예: 텍스트, 색상, 또는 요소를 추가).

버전 관리:

❓ How do you want to handle the version for this update?
   Options:
   - Auto: Bump patch version ({currentVersion} → {nextVersion})
   - Manual: I'll provide the version number

변경 사항으로 빌드:

❓ Build {appId} with changes before uploading?

11 번째 단계: 업로드 배ंडल

업데이트된 앱 배ंडल을 Capgo에 업로드하세요.

❓ Upload the updated {appId} bundle (v{version}) to Capgo?

CLI이 실행됩니다.

npx @capgo/cli@latest bundle upload

Delta 업데이트 알림 (즉시 적용 모드가 활성화된 경우):

💡 Instant updates are enabled in your config
   Delta updates send only changed files instead of the full bundle

❓ Enable delta updates for this upload? (Recommended with instant updates)

성공:

✅ Update v{version} uploaded successfully!
🎉 Your updated bundle is now available on Capgo

12 단계: 장치에서 업데이트 테스트

업데이트를 실제로 확인해 보세요!

🧪 Time to test the Capgo update system!
📱 Go to your device where the app is running

즉시 업데이트:

🔄 IMPORTANT: Background your app (swipe up/press home button) and then reopen it
⏱️  The update should be downloaded and applied automatically

표준 업데이트:

📱 With standard updates, you will need to:
   1. Background the app (swipe up/press home button) to start download
   2. Wait a few seconds for download to complete
   3. Background and foreground again to see the update

로그 모니터링:

❓ Monitor Capgo logs to verify the update worked?

업데이트 프로세스를 확인하기 위해 Yes, 장치에서 실시간 로그를 볼 수 있습니다.

13 단계: 완료

Welcome onboard ✈️!

축하합니다! Capgo 라이브 업데이트를 위한 설정이 성공적으로 완료되었습니다.

완료한 내용

온보딩을 완료한 후에 다음과 같은 내용이 있습니다:

✅ 앱 등록

Capgo에 앱이 프로덕션 채널로 등록되었습니다.

✅ 플러그인 설치

Capacitor 업데이터 플러그인이 설치 및 설정되었습니다.

✅ Code 통합

code 통합이 앱에 추가되었습니다.

✅ 업데이트 테스트 완료

배포와 라이브 업데이트 수신에 성공했습니다

일일 워크플로우

다음 업데이트를 위해 사용하세요:

npm run build
npx @capgo/cli@latest bundle upload --channel=production

다른 배포 옵션을 보려면 라이브 업데이트 배포.

온보딩 다시 시작

온보딩 프로세스를 종료한 경우 언제든 다시 시작할 수 있습니다:

npx @capgo/cli@latest init [APIKEY]

보실 수 있습니다.

You have already got to the step {stepNumber}/13 in the previous session
❓ Would you like to continue from where you left off?

문제 해결

개발 환경이 없습니다.

문제: iOS와 Android SDK의 설치 여부를 확인하지 못했습니다.

해결 방법:

iOS용: 설치 Xcode (macOS만 지원)
Android용: 설치 Android Studio

앱 ID가 이미 사용 중입니다.

문제: 앱 ID는 이미 등록되어 있습니다.

해결 방법: 제안된 대안 중 하나를 선택하거나 역 도메인 표기법으로 사용자 지정 앱 ID를 입력하세요.

빌드 스크립트 누락

문제: 빌드 스크립트가 없습니다. package.json.

해결 방법: 빌드 스크립트를 추가하세요. package.json:

{
  "scripts": {
    "build": "your-build-command"
  }
}

자동 주입 실패

문제: CLI은 자동으로 통합 code을 삽입할 수 없습니다.

해결: code을 주 프로그램 파일에 수동으로 추가하세요:

import { CapacitorUpdater } from '@capgo/capacitor-updater'

CapacitorUpdater.notifyAppReady()

Capacitor 버전이 너무旧합니다.

문제: 당신의 Capacitor 버전은 v5 미만입니다.

해결: Capacitor을 v5 이상으로 업그레이드하세요:

다음 단계

온보딩을 완료한 후에는 이러한 주제를 탐색하세요:

한 번만 설정하는 체크리스트

채널, CI, 델타 업로드를 한 번만 설정하여 장기적인 안정성을 보장하세요

__CAPGO_KEEP_0__ 대시보드에서 업데이트를 배포하는 방법을 학습하세요

Learn how to deploy updates from the Capgo dashboard

OTA 업데이트의 모든 유형 참조: 적용 시간, 지연 조건, 버전 차단, 전달

CI/CD 통합

CI/CD Integration

CI/CD를 통해 업데이트 배포를 자동화하세요.

채널

다중 업데이트 스트림을 관리하는 채널을 사용하세요.

암호화

업데이트를 암호화하여 끝에서 끝까지 안전하게 보호하세요.

업데이트 동작

업데이트가 적용되는 시점과 방법을 커스터마이즈하세요 (직접, 델타 등).

도움말

온보딩 중 문제가 발생하는 경우:

Check the 트러블 슈팅 가이드
__CAPGO_KEEP_0__를 위한 디스코드 커뮤니티
FAQ를 리뷰
지원 지원

CLI 온보딩 가이드에서 계속

__CAPGO_KEEP_0__ 온보딩 가이드를 사용하여 CLI 온보딩 가이드를 사용하여 대시보드와 CLI를 계획하고 운영할 경우 API를 API와 연결합니다. API를 API와 연결합니다. API 개요에 대한 구현 세부 사항에 대해 소개 __CAPGO_KEEP_0__ 키에 대한 구현 세부 사항에 대해 API 키 API 키에 대한 구현 세부 사항에 대해 장치 __CAPGO_KEEP_0__에 대한 구현 세부 사항에 대해 __CAPGO_KEEP_0__ __CAPGO_KEEP_0__에 대한 구현 세부 사항에 대해