Comandi
Copia un prompt di configurazione con i passaggi di installazione e la guida markdown completa per questo plugin.
Questa pagina è una panoramica guidata. Per i flag esatti, usa il riferimento comandi aggiornato: manifest, bundle, canale, e build.
Utilizzo
Sezione intitolata “Usage”Tutti i comandi vanno eseguiti nella cartella della tua app con il progetto capacitor inizializzato correttamente.
npx @capgo/cli@latest init [apikey]
Questo metodo è pensato per guidarti passo dopo passo.
Aggiungerà la tua app a Capgo. Inserirà code nella tua app per validare l'aggiornamento. Inoltre, compilerà la tua app. Caricherà quindi la tua app su Capgo. Ti aiuterà anche a verificare che l'aggiornamento funzioni.
npx @capgo/cli login [apikey]
Questo metodo serve a ricordare il apikey per te.
Facoltativamente puoi specificare:
--local Questo salverà la tua apikey nel repository locale e la ignorerà con git.
npx @capgo/cli doctor
Comando per verificare se i pacchetti Capgo sono aggiornati.
Questo comando sarà utile anche per i bug report.
Aggiungi
Sezione intitolata “Add”npx @capgo/cli app add [appId]
[appId] l'ID della tua app nel formato com.test.app viene spiegato qui.
💡 Se non specificate, tutte le opzioni verranno rilevate dalla tua config.
Facoltativamente, puoi fornire:
--icon [/path/to/my/icon]per visualizzare un'icona personalizzata nella web app di Capgo.--name [test]per avere un nome personalizzato nella lista.--apikey [key]la chiave API per collegarti al tuo account.--retention [retention]periodo di retention del bundle dell'app in giorni, 0 di default = infinito.
Esempio di capacitor.config.json per appId e AppName, l'icona viene rilevata dalla cartella resources
{ "appId": "ee.forgr.capacitor_go", "appName": "Capgo", "webDir": "dist"}Imposta
Sezione intitolata “Set”npx @capgo/cli app set [appId]
[appId] è l'ID della tua app, il formato è spiegato qui.
Facoltativamente, puoi fornire:
--icon [/path/to/my/icon]per visualizzare un'icona personalizzata nella web app di Capgo.--name [test]per avere un nome personalizzato nella lista.--retention [retention]periodo di retention del bundle dell'app in giorni, 0 di default = infinito.--expose-metadata [true|false]per esporre i metadati del bundle (link e commento) al plugin.--previewoppure--no-previewper abilitare o disabilitare i codici QR di anteprima per bundle e canali.--allow-device-custom-idoppure--no-allow-device-custom-idper controllare gli ID dispositivo personalizzati.--block-provider-infra-requestsoppure--no-block-provider-infra-requestsper controllare il blocco delle richieste dai datacenter noti di Google e Apple.--build-timeout-minutes [5-360]per impostare il timeout del Native Build.--ios-store-url [url]oppure--android-store-url [url]per impostare l'URL dello store.--default-upload-channel [channel]per impostare il canale di upload predefinito.--default-download-channel [channel]per impostare il canale di download predefinito, oppure--disable-download-channelsper rendere tutti i canali di download non pubblici.--apikey [key]la chiave API per collegarti al tuo account.
npx @capgo/cli app list [appId]
[appId] l'ID della tua app nel formato com.test.app viene spiegato qui.
Facoltativamente, puoi fornire:
--apikey [key]la chiave API per collegarti al tuo account.
Elimina
Sezione intitolata “Elimina”npx @capgo/cli app delete [appId]
[appId] l'ID della tua app nel formato com.test.app viene spiegato qui.
Facoltativamente, puoi fornire:
--apikey [key]la chiave API per collegarti al tuo account.--bundlecon il numero di versione eliminerà solo questa versione.
npx @capgo/cli app debug [appId]
[appId] l'ID della tua app nel formato com.test.app viene spiegato qui.
Facoltativamente, puoi fornire:
--apikey [key]la chiave API per collegarti al tuo account.--devicecon il dispositivo specifico che vuoi debuggare
Impostazione
Sezione intitolata “Impostazione”npx @capgo/cli app setting [path]
Modifica la configurazione di Capacitor.
[path] - percorso dell'impostazione che vuoi cambiare. Ad esempio, per cambiare il appId, fornire appId.
Se desideri disabilitare l'auto update nel capacitor-updater, fornire plugins.CapacitorUpdater.autoUpdate con --string off.
Devi fornire uno dei due --string oppure --bool!
Opzioni:
--string <string>- imposta l'impostazione su una stringa--bool <true | false>- imposta l'impostazione su un booleano
npx @capgo/cli bundle upload [appId]
[appId] è l'ID della tua app, il formato è spiegato qui.
Facoltativamente, puoi fornire:
--apikey <apikey>la chiave API per collegarti al tuo account.--path <path>Percorso della cartella da caricare.--channel <channel>Canale a cui collegarsi.--external <url>Collega a un URL esterno invece di caricare su Capgo Cloud.--iv-session-key <key>Imposta la IV e la chiave di sessione per l'URL esterno del bundle.--s3-endpoint <s3Endpoint>URL dell'endpoint S3. Non funziona con gli upload delta o con l'opzione esterna.--s3-region <region>Regione per il tuo bucket S3.--s3-apikey <apikey>Chiave API per il tuo endpoint S3.--s3-apisecret <apisecret>API secret per il tuo endpoint S3.--s3-bucket-name <bucketName>Nome del tuo bucket AWS S3.--s3-port <port>Porta per il tuo endpoint S3.--no-s3-sslDisabilita SSL per l'upload su S3.--key <key>Percorso personalizzato per la chiave di firma pubblica (sistema v1).--key-data <keyData>Chiave di firma pubblica (sistema v1).--key-v2 <key>Percorso personalizzato per la chiave di firma privata (sistema v2).--key-data-v2 <keyData>Chiave di firma privata (sistema v2).--bundle-urlStampa l'URL del bundle su stdout.--no-keyIgnora la chiave di firma e invia l'update in chiaro.--no-code-checkIgnora il controllo su notifyAppReady() nel source code e sulla presenza di index nella root.--display-iv-sessionMostra nella console l'IV e la session key usati per criptare l'update.--bundle <bundle>Numero di versione del bundle da caricare.--auto-bump [level]Incremento automatico dal bundle collegato al canale, altrimenti dall'ultima versione remota dell'app. Livello:major,minor(predefinito),patch(aliasfix),metadata, oai(Workers AI confronta i file locali con il manifest delta del canale Capgo precedente, deduce il livello e registra una breve motivazione; salta l'AI e incrementapatchse non esiste una versione Capgo precedente). Incrementa finché non trova un nome libero (i nomi eliminati restano occupati). Non può essere combinato con--bundle.--min-update-version <minUpdateVersion>Versione minima richiesta per aggiornare a questa versione. Usata solo se la disattivazione dell'aggiornamento automatico è impostata su metadata nel canale.--auto-min-update-versionImposta la versione minima di aggiornamento in base ai pacchetti nativi.--ignore-metadata-checkIgnora il controllo dei metadati (node_modules) durante il caricamento.--ignore-checksum-checkIgnora la verifica del checksum durante l'upload.--timeout <timeout>Timeout del processo di upload in secondi.--deltaCarica i file Delta (manifest) insieme al bundle completo.--delta-onlyCarica solo gli aggiornamenti Delta (manifest), saltando il bundle completo.--no-deltaDisabilita il caricamento dei file Delta (manifest) (utile se la modalitàautoUpdateinstant apply è attiva ma vuoi un bundle completo).--tusCarica il bundle usando il protocollo tus.--multipartUsa il protocollo multipart per caricare i dati su S3. Deprecato, usa TUS.--encrypted-checksum <encryptedChecksum>Un checksum crittografato (firma). Usato solo quando si carica un bundle esterno.--package-json <packageJson>Il percorso di package.json. Utile per i monorepo.--auto-set-bundleImposta il bundle in capacitor.config.json.--node-modules <nodeModules>Un elenco di percorsi verso node_modules. Utile per i monorepo (separati da virgola es: ../../node_modules,./node_modules)
⭐️ L'opzione External aiuta in 2 casi: aziende con esigenze di privacy (non inviare code a terze parti) e app più grandi di 200 MB. Con questa impostazione, Capgo salva solo il link allo zip e lo invia a tutte le app.
👀 Il cloud di Capgo non analizza mai il contenuto del link (con l'opzione external) o di code una volta memorizzato.
🔑 Puoi aggiungere un secondo livello di sicurezza tramite crittografia: in questo modo Capgo non potrà né vedere né modificare nulla, rendendo il sistema “trustless”.
Esempio di package.json per la versione
{ "version": "1.0.2"}⛔ La versione deve essere superiore a “0.0.0”.
💡 Ricorda di aggiornare il numero di versione ogni volta che ne invii uno: per motivi di sicurezza, il numero di versione non può essere sovrascritto o riutilizzato dopo l'eliminazione.
npx @capgo/cli bundle list [appId]
[appId] l'ID della tua app nel formato com.test.app viene spiegato qui.
Facoltativamente, puoi fornire:
--apikey [key]la chiave API per collegarti al tuo account.
Elimina
Sezione intitolata “Elimina”npx @capgo/cli bundle delete [appId]
[appId] l'ID della tua app nel formato com.test.app viene spiegato qui.
Facoltativamente, puoi fornire:
--apikey [key]la chiave API per collegarti al tuo account.--bundlecon il numero di versione eliminerà solo questa versione.
Pulizia
Sezione intitolata “Cleanup”in un range SemVer per una versione major su Cloud
npx @capgo/cli bundle cleanup [appId] --bundle=[majorVersion] --keep=[numberToKeep]
[appId] l'ID della tua app nel formato com.test.app viene spiegato qui.
Facoltativamente, puoi fornire:
--apikey [key]la chiave API per collegarti al tuo account.--bundle [majorVersion]la versione per cui vuoi rimuovere i pacchetti precedenti, verrà mantenuto l'ultimo +numberToKeep.--keep [numberToKeep]il numero di pacchetti che vuoi mantenere (default 4).
Per esempio: se hai 10 versioni da 10.0.1 a 10.0.11 e usi npx @capgo/cli cleanup [appId] --bundle=10.0.0 rimuoverà dalla 10.0.1 alla 10.0.6. Verranno mantenute dalla 10.0.7 alla 10.0.11.
Se hai 20 versioni in totale e non indichi un numero di bundle come in questo caso: npx @capgo/cli cleanup [appId] --keep=2 Rimuoverà 18 versioni e manterrà le ultime 2.
Il comando chiederà conferma e mostrerà una tabella con ciò che verrà mantenuto e rimosso.
Crittografa
Sezione intitolata “Crittografa”Avviso: Questo comando è deprecato e verrà rimosso nella prossima release maggiore. Utilizza il nuovo sistema di crittografia.
npx @capgo/cli bundle encrypt [path/to/zip]
Questo comando viene utilizzato quando si usa una sorgente esterna per archiviare il tuo code o per scopi di test.
Facoltativamente, puoi fornire:
--key [/path/to/my/private_key] il percorso della tua chiave privata.
--key-data [privateKey] i dati della chiave privata, se vuoi usarla inline.
Il comando stamperà la tua ivSessionKeyy e genererà uno zip crittografato, da usare con il comando upload o decrypt.
Crittografia V2
Sezione intitolata “Encrypt V2”npx @capgo/cli bundle encrypt [path/to/zip] [checksum]
Questo comando viene usato quando si utilizza una sorgente esterna per archiviare il tuo code o per scopi di test. Il checksum è lo sha256 del bundle (generato da —key-v2), usato per verificare l'integrità del file dopo la decrittazione. Verrà crittografato con la chiave privata e inviato insieme al bundle. In encryption v2 il checksum viene aggiornato per diventare una “firma” del bundle.
Facoltativamente, puoi fornire:
--key [/path/to/my/private_key] il percorso della tua chiave privata.
--key-data [privateKey] i dati della chiave privata, se vuoi usarla inline.
--json per outputtare le info in json.
Il comando stamperà la tua ivSessionKeyy e genererà uno zip crittografato, da usare con il comando upload o decrypt.
Decripta
Sezione intitolata “Decrypt”npx @capgo/cli bundle decrypt [path/to/zip] [ivSessionKey]
Facoltativamente, puoi fornire:
--key [/path/to/my/private_key] il percorso della tua chiave privata.
--key-data [privateKey] i dati della chiave privata, se vuoi usarla inline. Questo comando è usato principalmente per test: decifra lo zip e stampa la session key decifrata in base64 nella console.
Decripta V2
Sezione intitolata “Decrypt V2”npx @capgo/cli bundle decryptV2 [path/to/zip] [ivSessionKey]
Facoltativamente, puoi fornire:
--key [/path/to/my/private_key] il percorso della tua chiave privata.
--key-data [privateKey] i dati della chiave privata, se vuoi usarla inline. Questo comando è usato principalmente per test: decifra lo zip e stampa la session key decifrata in base64 nella console.
--checksum [checksum] il checksum del file, verrà verificato dopo la decifratura.
npx @capgo/cli bundle zip [appId]
[appId] è l'ID della tua app, il formato è spiegato qui.
Facoltativamente, puoi fornire:
--path [/path/to/my/bundle]per caricare una specifica cartella.--bundle [1.0.0]per impostare il numero di versione del bundle nel nome del file.--name [myapp]per sovrascrivere il nome del file.--jsonper outputtare le informazioni in formato json.--no-code-checkper ignorare il controllo code e inviare il bundle comunque.--key-v2per usare il nuovo sistema di crittografia. È richiesto perché il nuovo sistema di crittografia utilizza checksum migliori per verificare l'integrità del file.
Compatibilità
Sezione intitolata “Compatibilità”npx @capgo/cli bundle compatibility [appId] -c [channelName]
[appId] è l'ID della tua app, il formato è spiegato qui.
[channelName] il nome del canale da verificare.
Facoltativamente, puoi fornire:
--apikey [key]la chiave API per collegarti al tuo account.--textusa il testo invece delle emoji nella tabella--channel [channel]il canale con cui verificare la compatibilità.--package-json <packageJson>Un percorso verso package.json. Utile per i monorepo--node-modules <nodeModules>Un elenco di percorsi verso node_modules. Utile per i monorepo (separati da virgola es: ../../node_modules,./node_modules)
Aggiungi
Sezione intitolata “Add”npx @capgo/cli channel add [channelName] [appId]
[channelName] il nome del tuo nuovo canale, ad esempio production oppure beta. [appId] l'ID della tua app nel formato com.test.app viene spiegato qui.
Elimina
Sezione intitolata “Elimina”npx @capgo/cli channel delete [channelName] [appId]
[channelName] il nome del canale che desideri eliminare. [appId] l'ID della tua app nel formato com.test.app viene spiegato qui.
npx @capgo/cli channel list [appId]
[appId] l'ID della tua app nel formato com.test.app viene spiegato qui.
Facoltativamente, puoi fornire:
--apikey [key]la chiave API per collegarti al tuo account.
Imposta
Sezione intitolata “Set”npx @capgo/cli channel set [channelName] [appId]
[appId] è l'ID della tua app, il formato è spiegato qui.
[channelName] il nome del canale che vuoi configurare, ad esempio production oppure beta.
Facoltativamente, puoi fornire:
--bundle [1.2.3]il bundle della tua app già inviato al cloud, per collegarlo a un canale.--latestrecupera la versione del bundle dapackage.json:version, non può essere usato con--bundle.--state [ normal | default ]imposta lo stato del canale, può esserenormaloppuredefault. Un canale deve esseredefault.--downgradepermette al canale di inviare una versione di downgrade ai dispositivi.--no-downgradeimpedisce al canale di inviare una versione di downgrade ai dispositivi.--upgradepermette al canale di inviare una versione di upgrade (major) ai dispositivi.--no-upgradeimpedisce al canale di inviare una versione di upgrade (major) ai dispositivi.--iospermette al canale di inviare la versione ai dispositivi iOS.--no-iosimpedisce al canale di inviare la versione ai dispositivi iOS.--androidpermette al canale di inviare la versione ai dispositivi Android.--no-androidimpedisce al canale di inviare la versione ai dispositivi Android.--self-assignpermette ai dispositivi di auto-assegnarsi a questo canale.--no-self-assignimpedisce ai dispositivi di auto-assegnarsi a questo canale.--disable-auto-update STRATEGYDisabilita la strategia di auto-update per questo canale. Le opzioni possibili sono: major, minor, patch, metadata, none.--apikey [key]la chiave API per collegarti al tuo account.
Disabilita la strategia di update
Sezione intitolata “Disabilita la strategia di update”Ci sono alcuni modi per gestire la disabilitazione degli update per le versioni troppo vecchie.
Capgo non può aggiornare il code nativo; pertanto, un update da una versione con il vecchio code nativo a una con il code nativo aggiornato non dovrebbe essere possibile.
Esistono un paio di modi per farlo.
Innanzitutto, la major strategia. Impedisce un update dalla baseline nativa 0.0.0 -> bundle di destinazione 1.0.0. Il major è il numero evidenziato (1.0.0 e 0.0.0).
La seconda è la minor strategia. Impedisce un aggiornamento quando il bundle di destinazione ha una major o minor diversa dalla baseline nativa del dispositivo, ad esempio 0.0.0 -> 1.1.0 oppure 1.1.0 -> 1.2.0.
La terza è la patch strategia. È stata aggiunta in capgo come modalità molto rigorosa. Se ne sconsiglia l'uso a meno che non se ne comprenda appieno il funzionamento.
Per accettare un aggiornamento, devono essere soddisfatte le seguenti condizioni:
- La major è la stessa tra il bundle di destinazione e
version_build - La minor è la stessa tra il bundle di destinazione e
version_build - La patch è la stessa tra il bundle di destinazione e
version_build - Può differire solo il suffisso della versione, come prerelease (
-beta.2) o i metadati di build (+build.2)
Ecco un esempio degli scenari in cui l'aggiornamento è consentito o negato
- 1.0.0-beta.1 -> 1.0.0-beta.2 consentito
- 1.0.0+build.1 -> 1.0.0+build.2 consentito
- 1.0.0 -> 1.0.1 bloccato
- 1.0.0 -> 1.1.0 bloccato
- 1.0.0 -> 2.0.0 bloccato
Il confronto delle strategie utilizza la baseline nativa inviata come version_build, non con il bundle attualmente scaricato inviato come version_name.
Infine, la strategia più complessa. La metadata strategia.
Prima di tutto, devi sapere che inizialmente, dopo averlo abilitato, gli aggiornamenti SERVIRÀ fallirà perché il canale non dispone dei metadati richiesti.
Se al canale mancano i metadati, vedrai un messaggio come questo:
Se vedi qualcosa del genere, sai che devi andare al bundle attuale del canale che dà problemi e impostare i metadati.
Per prima cosa, individua il canale che dà problemi. Puoi farlo controllando la misconfigured colonna
Poi vai al canale che dà problemi e clicca su Bundle number. Verrai indirizzato alla pagina del bundle.
Una volta lì, compila il Minimal update version campo. Deve essere un valore semver.
Se il valore che passi non è un semver riceverai un errore, ma se tutto va a buon fine dovresti vedere qualcosa del genere:
Probabilmente non vorrai impostare questi dati manualmente ogni volta che aggiorni. Fortunatamente, CLI ti impedirà di inviare un aggiornamento senza questi metadati
Per caricare correttamente un bundle quando usi l'opzione metadata opzione che devi passare --min-update-version con il un semver valido. Qualcosa del genere:
Il --min-update-version non è l'UNICO modo per gestire la compatibilità.
Esiste anche il --auto-min-update-version. Ecco come funziona.
Prima, controlla la versione attualmente caricata nel canale. Verifica la compatibilità come farebbe il comando bundle compatibility command.
Secondo, se la nuova versione è al 100% compatibile, riutilizza il min_update_version dalla versione più recente nel canale.
In caso contrario, imposta min_update_version al numero del bundle della versione appena caricata.
Riceverai sempre un'informazione su quale sia il min_update_version quando si usa questa opzione. Dovrebbe apparire così:
Se la nuova versione non è compatibile, dovrebbe apparire così
Crittografia end-to-end (Trustless)
Sezione intitolata “Crittografia end-to-end (Trustless)”Capgo supporta la crittografia end-to-end: il tuo bundle (code) viene crittografato prima di essere inviato al cloud e decrittografato sul dispositivo. Per farlo, devi generare una coppia di chiavi RSA; puoi usare il seguente comando per generarla.
Il sistema di crittografia combina RSA e AES: la chiave RSA viene usata per crittografare la chiave AES, che a sua volta crittografa il file.
Consulta di seguito per maggiori informazioni sul sistema di crittografia.
Schema di crittografia
Crea la chiave per la tua app
Sezione intitolata “Crea la chiave per la tua app”npx @capgo/cli key create
Facoltativamente, puoi fornire: --force per sovrascrivere la chiave esistente. Questo comando crea una coppia di chiavi nella tua app e ti chiederà di salvare la chiave privata in un luogo sicuro. Si consiglia di non commitare la chiave privata su git e di non condividerla con nessuno.
Dopo i test locali, rimuovi la chiave dal file di configurazione e aggiungila al passaggio CI con
key save
Salva la chiave nella config della tua app
Sezione intitolata “Salva la chiave nella configurazione dell’app”npx @capgo/cli key save
Facoltativamente, puoi fornire:
--key [/path/to/my/public_key] il percorso del file della tua chiave pubblica.
--key-data [publicKey] i dati della chiave pubblica, se vuoi usarli inline. Questo comando è utile se hai seguito il consiglio e non hai committato la chiave nella config della tua app.
Integrazione CI
Sezione intitolata “Integrazione CI”Per automatizzare il lavoro, ti consiglio di far eseguire all'action di GitHub il push sul nostro server
La nostra demo app
Sezione intitolata “La nostra demo app”Non dimenticare di configurare la variabile d'ambiente CI con la tua chiave API
Continua con i comandi
Sezione intitolata “Continua da Comandi”Se stai usando Comandi per pianificare le operazioni della dashboard e di API, collegalo a Panoramica API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, Chiavi API per i dettagli di implementazione delle chiavi API, Dispositivi per i dettagli di implementazione in Devices, e Bundle per il dettaglio di implementazione in Bundles.