Langsung ke konten

Perintah

Halaman ini adalah panduan ringkas. Gunakan referensi perintah terkini untuk flag yang tepat: app, bundle, channel, dan build.

Semua perintah harus dijalankan di folder aplikasi Anda dengan proyek capacitor yang sudah di-ignite dengan benar.

npx @capgo/cli@latest init [apikey]

Metode ini ada untuk membantu onboarding Anda langkah demi langkah.

Ini akan menambahkan aplikasi Anda ke Capgo. Ini akan menambahkan code ke aplikasi Anda untuk memvalidasi update. Selain itu, ini akan build aplikasi Anda. Selanjutnya, ini akan upload aplikasi Anda ke Capgo. Dan ini akan membantu Anda memeriksa apakah update berfungsi.

npx @capgo/cli login [apikey]

Metode ini ada untuk mengingat apikey untuk Anda.

Opsional, Anda dapat memberikan:

--local Ini akan menyimpan apikey di repo lokal dan mengabaikannya di git.

npx @capgo/cli doctor

Perintah untuk memeriksa apakah Anda sudah menggunakan paket Capgo terbaru.

Perintah ini juga berguna untuk laporan bug.

npx @capgo/cli app add [appId]

[appId] app ID Anda dengan format com.test.app dijelaskan di sini.

💡 Semua opsi akan ditebak dari config Anda jika tidak diberikan.

Opsional, Anda bisa memasukkan:

  • --icon [/path/to/my/icon] agar ikon kustom ditampilkan di web app Capgo.
  • --name [test] agar memiliki nama kustom dalam daftar.
  • --apikey [key] Kunci API untuk menghubungkan ke akun Anda.
  • --retention [retention] periode retensi app bundle dalam hari, default 0 = tak terbatas.

Contoh capacitor.config.json untuk appId dan AppName, ikon ditebak dari folder resources

{
"appId": "ee.forgr.capacitor_go",
"appName": "Capgo",
"webDir": "dist"
}

npx @capgo/cli app set [appId]

[appId] adalah app ID Anda, formatnya dijelaskan di sini.

Opsional, Anda bisa memasukkan:

  • --icon [/path/to/my/icon] agar ikon kustom ditampilkan di web app Capgo.
  • --name [test] agar nama kustom muncul di daftar.
  • --retention [retention] periode retensi app bundle dalam hari, default 0 = tak terbatas.
  • --expose-metadata [true|false] untuk mengekspos metadata bundle (link dan komentar) ke plugin.
  • --preview atau --no-preview untuk mengaktifkan atau menonaktifkan kode QR pratinjau bundle dan channel.
  • --allow-device-custom-id atau --no-allow-device-custom-id untuk mengontrol ID perangkat kustom.
  • --block-provider-infra-requests atau --no-block-provider-infra-requests untuk mengontrol pemblokiran permintaan datacenter Google dan Apple yang diketahui.
  • --build-timeout-minutes [5-360] untuk mengatur timeout native build.
  • --ios-store-url [url] atau --android-store-url [url] untuk mengatur URL store.
  • --default-upload-channel [channel] untuk mengatur channel upload default.
  • --default-download-channel [channel] untuk mengatur channel download default, atau --disable-download-channels untuk membuat semua channel download menjadi non-publik.
  • --apikey [key] Kunci API untuk menghubungkan ke akun Anda.

npx @capgo/cli app list [appId]

[appId] app ID Anda dengan format com.test.app dijelaskan di sini.

Opsional, Anda bisa memasukkan:

  • --apikey [key] Kunci API untuk menghubungkan ke akun Anda.

npx @capgo/cli app delete [appId]

[appId] app ID Anda dengan format com.test.app dijelaskan di sini.

Opsional, Anda bisa memasukkan:

  • --apikey [key] Kunci API untuk menghubungkan ke akun Anda.
  • --bundle dengan nomor versi hanya akan menghapus versi ini.

npx @capgo/cli app debug [appId]

[appId] app ID Anda dengan format com.test.app dijelaskan di sini.

Opsional, Anda bisa memasukkan:

  • --apikey [key] Kunci API untuk menghubungkan ke akun Anda.
  • --device dengan perangkat spesifik yang ingin Anda debug

npx @capgo/cli app setting [path]

Edit konfigurasi Capacitor.

[path] - path pengaturan yang ingin Anda ubah. Misalnya, untuk mengubah appId, berikan appId. Jika Anda ingin menonaktifkan auto update di capacitor-updater, berikan plugins.CapacitorUpdater.autoUpdate dengan --string off.

Anda WAJIB memberikan salah satu --string atau --bool!

Opsi:

  • --string <string> - mengatur setting ke string
  • --bool <true | false> - mengatur setting ke boolean

npx @capgo/cli bundle upload [appId]

[appId] adalah app ID Anda, formatnya dijelaskan di sini.

Opsional, Anda bisa memasukkan:

  • --apikey <apikey> Kunci API untuk menghubungkan ke akun Anda.
  • --path <path> Path folder yang akan di-upload.
  • --channel <channel> Channel yang akan ditautkan.
  • --external <url> Tautkan ke URL eksternal alih-alih meng-upload ke Capgo Cloud.
  • --iv-session-key <key> Atur IV dan session key untuk bundle URL eksternal.
  • --s3-endpoint <s3Endpoint> URL endpoint S3. Tidak berfungsi dengan delta uploads atau opsi eksternal.
  • --s3-region <region> Region untuk S3 bucket Anda.
  • --s3-apikey <apikey> Kunci API untuk endpoint S3 Anda.
  • --s3-apisecret <apisecret> API secret untuk endpoint S3 Anda.
  • --s3-bucket-name <bucketName> Nama bucket AWS S3 Anda.
  • --s3-port <port> Port untuk endpoint S3 Anda.
  • --no-s3-ssl Nonaktifkan SSL untuk upload S3.
  • --key <key> Path kustom untuk public signing key (sistem v1).
  • --key-data <keyData> Public signing key (sistem v1).
  • --key-v2 <key> Path kustom untuk private signing key (sistem v2).
  • --key-data-v2 <keyData> Private signing key (sistem v2).
  • --bundle-url Mencetak bundle URL ke stdout.
  • --no-key Abaikan signing key dan kirim update tanpa enkripsi.
  • --no-code-check Abaikan pengecekan apakah notifyAppReady() dipanggil di source code dan index ada di root folder.
  • --display-iv-session Tampilkan di konsol IV dan session key yang dipakai untuk mengenkripsi update.
  • --bundle <bundle> Nomor versi bundle yang akan di-upload.
  • --auto-bump [level] Auto-increment dari bundle yang terhubung ke channel, jika tidak, versi app remote terbaru. Level: major, minor (default), patch (alias fix), metadata, atau ai (Workers AI membandingkan file lokal dengan manifest delta Capgo/channel sebelumnya, menyimpulkan level, dan mencatat alasan singkat; melewati AI dan menaikkan patch jika tidak ada versi Capgo sebelumnya). Menaikkan sampai menemukan nama yang tersedia (nama yang dihapus tetap terpakai). Tidak dapat digabungkan dengan --bundle.
  • --min-update-version <minUpdateVersion> Versi minimum yang diperlukan untuk update ke versi ini. Hanya digunakan jika disable auto update diatur ke metadata pada channel.
  • --auto-min-update-version Atur versi update minimum berdasarkan paket native.
  • --ignore-metadata-check Mengabaikan pemeriksaan metadata (node_modules) saat meng-upload.
  • --ignore-checksum-check Mengabaikan pemeriksaan checksum saat upload.
  • --timeout <timeout> Timeout untuk proses upload dalam detik.
  • --delta Mengunggah file Delta (manifest) bersama bundle penuh.
  • --delta-only Hanya mengunggah update Delta (manifest), melewati bundle penuh.
  • --no-delta Menonaktifkan upload Delta (manifest) (berguna jika instant apply autoUpdate mode diaktifkan tetapi Anda menginginkan bundle penuh).
  • --tus Unggah bundle menggunakan protokol tus.
  • --multipart Menggunakan protokol multipart untuk mengunggah data ke S3, Deprecated, gunakan TUS sebagai gantinya.
  • --encrypted-checksum <encryptedChecksum> Checksum terenkripsi (signature). Hanya digunakan saat mengunggah bundle eksternal.
  • --package-json <packageJson> Path ke package.json. Berguna untuk monorepo.
  • --auto-set-bundle Set bundle di capacitor.config.json.
  • --node-modules <nodeModules> Daftar path ke node_modules. Berguna untuk monorepo (dipisahkan koma, contoh: ../../node_modules,./node_modules)

⭐️ Opsi External membantu membuka 2 kasus: perusahaan dengan kekhawatiran privasi, tidak mengirim code ke pihak ketiga, dan app lebih besar dari 200 MB. Dengan pengaturan ini, Capgo hanya menyimpan tautan ke zip dan mengirim tautan tersebut ke semua app.

👀 Capgo cloud tidak pernah melihat apa yang ada di tautan (untuk opsi external), atau di code saat disimpan.

🔑 Anda bisa menambah lapisan keamanan kedua dengan enkripsi, sehingga Capgo tidak akan bisa melihat atau mengubah apa pun, menjadikannya “trustless”.

Contoh package.json untuk versi

{
"version": "1.0.2"
}

⛔ Versi harus lebih besar dari “0.0.0”.

💡 Jangan lupa perbarui nomor versi setiap kali mengirim, nomor versi tidak bisa ditimpa atau dipakai ulang setelah dihapus demi alasan keamanan.

npx @capgo/cli bundle list [appId]

[appId] app ID Anda dengan format com.test.app dijelaskan di sini.

Opsional, Anda bisa memasukkan:

  • --apikey [key] Kunci API untuk menghubungkan ke akun Anda.

npx @capgo/cli bundle delete [appId]

[appId] app ID Anda dengan format com.test.app dijelaskan di sini.

Opsional, Anda bisa memasukkan:

  • --apikey [key] Kunci API untuk menghubungkan ke akun Anda.
  • --bundle dengan nomor versi hanya akan menghapus versi ini.

dalam rentang SemVer untuk versi major ke Cloud

npx @capgo/cli bundle cleanup [appId] --bundle=[majorVersion] --keep=[numberToKeep]

[appId] app ID Anda dengan format com.test.app dijelaskan di sini.

Opsional, Anda bisa memasukkan:

  • --apikey [key] Kunci API untuk menghubungkan ke akun Anda.
  • --bundle [majorVersion] versi yang ingin Anda hapus paket sebelumnya, versi terakhir akan tetap disimpan + numberToKeep.
  • --keep [numberToKeep] jumlah paket yang ingin Anda simpan (default 4).

Contoh: Jika Anda punya 10 versi dari 10.0.1 sampai 10.0.11, dan Anda menggunakan npx @capgo/cli cleanup [appId] --bundle=10.0.0 ia akan menghapus 10.0.1 sampai 10.0.6. Versi 10.0.7 hingga 10.0.11 akan tetap disimpan.

Jika Anda punya total 20 versi, dan Anda tidak menyertakan nomor bundle seperti ini: npx @capgo/cli cleanup [appId] --keep=2 Ia akan menghapus 18 versi, dan menyimpan 2 versi terakhir.

Perintah ini akan meminta konfirmasi dan menampilkan tabel berisi daftar file yang akan dipertahankan atau dihapus.

Peringatan: Perintah ini sudah tidak didukung dan akan dihapus pada rilis mayor berikutnya. Silakan gunakan sistem enkripsi baru. npx @capgo/cli bundle encrypt [path/to/zip]

Perintah ini digunakan saat Anda menggunakan sumber eksternal untuk menyimpan code atau untuk keperluan pengujian.

Opsional, Anda bisa memasukkan:

--key [/path/to/my/private_key] path private key Anda. --key-data [privateKey] data private key, jika Anda ingin menggunakannya secara inline. Perintah ini akan mencetak ivSessionKeyy dan menghasilkan zip terenkripsi, untuk digunakan dengan perintah upload atau perintah decryt.

npx @capgo/cli bundle encrypt [path/to/zip] [checksum]

Perintah ini digunakan ketika Anda menggunakan sumber eksternal untuk menyimpan code Anda atau untuk keperluan pengujian. Checksum adalah sha256 dari bundle (dihasilkan oleh —key-v2), digunakan untuk memverifikasi integritas file setelah dekripsi. Checksum akan dienkripsi dengan private key dan dikirim bersama bundle. Dalam enkripsi v2, checksum ditingkatkan menjadi “signature” dari bundle.

Opsional, Anda bisa memasukkan:

--key [/path/to/my/private_key] path private key Anda. --key-data [privateKey] data private key, jika Anda ingin menggunakannya secara inline. --json untuk menampilkan info sebagai json. Perintah ini akan mencetak ivSessionKeyy dan menghasilkan zip terenkripsi, untuk digunakan dengan perintah upload atau perintah decryt.

npx @capgo/cli bundle decrypt [path/to/zip] [ivSessionKey]

Opsional, Anda bisa memasukkan:

--key [/path/to/my/private_key] path private key Anda.

--key-data [privateKey] data kunci privat, jika Anda ingin menggunakan inline. Perintah ini terutama digunakan untuk tujuan pengujian; akan mendekripsi zip dan mencetak kunci sesi base64 yang telah didekripsi di konsol.

npx @capgo/cli bundle decryptV2 [path/to/zip] [ivSessionKey]

Opsional, Anda bisa memasukkan:

--key [/path/to/my/private_key] path private key Anda. --key-data [privateKey] data kunci privat, jika Anda ingin menggunakan inline. Perintah ini terutama digunakan untuk tujuan pengujian; akan mendekripsi zip dan mencetak kunci sesi base64 yang telah didekripsi di konsol. --checksum [checksum] checksum file, akan memverifikasi checksum setelah dekripsi.

npx @capgo/cli bundle zip [appId]

[appId] adalah app ID Anda, formatnya dijelaskan di sini.

Opsional, Anda bisa memasukkan:

  • --path [/path/to/my/bundle] untuk meng-upload folder tertentu.
  • --bundle [1.0.0] untuk mengatur nomor versi bundle pada nama file.
  • --name [myapp] untuk menimpa nama file.
  • --json untuk menampilkan info sebagai json.
  • --no-code-check untuk mengabaikan pemeriksaan code dan tetap mengirim bundle.
  • --key-v2 untuk menggunakan sistem enkripsi baru. Ini diperlukan karena sistem enkripsi baru menggunakan checksum yang lebih baik untuk memverifikasi integritas file.

npx @capgo/cli bundle compatibility [appId] -c [channelName]

[appId] adalah app ID Anda, formatnya dijelaskan di sini. [channelName] nama channel yang akan diperiksa.

Opsional, Anda bisa memasukkan:

  • --apikey [key] Kunci API untuk menghubungkan ke akun Anda.
  • --text gunakan teks alih-alih emoji di tabel
  • --channel [channel] channel yang akan diperiksa kompatibilitasnya.
  • --package-json <packageJson> Path ke package.json. Berguna untuk monorepo
  • --node-modules <nodeModules> Daftar path ke node_modules. Berguna untuk monorepo (dipisahkan koma, mis: ../../node_modules,./node_modules)

npx @capgo/cli channel add [channelName] [appId]

[channelName] nama channel baru Anda, seperti production atau beta. [appId] app ID Anda dengan format com.test.app dijelaskan di sini.

npx @capgo/cli channel delete [channelName] [appId]

[channelName] nama channel yang ingin Anda hapus. [appId] app ID Anda dengan format com.test.app dijelaskan di sini.

npx @capgo/cli channel list [appId]

[appId] app ID Anda dengan format com.test.app dijelaskan di sini.

Opsional, Anda bisa memasukkan:

  • --apikey [key] Kunci API untuk menghubungkan ke akun Anda.

npx @capgo/cli channel set [channelName] [appId]

[appId] adalah app ID Anda, formatnya dijelaskan di sini. [channelName] nama channel yang ingin Anda konfigurasi, seperti production atau beta.

Opsional, Anda bisa memasukkan:

  • --bundle [1.2.3] app bundle Anda yang sudah dikirim ke cloud, untuk menghubungkannya ke sebuah channel.
  • --latest dapatkan versi bundle dari package.json:version, tidak dapat digunakan dengan --bundle.
  • --state [ normal | default ] atur status channel, bisa berupa normal atau default. Satu channel harus default.
  • --downgrade memungkinkan channel mengirim versi downgrade ke perangkat.
  • --no-downgrade melarang channel mengirim versi downgrade ke perangkat.
  • --upgrade memungkinkan channel mengirim versi upgrade (major) ke perangkat.
  • --no-upgrade melarang channel mengirim versi upgrade (major) ke perangkat.
  • --ios memungkinkan channel mengirim versi ke perangkat iOS.
  • --no-ios melarang channel mengirim versi ke perangkat iOS.
  • --android mengizinkan channel untuk mengirim versi ke perangkat android.
  • --no-android melarang channel untuk mengirim versi ke perangkat android.
  • --self-assign memungkinkan perangkat untuk mendaftarkan diri ke channel ini.
  • --no-self-assign mencegah perangkat untuk mendaftarkan diri ke channel ini.
  • --disable-auto-update STRATEGY Nonaktifkan strategi auto update untuk channel ini. Opsi yang tersedia: major, minor, patch, metadata, none.
  • --apikey [key] Kunci API untuk menghubungkan ke akun Anda.

Ada beberapa cara untuk menangani penonaktifan update bagi versi yang sudah terlalu lama.
Capgo tidak bisa mengupdate native code, jadi update dari versi dengan native code lama ke versi dengan native code yang sudah diperbarui seharusnya tidak memungkinkan. Ada beberapa cara untuk melakukannya.

Pertama, major strategi. Ini mencegah update dari native baseline 0.0.0 -> bundle target 1.0.0. Angka major adalah angka yang disorot (1.0.0 dan 0.0.0).
Kedua adalah minor strategi. Ini mencegah update jika target bundle memiliki major atau minor yang berbeda dari baseline native perangkat, seperti 0.0.0 -> 1.1.0 atau 1.1.0 -> 1.2.0.

Ketiga, patch strategi. Ini ditambahkan ke capgo sebagai mode yang sangat ketat. Tidak disarankan digunakan kecuali Anda benar-benar memahami cara kerjanya. Agar update diterima, kondisi berikut harus terpenuhi:

  • Versi major sama antara bundle target dan version_build
  • Versi minor sama antara bundle target dan version_build
  • Versi patch sama antara bundle target dan version_build
  • Hanya suffix versi yang boleh berbeda, seperti prerelease (-beta.2) atau metadata build (+build.2)

Berikut adalah contoh skenario di mana update diizinkan atau ditolak

  • 1.0.0-beta.1 -> 1.0.0-beta.2 diizinkan
  • 1.0.0+build.1 -> 1.0.0+build.2 diizinkan
  • 1.0.0 -> 1.0.1 diblokir
  • 1.0.0 -> 1.1.0 diblokir
  • 1.0.0 -> 2.0.0 diblokir

Perbandingan strategi menggunakan baseline native yang dikirim sebagai version_build, bukan bundle yang saat ini diunduh yang dikirim sebagai version_name.

Terakhir, strategi yang paling rumit. Yang metadata strategi.
Pertama, Anda perlu tahu bahwa awalnya setelah Anda mengaktifkannya, update AKAN gagal karena channel tidak memiliki metadata yang diperlukan.
Jika channel tidak memiliki metadata, Anda akan melihat pesan seperti ini:

Metadata tidak ditemukan

Jika Anda melihat hal seperti ini, berarti Anda harus membuka bundle saat ini untuk channel yang gagal dan mengatur metadata-nya.
Pertama, cari tahu channel mana yang gagal. Anda bisa melakukannya dengan melihat misconfigured kolom

Tabel salah konfigurasi

Lalu buka channel yang gagal dan klik Bundle number. Ini seharusnya membawa Anda ke halaman bundle.

Temukan channel yang gagal

Setelah di sana, isi Minimal update version field. Ini harus berupa semver.
Jika nilai yang Anda berikan bukan semver, Anda akan mendapat error, tetapi jika semuanya berjalan dengan benar, Anda seharusnya melihat sesuatu seperti ini:

Set versi min

Sekarang, kemungkinan besar Anda tidak ingin mengatur data ini secara manual setiap kali Anda update. Untungnya, CLI akan mencegah Anda mengirim update tanpa metadata ini

CLI gagal, tidak ada metadata

Untuk meng-upload bundle dengan benar saat menggunakan metadata option, Anda perlu meneruskan --min-update-version dengan semver yang valid. Sesuatu seperti ini:

CLI upload dengan metadata

Panduan --min-update-version bukan satu-satunya cara untuk menangani kompatibilitas. Ada juga --auto-min-update-version. Berikut cara kerjanya.

Pertama, ia melihat versi yang saat ini diunggah ke channel. Ia memeriksa kompatibilitasnya sama seperti perintah bundle compatibility akan melakukannya. Kedua, jika versi baru 100% kompatibel, ia menggunakan kembali min_update_version dari versi terbaru di channel. Jika tidak, maka akan mengatur min_update_version ke nomor bundle dari versi yang baru diunggah.

Anda akan selalu mendapatkan informasi tentang min_update_version saat menggunakan opsi ini. Tampilannya akan seperti ini:

Versi update minimum

Jika versi baru tidak kompatibel, hasilnya akan terlihat seperti ini

Versi update minimum tidak kompatibel

Capgo mendukung enkripsi end-to-end, yang berarti bundle Anda (code) dienkripsi sebelum dikirim ke cloud dan didekripsi di perangkat. Untuk itu, Anda perlu membuat pasangan kunci RSA. Gunakan perintah berikut untuk membuatnya.

Sistem enkripsi ini adalah kombinasi RSA dan AES. Kunci RSA digunakan untuk mengenkripsi kunci AES, dan kunci AES digunakan untuk mengenkripsi file.

Lihat di bawah untuk informasi lebih lanjut tentang sistem enkripsi.

Cara kerja kriptografi

Skema enkripsi

npx @capgo/cli key create

Opsional, Anda bisa memasukkan: --force untuk menimpa kunci yang sudah ada. Perintah ini akan membuat pasangan kunci di aplikasi Anda dan meminta Anda menyimpan kunci privat di tempat yang aman. Disarankan untuk tidak melakukan git commit pada kunci privat dan tidak membagikannya kepada siapa pun.

Setelah pengujian lokal, hapus key dari file config dan tambahkan di langkah CI dengan key save

npx @capgo/cli key save

Opsional, Anda bisa memasukkan:

--key [/path/to/my/public_key] path file public key Anda.

--key-data [publicKey] data public key, jika ingin menggunakan inline. Perintah ini berguna jika Anda mengikuti rekomendasi untuk tidak melakukan commit key di app config.

Untuk mengotomatiskan pekerjaan Anda, saya sarankan buat GitHub action yang melakukan push ke server kami

Tutorial GitHub action

GitHub - Cap-go/demo-app

Jangan lupa konfigurasi env variable CI dengan key API Anda

Jika Anda menggunakan Perintah untuk merencanakan operasi dashboard dan API, hubungkan dengan Ringkasan API untuk detail implementasi di API Overview, Pendahuluan untuk detail implementasi di Introduction, Kunci API untuk detail implementasi di API Keys, Perangkat untuk detail implementasi di Devices, dan Bundle untuk detail implementasi di Bundles.