Panduan Pendaftaran CLI

Ringkasan Cepat

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

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

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

Tips

Pengalaman onboard dapat dihentikan kapan saja dan melanjutkan dari tempat yang Anda tinggalkan.

Mulai Pengalaman Onboard

Jalankan perintah onboard dengan kunci API Anda:

npx @capgo/cli@latest init [APIKEY]

Anda akan melihat pesan selamat datang:

Capgo onboarding 🛫

Apa yang Terjadi Selama Pengaturan

The CLI akan mengantarmu melalui 13 langkah interaktif:

Fase Pengaturan (Langkah 1-6):

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

Fase Pengujian (Langkah 7-12):

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

Penyelesaian (Langkah 13):

• Aplikasi Anda siap untuk perbaruan hidup! 🎉

Proses Pendaftaran 13 Langkah

Langkah 1: Periksa Persyaratan

CLI memeriksa lingkungan pengembangan Anda untuk memastikan Anda telah menginstal alat yang diperlukan.

Apa yang dicek:

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

Hasil yang mungkin:

✅ 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

Mungkin pertanyaan yang Anda akan ditanyakan:

Peringatan

Jika tidak ada lingkungan pengembangan yang terdeteksi, Anda akan diminta apakah Anda ingin melanjutkan. Disarankan untuk menginstal setidaknya satu platform sebelum melanjutkan.

Langkah 2: Tambahkan Aplikasi Anda

CLI akan masuk 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:

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.

Catatan

App IDs harus mengikuti notasi domain terbalik (misalnya com.example.myapp)

Step 3: Buat Saluran Produksi

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

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

Tips

Jangan khawatir! Ini hanya untuk pengujian lokal selama proses onboarding. Membuat saluran “produksi” tidak berarti pembaruan Anda akan langsung dipublikasikan ke pelanggan. Anda memiliki kendali penuh atas kapan pembaruan 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 ✅")

Pilih saluran produksi akan dibuat dan ditetapkan sebagai default. Pilihan ini sangat disarankan bagi 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:

• Tetapkan saluran di file capacitor.config.ts gunakan metode JavaScript untuk menetapkan saluran secara dinamis
• Konfigurasi saluran kemudian dari __CAPGO_KEEP_0__ console web setChannel() Langkah 4: Pasang Plugin Pembarui
• Configure channels later from the Capgo web console

Instal Plugin Pembarui

The CLI akan menginstal plugin yang kompatibel dengan versi CLI Anda. @capgo/capacitor-updater plugin yang kompatibel dengan versi Capacitor Anda.

❓ 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+Instalasi Versi Terbaru

Peringatan

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

Opsi Perbarui 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

Tips

Apa itu perbarui instan? Dengan memungkinkan pembaruan instan, aplikasi Anda menerapkan pembaruan secara langsung ketika di latar belakang dan dibuka kembali. 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 latar belakang dan dibuka kembali
• autoUpdate: 'always' dan autoSplashscreen: true akan ditambahkan ke konfigurasi Anda
• Aplikasi capacitor.config.ts akan diperbarui secara otomatis
• Pembaruan delta akan diaktifkan secara otomatis - ini mengirim hanya file yang berubah antara pembaruan daripada paket lengkap, membuat pembaruan jauh lebih cepat

Jika Anda memilih Tidak:

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

Langkah 5: Tambahkan Integrasi Code

Integrasi 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
• Framewok lainnya: Menambahkan ke file entry utama Anda

Tips

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

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

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

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

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

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

CapacitorUpdater.notifyAppReady()

Tempatkan code ini setelah impor Anda dan sebelum inisialisasi aplikasi Anda. Untuk informasi lebih lanjut, lihat panduan menambahkan aplikasi Langkah 6: Setup Enkripsi (Opsional).

Langkah 6: Pengaturan Enkripsi (Opsional)

Enkripsi akhir-ke-akhir 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 atasnya.

Jika Anda mengaktifkan enkripsi, CLI akan:

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

Bab 7: Pilih Platform

Pilih platform mana yang akan Anda gunakan 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

Tip

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 proyek Anda
2. Menggunakan skrip build Anda
3. Menggunakan npx cap sync {platform}

Jika skrip build hilang:

Anda akan diminta jika Anda ingin melewatkan build atau menambahkan skrip build ke proyek Anda. package.json.

Langkah 9: Jalankan di Perangkat

Tes 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

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 mengubah file Anda untuk menambahkan banner tes yang dapat dilihat atau mengubahnya.

Mode manual: Anda 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?

Tip

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

Langkah 11: Unggah Paket

Unggah paket aplikasi yang diperbarui ke Capgo.

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

CLI berjalan:

npx @capgo/cli@latest bundle upload

Tips

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

Pemberitahuan 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 menyediakan 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 Pembaruan di Perangkat

Saatnya melihat pembaruan beraksi!

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

Untuk pembaruan instan:

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

Untuk pembaruan 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: Selesai

Welcome onboard ✈️!

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

Apa yang Anda Capai

Setelah menyelesaikan onboarding, Anda telah:

✅ Aplikasi Terdaftar

Aplikasi Anda terdaftar di Capgo dengan saluran produksi

✅ Plugin Terinstal

Plugin Pembarui Capacitor telah terinstal dan dikonfigurasi

✅ Code Terintegrasi

Integrasi code telah ditambahkan ke aplikasi Anda

✅ Pembaruan Dites

Anda telah berhasil mengdeploy 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 Mengdeploy Pembaruan Hidup.

Mengulangi Proses Pengenalan

Jika Anda keluar dari proses pengenalan, Anda dapat 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 onboarding disimpan secara lokal, sehingga Anda dapat keluar dan melanjutkan proses onboarding dengan aman.

Pengaturan

Tidak Ada Lingkungan Pengembangan

Masalah: Tidak terdeteksi Xcode maupun Android SDK.

Solusi:

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

ID Aplikasi Sudah Terambil

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 Tidak Ditemukan

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 Anda:

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

CapacitorUpdater.notifyAppReady()

Versi Capacitor Terlalu Lama

Masalah: Versi Capacitor Anda di bawah v5.

Solusi: Upgrade Capacitor ke v5 atau lebih tinggi:

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

Langkah-Langkah Selanjutnya

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

Daftar Pemeriksaan Satu Kali

Konfigurasi saluran, CI, dan unggah delta sekali untuk stabilitas jangka panjang

Deploy Update

Belajar cara mengdeploy update dari dashboard Capgo

Jenis Update

Referensi semua jenis update OTA: waktu aplikasi, kondisi penundaan, penghalang versi, dan pengiriman

Pengintegrasian CI/CD

Automatisasi pengiriman update Anda dengan CI/CD

Saluran

Kelola beberapa aliran pembaruan dengan saluran

Enkripsi

Tetapkan pembaruan Anda dengan enkripsi akhir-ke-akhir

Pengaturan Pembaruan

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

Mendapatkan Bantuan

Jika Anda mengalami masalah selama proses onboarding:

• Periksa Pedoman Penyelesaian Masalah
• Bergabunglah ke Komunitas Discord
• Reviewlah FAQ
• Hubungi Dukungan

Lanjutkan dari Panduan Pendaftaran CLI

Jika Anda menggunakan Panduan Pendaftaran CLI untuk merencanakan dashboard dan operasional API , hubungkan dengan Ringkasan API untuk detail implementasi di Ringkasan API, Pendahuluan untuk detail implementasi di Pendahuluan, API Kunci untuk detail implementasi di API Kunci, Perangkat untuk detail implementasi di Perangkat, dan Paket untuk detail implementasi di Paket.