Comandi

Utilizzo

Tutti i comandi dovrebbero essere eseguiti nella cartella del tuo progetto con capacitor acceso correttamente.

Capacitor Runtime nativo cross-platform per applicazioni web

Inizializzazione

npx @capgo/cli@latest init [apikey]

Questo metodo è qui per guidarti passo dopo passo.

Aggiungerà il tuo progetto a Capgo. Aggiungerà code al tuo progetto per validare l'aggiornamento. Allo stesso modo, costruirà il tuo progetto. Inoltre, caricherà il tuo progetto su Capgo. E ti aiuterà a verificare se l'aggiornamento funziona.

Accesso

npx @capgo/cli login [apikey]

Questo metodo è qui per ricordare per te. apikey Nota

Nota

utilizza --apikey=******** in qualsiasi comando per sovrascriverlo

Puoi fornire optionalmente:

--local Questo salverà il tuo apikey in il repository locale e lo ignorerà per il git.

Dottore

npx @capgo/cli doctor

Comando per verificare se sei aggiornato con Capgo pacchetti.

Questo comando sarà anche utile per i rapporti di bug.

App

Aggiungi

npx @capgo/cli app add [appId]

[appId] il tuo ID app nel formato com.test.app è spiegato qui.

💡 Tutte le opzioni verranno dedotte nella tua configurazione se non fornite.

Facoltativamente, puoi fornire:

• --icon [/path/to/my/icon] to have a custom icon display in Capgo web app.
• --name [test] per avere un nome personalizzato nella lista.
• --apikey [key] API chiave per collegare il tuo account.
• --retention [retention] periodo di conservazione del pacchetto app in giorni, 0 di default = infinito.

Esempio di capacitor.config.json per appId e AppName, l'icona viene cercata nella cartella risorse

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

Impostazioni

npx @capgo/cli app set [appId]

[appId] è il tuo ID app, il formato viene spiegato qui.

Opzionalmente, puoi fornire:

• --icon [/path/to/my/icon] per avere un'icona personalizzata nella Capgo app web.
• --name [test] per avere un nome personalizzato nella lista.
• --retention [retention] periodo di conservazione del bundle dell'app in giorni, 0 per impostazione predefinita = infinito.
• --apikey [key] API chiave per collegarsi al tuo account.

Elenco

npx @capgo/cli app list [appId]

[appId] inserisci il tuo ID dell'applicazione nel formato com.test.app è spiegato qui.

Facoltativamente, puoi fornire:

• --apikey [key] API chiave per collegare il tuo account.

Elimina

npx @capgo/cli app delete [appId]

[appId] inserisci il tuo ID dell'applicazione nel formato com.test.app è spiegato qui.

Facoltativamente, puoi fornire:

• --apikey [key] chiave API per collegarsi al proprio account.
• --bundle con il numero di versione eliminerà solo questa versione.

Debug

npx @capgo/cli app debug [appId]

[appId] il proprio ID dell'applicazione nel formato com.test.app è spiegato qui.

Facoltativamente, si può fornire:

• --apikey [key] chiave API per collegarsi al proprio account.
• --device con il dispositivo specifico che si desidera debuggare

Impostazioni

npx @capgo/cli app setting [path]

Modifica la Capacitor configurazione.

[path] - percorso della impostazione che desideri modificare. Ad esempio, per modificare il appId, fornisce appId Se desideri disabilitare l'aggiornamento automatico nel capacitor-updater fornisci plugins.CapacitorUpdater.autoUpdate

Devi fornire necessariamente --string o --bool!

Opzioni:

• --string <string> - imposta la impostazione a una stringa
• --bool <true | false> - imposta la impostazione a un booleano

Bundle

Carica

npx @capgo/cli bundle upload [appId]

[appId] è il tuo ID applicazione, il formato è spiegato qui.

Opzionalmente, puoi fornire:

• --apikey <apikey> API chiave per collegarsi al tuo account.
• --path <path> Percorso del folder da caricare.
• --channel <channel> Canale per collegarsi.
• --external <url> Collega a un URL esterno al posto di caricare su Capgo Cloud.
• --iv-session-key <key> Imposta la chiave di IV e sessione per l'URL del pacchetto esterno.
• --s3-endpoint <s3Endpoint> Indirizzo URL del endpoint S3. Non funziona con le opzioni di caricamento delta o esterno.
• --s3-region <region> Regione per il tuo bucket S3.
• --s3-apikey <apikey> API chiave per il tuo endpoint S3.
• --s3-apisecret <apisecret> API segreto per il tuo endpoint S3.
• --s3-bucket-name <bucketName> Nome per il tuo bucket S3 AWS.
• --s3-port <port> Porta per il tuo endpoint S3.
• --no-s3-ssl Disabilita SSL per l'upload 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-url Stampa l'URL del pacchetto nella stdout.
• --no-key Ignora la chiave di firma e invia l'aggiornamento chiaro.
• --no-code-check Ignora la verifica se notifyAppReady() è chiamato nel file sorgente code e l'indice presente nella cartella radice.
• --display-iv-session Visualizza in console la chiave IV e di sessione utilizzate per cifrare l'aggiornamento.
• --bundle <bundle> Numero di versione del bundle da caricare.
• --min-update-version <minUpdateVersion> Versione minima richiesta per aggiornarsi a questa versione. Utilizzato solo se l'aggiornamento automatico è disabilitato tramite canale.
• --auto-min-update-version Imposta la versione minima di aggiornamento in base ai pacchetti nativi.
• --ignore-metadata-check Ignora il controllo dei metadati (node_modules) durante l'upload.
• --ignore-checksum-check Ignora il controllo del checksum durante l'upload.
• --timeout <timeout> Timeout per il processo di upload in secondi.
• --delta Carica i file Delta (manifest) insieme al bundle completo.
• --delta-only Carica solo gli aggiornamenti Delta (manifest), saltando il bundle completo.
• --no-delta Disabilita le upload Delta (manifest) (utile se è abilitato ma desideri un bundle completo). directUpdate Carica il bundle utilizzando il protocollo tus.
• --tus __CAPGO_KEEP_0__
• --multipart Utilizza il protocollo multipart per caricare i dati su S3, Obsoleto, utilizza TUS al suo posto.
• --encrypted-checksum <encryptedChecksum> Un calcolo crittografato (firma). Utilizzato solo quando si carica un bundle esterno.
• --package-json <packageJson> Un percorso per package.json. Utile per i monorepositori.
• --auto-set-bundle Imposta il bundle in capacitor.config.json.
• --node-modules <nodeModules> Una lista di percorsi per node_modules. Utile per i monorepositori (separati da virgole ad esempio: ../../node_modules,./node_modules)

⭐️ L'opzione esterna aiuta a sbloccare 2 casi: aziende con preoccupazioni sulla privacy, non inviare il code a un terzo partito e applicazioni più grandi di 200 MB. Con questa impostazione, Capgo archivia solo il collegamento al file zip e invia il collegamento a tutte le applicazioni.

👀 Il cloud di Capgo non guarda mai cosa c'è nel collegamento (per l'opzione esterna), o in code quando archiviato.

🔑 Puoi aggiungere un secondo strato di sicurezza utilizzando la crittografia, quindi Capgo non potrà più guardare o modificare nulla, diventa “non fiduciario”.

Esempio di package.json per versione

{
  "version": "1.0.2"
}

⛔ La versione dovrebbe essere maggiore di “0.0.0”.

💡 Non dimenticare di aggiornare il numero di versione ogni volta che lo invii, il numero di versione non può essere sovrascritto o riutilizzato dopo la cancellazione per motivi di sicurezza.

Elenco

npx @capgo/cli bundle list [appId]

[appId] il tuo ID dell'applicazione nel formato com.test.app è spiegato Qui.

Opzionalmente, puoi fornire:

• --apikey [key] API chiave per collegarsi al tuo account.

Elimina

npx @capgo/cli bundle delete [appId]

[appId] il tuo ID dell'applicazione nel formato com.test.app è spiegato qui.

Facoltativamente, puoi fornire:

• --apikey [key] API chiave per collegarsi al tuo account.
• --bundle con il numero di versione eliminerà solo questa versione.

Pulizia

in un intervallo SemVer per una versione maggiore a Cloud

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

[appId] il tuo ID app nel formato com.test.app è spiegato qui.

Facoltativamente, puoi fornire:

• --apikey [key] API chiave per collegarsi al tuo account.
• --bundle [majorVersion] a version che desideri rimuovere i pacchetti precedenti, terrà l'ultimo + numberToKeep.
• --keep [numberToKeep] il numero di pacchetti che desideri mantenere (di default 4).

Esempio: Se hai 10 versioni da 10.0.1 a 10.0.11, e utilizzi npx @capgo/cli cleanup [appId] --bundle=10.0.0 terrà 10.0.7 fino a 10.0.11. 10.0.1 a 10.0.6 verranno rimossi.

Se hai 20 versioni in totale, e non fornisci un numero di bundle come questo: npx @capgo/cli cleanup [appId] --keep=2 Rimuoverà 18 versioni, e terrà le ultime 2.

Questo comando chiederà conferma, mostra una tabella di cosa terrà e rimuoverà.

Nota

Questo comando ignorerà i bundle che sono attualmente in uso in qualsiasi canale.

Crittografare

Avviso: Questo comando è deprecato e verrà eliminato nella prossima versione maggiore. Si prega di utilizzare il nuovo sistema di crittografia. npx @capgo/cli bundle encrypt [path/to/zip]

Questo comando viene utilizzato quando si utilizza una fonte esterna per memorizzare il tuo code o per scopi di test.

Facoltativamente, puoi fornire:

--key [/path/to/my/private_key] la percorso della tua chiave privata. --key-data [privateKey] i dati della chiave privata, se desideri utilizzare inline. Il comando stampa il tuo ivSessionKeyy e genera un file zip crittografato, da utilizzare con il comando di caricamento o il comando di decrittazione.

Crittografa V2

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

Questo comando viene utilizzato quando si utilizza una fonte esterna per memorizzare il tuo code o per scopi di test. Il checksum è lo sha256 del bundle (generato da —key-v2), utilizzato per verificare l'integrità del file dopo la decrittazione. Verrà crittografato con la chiave privata e inviato insieme al bundle. Nella crittografia v2 il checksum viene aggiornato per diventare una “firma” del bundle.

Facoltativamente, puoi fornire:

--key [/path/to/my/private_key] la percorso della tua chiave privata. --key-data [privateKey] i dati della chiave privata, se desideri utilizzarli inline. --json per stampare le informazioni in formato JSON. ivSessionKeyIl comando stampa il tuo

y e genera un zip crittografato, per utilizzarlo con il comando di upload o il comando di decrittografia.

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

Sezione intitolata “Decrittografa”

--key [/path/to/my/private_key] Puoi fornire optionalmente:

--key-data [privateKey] la strada del tuo file di chiave privata.

i dati della chiave privata, se desideri utilizzarli inline. Questo comando è principalmente utilizzato per scopi di test, decrittografa il zip e stampa la chiave di sessione base64 decrittografata nella console.

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

Sezione intitolata “Decrittografa V2”

--key [/path/to/my/private_key] Puoi fornire optionalmente: --key-data [privateKey] Dati della chiave privata, se desideri utilizzarli in linea. Questo comando è principalmente utilizzato per scopi di test, decifrerà il zip e stampa la chiave di sessione decifrata in base64 nel console. --checksum [checksum] il checksum del file, verificherà il checksum dopo la decifrazione.

Zip

npx @capgo/cli bundle zip [appId]

[appId] è il tuo ID app, il formato è spiegato qui.

Opzionalmente, puoi dare:

• --path [/path/to/my/bundle] per caricare una cartella specifica.
• --bundle [1.0.0] per impostare il numero di versione del bundle nel nome del file.
• --name [myapp] per sovrascrivere il nome del file.
• --json per stampare le informazioni in formato JSON.
• --no-code-check per ignorare il controllo code e inviare il bundle comunque.
• --key-v2 per utilizzare il nuovo sistema di crittografia. Questo è richiesto poiché il nuovo sistema di crittografia utilizza checksum migliori per verificare l'integrità del file.

Compatibilità

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

[appId] qui il nome del tuo nuovo canale.. [channelId] Facoltativamente, puoi fornire:

__CAPGO_KEEP_0__ chiave per collegarsi al tuo account.

• --apikey [key] API key to link to your account.
• --text il canale da controllare la compatibilità con.
• --channel [channel] Un percorso a package.json. Utile per i monorepos
• --package-json <packageJson> Una lista di percorsi a node_modules. Utile per i monorepos (separati da virgole ad esempio: ../../node_modules,./node_modules)
• --node-modules <nodeModules> Una lista di percorsi a node_modules. Utile per i monorepos (separati da virgole ad esempio: ../../node_modules,./node_modules)

Canale

Aggiungi

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

[channelId] il nome del tuo nuovo canale. [appId] il tuo ID app nel formato com.test.app è spiegato qui.

Elimina

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

[channelId] il nome del tuo canale che vuoi eliminare. [appId] il tuo ID app nel formato com.test.app è spiegato qui.

Elenco

npx @capgo/cli channel list [appId]

[appId] inserisci il tuo ID app nel formato com.test.app è spiegato qui.

Se desideri, puoi fornire:

• --apikey [key] API chiave per collegare il tuo account.

Impostazione

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

[appId] è il tuo ID app, il formato è spiegato qui.

Opzionalmente, puoi fornire:

• --bundle [1.2.3] il tuo bundle dell'app già inviato in cloud, per collegarlo a un canale.
• --latest ottenere la versione del bundle da package.json:version, non può essere utilizzato con --bundle.
• --state [ normal | default ] impostare lo stato del canale, può essere normal o default. Un canale deve essere default.
• --downgrade consente al canale di inviare versione di downgrade ai dispositivi.
• --no-downgrade disabilita il canale di inviare versione di downgrade ai dispositivi.
• --upgrade consente al canale di inviare versione di upgrade (maggiore) ai dispositivi.
• --no-upgrade disabilita il canale di inviare versione di upgrade (maggiore) ai dispositivi.
• --ios consente al canale di inviare la versione ai dispositivi iOS.
• --no-ios impedisce al canale di inviare la versione ai dispositivi iOS.
• --android consente al canale di inviare la versione ai dispositivi Android.
• --no-android impedisce al canale di inviare la versione ai dispositivi Android.
• --self-assign consente ai dispositivi di assegnarsi automaticamente a questo canale.
• --no-self-assign impedisce ai dispositivi di assegnarsi automaticamente a questo canale.
• --disable-auto-update STRATEGY Disabilita la strategia di aggiornamento automatico per questo canale. Le opzioni possibili sono: major, minor, metadata, none.
• --apikey [key] API chiave per collegarsi al proprio account.

Disabilita la strategia di aggiornamento.

Ci sono pochi modi per gestire la disabilitazione degli aggiornamenti per versioni troppo vecchie.
Capgo non può aggiornare il nativo code quindi un aggiornamento da una versione con il nativo code vecchio a una versione con il nativo code aggiornato non dovrebbe essere possibile. Ci sono un paio di modi per raggiungere questo risultato.

Prima, la major Previene un aggiornamento da 0.0.0 -> 1.0.0Il numero maggiore è il numero evidenziato (10.0 e 0.0.0).
Secondo è la minor Previene un aggiornamento da 0.0.0 -> 1.1.0 o un aggiornamento da 1.1.0 ATTENZIONE 1.2.0. Questa strategia non previene un aggiornamento da Terzo, la 0.1.0 -> 1.1.0

Previene un aggiornamento da patch strategy. It was added into capgo as a very strict mode. It’s not recommended to be used unless you fully understand how it works. In order for it to accept a update the following conditions must be meet:

• The major è lo stesso tra la nuova e la vecchia versione
• The minor è lo stesso tra la nuova e la vecchia versione
• Il patch della nuova versione è maggiore del patch della vecchia versione

Ecco un esempio di quali scenari l'aggiornamento è consentito o negato

• 0.0.311 -> 0.0.314 ✅
• 0.0.0 -> 0.0.314 ✅
• 0.0.316 -> 0.0.314 ❌
• 0.1.312 -> 0.0.314 ❌
• 1.0.312 -> 0.0.314 ❌

Infine la strategia più complessa. La metadata strategia.
Innanzitutto devi sapere che inizialmente dopo averlo abilitato gli aggiornamenti WILL falliranno poiché il canale manca dei dati di metadati richiesti.
Se il canale manca di metadati vedrai un messaggio come questo:

Se vedi qualcosa di questo tipo sai che devi andare al bundle corrente del canale che sta fallendo e impostare i metadati.
In primo luogo, determina quale canale sta fallendo. Puoi farlo osservando la misconfigured colonna

Poi vai al canale che sta fallendo e clicca su Bundle number. Ciò dovrebbe portarti alla pagina del pacchetto.

Una volta lì, riempi il Minimal update version campo. Questo dovrebbe essere un semver.
Se il valore che passi non è un semver, otterrai un errore, ma se tutto va correttamente dovresti vedere qualcosa come questo:

Ora, probabilmente non desideri impostare manualmente questo dato ogni volta che aggiorni. Fortunatamente, il CLI impedirà di inviare un aggiornamento senza questo metadato

Per caricare correttamente un bundle quando si utilizza l' metadata opzione è necessario passare il --min-update-version con il semver valido. Qualcosa di questo tipo:

Il --min-update-version non è l'UNICO modo per fare la compatibilità. Esiste anche il --auto-min-update-version. Ecco come funziona.

In primo luogo, prende in considerazione la versione attualmente caricata sul canale. Verifica la compatibilità allo stesso modo del bundle compatibility comando. min_update_version In secondo luogo, se la nuova versione è del 100% compatibile, riprende il min_update_version dalla versione più recente nel canale. Se non, allora imposta il

You riceverai sempre informazioni su cosa è il min_update_version quando si utilizza questa opzione. Assumerà l'aspetto seguente:

Se la nuova versione non è compatibile dovrebbe assomigliare a questo:

Crittografia end-to-end (Senza fiducia)

Capgo supporta la crittografia end-to-end, ciò significa che il tuo bundle (code) viene crittografato prima di essere inviato in cloud e decrittografato sul dispositivo. Per questo, è necessario generare una coppia di chiavi RSA, puoi utilizzare il seguente comando per generarle.

Il sistema di crittografia è una combinazione di RSA e AES, la chiave RSA viene utilizzata per crittografare la chiave AES, e la chiave AES viene utilizzata per crittografare il file.

Ecco di seguito ulteriori informazioni sul sistema di crittografia.

Schema di crittografia

Creare una chiave per il tuo app

npx @capgo/cli key create

Se lo desideri, puoi fornire: --force per sovrascrivere la chiave esistente. Questo comando creerà per te una coppia di chiavi nel tuo app, e chiederà di salvare la chiave privata in un luogo sicuro. È consigliabile non committare la chiave privata nel file di configurazione, e non condividerla con nessuno.

Dopo aver effettuato il test locale, rimuovi la chiave dal file di configurazione e aggiungila nel passaggio CI con key save

Salva la chiave nel file di configurazione del tuo app

npx @capgo/cli key save

Se lo desideri, puoi fornire:

--key [/path/to/my/public_key] il percorso del file della chiave pubblica.

--key-data [publicKey] i dati della chiave pubblica, se desideri utilizzare inline. Questo comando è utile se hai seguito la raccomandazione e non hai commesso la chiave nel file di configurazione del tuo app.

Integrazione CI

Per automatizzare il tuo lavoro, ti consiglio di fare in modo che l'azione GitHub esegua il lavoro di invio sul nostro server

La guida per l'azione GitHub

La nostra demo app

GitHub - Cap-go/demo-app

Non dimenticare di configurare la variabile di ambiente CI con la tua chiave API