CLI Panduan Pendaftaran

Ringkasan Cepat

Capgo CLI menyediakan pengalaman onboarding interaktif yang mengatur pembaruan hidup untuk aplikasi Capacitor Anda. Anda akan:

1. ✅ Mendaftarkan aplikasi di Capgo
2. 🔌 Menginstal dan mengonfigurasi plugin pembaruan
3. 🚀 Mengembangkan pembaruan hidup pertama
4. 📱 Menguji pembaruan di perangkat Anda

Waktu perkiraan: 10-20 menit (berdasarkan kecepatan internet dan waktu pembangunan)

Tip

Pengalaman onboarding dapat dihentikan dan dilanjutkan kapan saja.

Mulai Pengalaman Onboarding

Jalankan perintah onboarding dengan kunci API Anda:

npx @capgo/cli@latest init [APIKEY]

Anda akan melihat pesan selamat datang:

Capgo onboarding 🛫

Apa yang Terjadi Selama Pengalaman Onboarding

Kunci CLI akan memandu Anda melalui 13 langkah interaktif:

Fase Pengaturan (Langkah 1-6):

• Periksa lingkungan pengembangan Anda (Xcode/Android Studio)
• Tambahkan aplikasi ke Capgo dan buat saluran produksi
• Pasang @capgo/capacitor-updater plugin
• Injectkan code yang diperlukan ke dalam aplikasi Anda
• Opsional: Aktifkan enkripsi akhir-ke-akhir
• Pilih platform untuk pengujian (iOS atau Android)

Fase Pengujian (Langkah 7-12):

• Buat aplikasi dan jalankan pada perangkat/simulator
• Buat perubahan code yang dapat dilihat (otomatis atau manual)
• Unggah bundle yang diperbarui ke Capgo
• Lihat pembaruan live muncul pada perangkat Anda secara real-time

(Langkah 13):

• Aplikasi Anda siap untuk pembaruan live! 🎉

Proses Pendaftaran Langkah 13

Langkah 1: Periksa Persyaratan

The CLI checks your development environment to ensure you have the necessary tools installed.

Apa yang diperiksa:

• Xcode (hanya macOS) - untuk pengembangan iOS
• Android SDK - untuk pengembangan Android

Possible outcomes:

✅ Ditemukan kedua lingkungan:

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

⚠️ Tidak ditemukan lingkungan:

⚠️ 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

Pertanyaan yang mungkin Anda ajukan:

Peringatan

Jika tidak ditemukan lingkungan pengembangan, Anda akan diminta untuk melanjutkan. Disarankan untuk menginstal setidaknya satu platform sebelum melanjutkan.

Langkah 2: Tambahkan Aplikasi Anda

The CLI akan mengautentikasi Anda ke Capgo dan menambahkan aplikasi Anda ke akun Anda.

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

❓ Add {appId} in Capgo?

Jika ID aplikasi Anda sudah digunakan:

The CLI akan menyarankan alternatif:

❌ 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?

Anda dapat memilih alternatif atau memasukkan ID aplikasi kustom.

Peringatan

ID aplikasi harus mengikuti notasi domain terbalik (misalnya com.example.myapp)

Langkah 3: Buat Saluran Produksi

Saluran memungkinkan Anda mengelola aliran pembaruan yang berbeda untuk aplikasi Anda.

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

Tip

Jangan khawatir! Ini hanya untuk pengujian lokal selama proses onboarding. Membuat saluran 'produksi' tidak berarti update Anda akan langsung dipublikasikan kepada pelanggan. Anda memiliki kendali penuh atas kapan update diterapkan. Pilih Ya kecuali Anda memiliki persyaratan saluran khusus.

Jika Anda memilih Ya:

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

Saluran produksi akan dibuat dan ditetapkan sebagai default. Ini adalah pilihan yang disarankan untuk pengguna kebanyakan.

Jika Anda memilih Tidak:

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

Anda perlu membuat dan mengonfigurasi saluran secara manual kemudian.

• Atau, Anda bisa: capacitor.config.ts Atur saluran di file Anda
• Gunakan metode JavaScript untuk mengatur saluran secara dinamis setChannel() Konfigurasi saluran kemudian dari konsol web __CAPGO_KEEP_0__
• Configure channels later from the Capgo web console

Judul bagian “Langkah 4: Pasang Plugin Pembarui”

The CLI will install the @capgo/capacitor-updater plugin compatible with your Capacitor version.

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

Kemampuan versi:

• Capacitor 5: Menginstal @capgo/capacitor-updater v5
• Capacitor 6: Menginstal @capgo/capacitor-updater v6
• Capacitor 7: Menginstal @capgo/capacitor-updater v7
• Capacitor 8+: Menginstal versi terbaru

Peringatan

Capgo hanya mendukung Capacitor v5 dan di atasnya. Jika Anda menggunakan versi yang lebih tua, Anda perlu mengupgrade terlebih dahulu.

Pilihan pembaruan instan:

Setelah instalasi, Anda akan diminta:

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

Trik

Apa itu pembaruan instan? Dengan pembaruan instan diaktifkan, aplikasi Anda akan menerapkan pembaruan secara langsung ketika di background dan dibuka kembali. Hal ini berjalan dengan lancar karena Capgo dapat mendistribusikan pembaruan di seluruh dunia dalam waktu kurang dari 300ms. Tanpa itu (mode standar), pembaruan diunduh di latar belakang dan diterapkan pada restart aplikasi berikutnya. Pembaruan instan sangat baik untuk iterasi yang lebih cepat selama pengembangan dan perbaikan bug yang kritikal di produksi.

Jika Anda memilih Ya:

• Pembaruan akan dikonfigurasi untuk diterapkan secara langsung ketika aplikasi di background dan dibuka kembali
• autoUpdate: 'always' dan autoSplashscreen: true akan ditambahkan ke konfigurasi Anda
• Anda capacitor.config.ts akan diperbarui secara otomatis
• Pembaruan Delta akan diaktifkan secara otomatis - ini mengirim hanya file yang berubah antara pembaruan daripada bundle penuh, membuat pembaruan jauh lebih cepat

Jika Anda memilih Tidak:

• Pembaruan akan menggunakan perilaku standar (download di latar belakang, aplikasikan pada restart berikutnya)
• Anda selalu dapat mengaktifkan pembaruan instan kemudian dengan mengubah konfigurasi Anda capacitor.config.ts

Langkah 5: Tambahkan Integrasi Code

The CLI akan secara otomatis menginjeksi code yang diperlukan ke dalam file aplikasi utama Anda.

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

Apa yang ditambahkan:

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

CapacitorUpdater.notifyAppReady()

Deteksi jenis proyek:

• Nuxt.js: Membuat plugins/capacitorUpdater.client.ts
• Lain-lain framework: Menambahkan ke file entry utama Anda

Tips

Jika auto-injeksi gagal, Anda dapat menambahkan code secara manual ke file aplikasi utama Anda:

Untuk Nuxt.js: Membuat plugins/capacitorUpdater.client.ts:

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

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

Untuk kerangka kerja lainnya: Tambahkan ke file utama entri Anda (misalnya main.ts, index.js, App.tsx):

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

CapacitorUpdater.notifyAppReady()

Tempatkan ini code setelah import Anda dan sebelum inisialisasi aplikasi Anda. Untuk detail lebih lanjut, lihat panduan Tambahkan Aplikasi.

Langkah 6: Konfigurasi Enkripsi (Opsional)

Enkripsi end-to-end menambahkan lapisan keamanan tambahan untuk pembaruan Anda.

🔐 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?

Catatan

Enkripsi hanya tersedia untuk Capacitor v6 dan di atas.

Jika Anda mengaktifkan enkripsi, CLI akan:

1. Menghasilkan kunci enkripsi
2. Menawarkan untuk sinkronisasi konfigurasi Capacitor

Langkah 7: Pilih Platform

Memilih platform mana yang akan digunakan selama proses onboarding.

📱 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

Tips

Hal ini hanya mempengaruhi proses onboarding. Aplikasi akhir Anda akan mendukung semua platform.

Langkah 8: Bangun Projek Anda

CLI akan membangun aplikasi Anda dan sinkronkan dengan Capacitor.

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

Apa yang terjadi:

1. Mendeteksi jenis projek Anda
2. Menjalankan skrip build Anda
3. Menggunakan npx cap sync {platform}

Jika skrip build hilang:

Anda akan diminta apakah ingin melewatkan build atau menambahkan skrip build ke projek Anda package.json.

Langkah 9: Jalankan di Perangkat

Uji coba versi awal aplikasi Anda di perangkat atau simulator.

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

Jika Anda memilih Ya:

(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

Langkah 10: Buat Perubahan Uji Coba

Sekarang saatnya untuk menguji sistem pembaruan Capgo dengan membuat perubahan yang dapat dilihat.

🎯 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

Mode otomatis: CLI akan secara otomatis memodifikasi file Anda untuk menambahkan banner tes yang dapat dilihat atau perubahan.

Mode manual: Andai Anda ingin membuat perubahan sendiri (misalnya, mengubah teks, warna, atau menambahkan elemen).

Pengelolaan Versi:

❓ 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

Buat dengan perubahan:

❓ Build {appId} with changes before uploading?

Tips

Jika Anda perlu membuat secara manual di terminal lain, pilih “Tidak” dan buat sendiri, kemudian lanjutkan.

Langkah 11: Unggah Bundle

Unggah aplikasi bundle yang diperbarui ke Capgo.

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

The CLI menjalankan:

npx @capgo/cli@latest bundle upload

Tips

Pembaruan delta dengan pembaruan instan: Jika Anda mengaktifkan pembaruan instan di Langkah 4, CLI akan secara otomatis bertanya apakah Anda ingin mengaktifkan pembaruan delta. Pembaruan delta mengirimkan hanya file yang berubah antara versi daripada bundle seluruhnya. Karena biasanya hanya beberapa file yang berubah antara pembaruan, ini membuat download menjadi lebih cepat. Pilih Ya untuk pengalaman terbaik dengan pembaruan instan.

Pesan pembaruan delta (jika mode aplikasi instan diaktifkan):

💡 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)

Peringatan

Untuk repositori monorepo, Anda mungkin perlu memberikan jalur tambahan ke package.json dan node_modules.

Sukses:

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

Langkah 12: Tes Perbaruan di Perangkat

Sekarang saatnya melihat perbaruan beraksi!

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

Untuk perbaruan instan:

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

Untuk perbaruan standar:

📱 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 log:

❓ Monitor Capgo logs to verify the update worked?

Jika Anda memilih Ya, Anda akan melihat log hidup dari perangkat Anda yang menampilkan proses pembaruan.

Langkah 13: Penyelesaian

Welcome onboard ✈️!

Selamat! Anda telah berhasil mengatur pembaruan hidup Capgo untuk aplikasi Anda.

Apa yang Anda Capai

After mengikuti proses onboard, Anda memiliki:

✅ Aplikasi Terdaftar

Aplikasi Anda telah terdaftar di Capgo dengan saluran produksi

✅ Plugin Terpasang

Plugin Pembaruan Capacitor telah terpasang dan dikonfigurasi

✅ Code Terintegrasi

Pengintegrasian code telah ditambahkan ke aplikasi Anda

✅ Pembaruan Dites

Anda telah berhasil mengirim dan menerima pembaruan hidup

Alur Harian

Untuk pembaruan berikutnya, gunakan:

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

Untuk pilihan pengembangan lainnya, lihat Tinggalkan Pembaruan Langsung.

Mengulangi Proses Pengenalan

Jika Anda keluar dari proses pengenalan, Anda bisa melanjutkan kapan saja:

npx @capgo/cli@latest init [APIKEY]

Anda akan melihat:

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

Tips

Progress disimpan secara lokal, sehingga Anda dapat aman keluar dan melanjutkan proses onboarding.

Pengaturan Masalah

Tidak Ada Lingkungan Pengembangan

Masalah: Tidak terdeteksi Xcode maupun Android SDK.

Solusi:

• Untuk iOS: Pasang Xcode (macOS hanya)
• Untuk Android : Pasang Studio Android

ID Aplikasi Sudah Terpakai

Masalah: ID aplikasi Anda sudah terdaftar.

Solusi: Pilih salah satu alternatif yang disarankan atau masukkan ID aplikasi kustom dalam notasi domain yang dibalik.

Skrip Pembangunan Hilang

Masalah: Tidak ditemukan skrip pembangunan di package.json.

Solusi: Tambahkan skrip pembangunan ke package.json:

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

Gagal Auto-Injeksi

Masalah: CLI tidak dapat secara otomatis menginjeksi integrasi code.

Solusi: Tambahkan code secara manual ke file utama:

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

CapacitorUpdater.notifyAppReady()

Versi Capacitor Terlalu Tua

Masalah: Versi Capacitor Anda di bawah v5.

Solusi: Upgrade Capacitor ke v5 atau lebih tinggi:

• Mengupgrade ke Capacitor 5
• Mengupgrade ke Capacitor 6
• Mengupgrade ke Capacitor 7

Langkah-Langkah Selanjutnya

Sekarang Anda telah menyelesaikan proses onboard, eksplorasi topik-topik ini:

Deploy Updates

Belajar cara mengdeploy pembaruan dari dashboard Capgo

Update Types

Referensi semua jenis pembaruan OTA: waktu aplikasi, kondisi penundaan, pemblokiran versi, dan pengiriman

CI/CD Integration

Automatisasi pengiriman pembaruan dengan CI/CD

Channels

Manajemen aliran pembaruan yang berbeda dengan saluran

Encryption

Mengamankan pembaruan dengan enkripsi end-to-end

Update Behavior

Mengatur kapan dan bagaimana pembaruan diterapkan (langsung, delta, dll.)

Mendapatkan Bantuan

Jika Anda mengalami masalah selama proses onboarding:

• Cek Panduan Panduan Penyelesaian Masalah
• Join Komunitas Discord Review FAQ
• Hubungi Dukungan
• Teruskan dari __CAPGO_KEEP_0__ Panduan Onboarding Panduan Onboarding

Keep going from CLI Onboarding Guide

Jika Anda menggunakan Panduan Pemula CLI untuk merencanakan dashboard dan operasional API API Overview Ringkasan API untuk detail implementasi di Ringkasan __CAPGO_KEEP_0__ Pendahuluan API Keys Kunci API untuk detail implementasi di Kunci __CAPGO_KEEP_0__ Perangkat Paket-Paket untuk detail implementasi di Paket-Paket.