đŠ Bundle
đŠ Manage Application Bundles for DĂ©ploiement in Capgo Cloud, including TĂ©lĂ©charger, compatibility checks, and Chiffrement.
âŹïž TĂ©lĂ©charger
Section titled â âŹïž TĂ©lĂ©chargerâAlias: u
npx @capgo/cli@latest bundle uploadâŹïž TĂ©lĂ©charger a Nouveau Application Bundle to Capgo Cloud for distribution. Version must be > 0.0.0 and unique. Deleted versions cannot be reused for SĂ©curitĂ©. External Option: Store only a URL link (useful for apps >200MB or privacy requirements). Capgo never inspects external content. Ajouter Chiffrement for trustless SĂ©curitĂ©.
Example:
npx @capgo/cli@latest bundle upload com.example.app --path ./dist --channel productionOptions:
| Param | Type | Description |
|---|---|---|
| -a, | string | Clé API to link to your Compte |
| -p, | string | Path of the folder to Télécharger, if not provided it will use the webDir set in capacitor.config |
| -c, | string | Canal to link to |
| -e, | string | Link to external URL instead of Télécharger to Capgo Cloud |
| âiv-session-key | string | Set the IV and session key for Bundle URL external |
| âs3-region | string | Region for your S3 bucket |
| âs3-apikey | string | ClĂ© API for your S3 endpoint |
| âs3-apisecret | string | API secret for your S3 endpoint |
| âs3-endpoint | string | URL of S3 endpoint |
| âs3-bucket-name | string | Name for your AWS S3 bucket |
| âs3-port | string | Port for your S3 endpoint |
| âno-s3-ssl | boolean | DĂ©sactiver SSL for S3 TĂ©lĂ©charger |
| âkey-v2 | string | Custom path for private signing key (v2 system) |
| âkey-data-v2 | string | Private signing key (v2 system) |
| âBundle-url | boolean | Prints Bundle URL into stdout |
| âno-key | boolean | Ignore signing key and send clear Mise Ă jour |
| âno-code-VĂ©rifier | boolean | Ignore checking if notifyAppReady() is called in source code and index present in root folder |
| âdisplay-iv-session | boolean | Show in the console the IV and session key used to encrypt the Mise Ă jour |
| -b, | string | Bundle Version number of the Bundle to Télécharger |
| âlink | string | Link to external resource (e.g. GitHub LibĂ©ration) |
| âcomment | string | Comment Ă propos this Version, could be a LibĂ©ration Remarque, a commit hash, a commit message, etc. |
| âmin-Mise Ă jour-Version | string | Minimal Version required to Mise Ă jour to this Version. Used only if the DĂ©sactiver auto Mise Ă jour is set to metadata in Canal |
| âauto-min-Mise Ă jour-Version | boolean | Set the min Mise Ă jour Version based on Natif packages |
| âignore-metadata-VĂ©rifier | boolean | Ignores the metadata (node_modules) VĂ©rifier when uploading |
| âignore-checksum-VĂ©rifier | boolean | Ignores the checksum VĂ©rifier when uploading |
| âtimeout | string | Timeout for the TĂ©lĂ©charger process in seconds |
| âmultipart | boolean | [ObsolĂšte] Use âtus instead. Uses multipart protocol for S3 uploads |
| âzip | boolean | TĂ©lĂ©charger the Bundle using zip to Capgo cloud (legacy) |
| âtus | boolean | TĂ©lĂ©charger the Bundle using TUS to Capgo cloud |
| âtus-chunk-size | string | Chunk size in bytes for TUS resumable uploads (default: auto) |
| âpartial | boolean | [ObsolĂšte] Use âdelta instead. TĂ©lĂ©charger incremental Mises Ă jour |
| âpartial-only | boolean | [ObsolĂšte] Use âdelta-only instead. TĂ©lĂ©charger only incremental Mises Ă jour, skip full Bundle |
| âdelta | boolean | TĂ©lĂ©charger incremental/differential Mises Ă jour to reduce bandwidth |
| âdelta-only | boolean | TĂ©lĂ©charger only delta Mises Ă jour without full Bundle (useful for large apps) |
| âChiffrĂ©-checksum | string | An ChiffrĂ© checksum (signature). Used only when uploading an external Bundle. |
| âauto-set-Bundle | boolean | Set the Bundle in capacitor.config.json |
| âdry-TĂ©lĂ©charger | boolean | Dry TĂ©lĂ©charger the Bundle process, mean it will not TĂ©lĂ©charger the files but Ajouter the row in database (Used by Capgo for internal Test) |
| âpackage-json | string | Paths to package.json files for monorepos (comma-separated) |
| ânode-modules | string | Paths to node_modules directories for monorepos (comma-separated) |
| âencrypt-partial | boolean | Encrypt delta Mise Ă jour files (auto-enabled for updater > 6.14.4) |
| âSupprimer-linked-Bundle-on-TĂ©lĂ©charger | boolean | Locates the currently linked Bundle in the Canal you are trying to TĂ©lĂ©charger to, and deletes it |
| âno-brotli-patterns | string | Files to exclude from Brotli compression (comma-separated globs, e.g., â.jpg,.pngâ) |
| âDĂ©sactiver-brotli | boolean | Completely DĂ©sactiver brotli compression even if updater Version supports it |
| âVersion-exists-ok | boolean | Exit successfully if Bundle Version already exists, useful for CI/CD workflows with monorepos |
| âself-assign | boolean | Allow Appareils to auto-join this Canal (Mises Ă jour Canal setting) |
| âsupa-host | string | Custom Supabase host URL (for self-hosting or Capgo DĂ©veloppement) |
| âsupa-anon | string | Custom Supabase anon key (for self-hosting) |
đ§Ș Compatibility
Section titled â đ§Ș Compatibilityânpx @capgo/cli@latest bundle compatibilityđ§Ș VĂ©rifier compatibility of a Bundle with a specific Canal in Capgo Cloud to ensure Mises Ă jour are safe.
Example:
npx @capgo/cli@latest bundle compatibility com.example.app --channel productionOptions:
| Param | Type | Description |
|---|---|---|
| -a, | string | Clé API to link to your Compte |
| -c, | string | Canal to Vérifier the compatibility with |
| âtext | boolean | Output text instead of emojis |
| âpackage-json | string | Paths to package.json files for monorepos (comma-separated) |
| ânode-modules | string | Paths to node_modules directories for monorepos (comma-separated) |
| âsupa-host | string | Custom Supabase host URL (for self-hosting or Capgo DĂ©veloppement) |
| âsupa-anon | string | Custom Supabase anon key (for self-hosting) |
đïž Supprimer
Section titled â đïž SupprimerâAlias: d
npx @capgo/cli@latest bundle deleteđïž Supprimer a specific Bundle from Capgo Cloud, optionally targeting a single Version.
Example:
npx @capgo/cli@latest bundle delete BUNDLE_ID com.example.appOptions:
| Param | Type | Description |
|---|---|---|
| -a, | string | Clé API to link to your Compte |
| âsupa-host | string | Custom Supabase host URL (for self-hosting or Capgo DĂ©veloppement) |
| âsupa-anon | string | Custom Supabase anon key (for self-hosting) |
đ List
Section titled â đ ListâAlias: l
npx @capgo/cli@latest bundle listđ List all Bundles uploaded for an Application in Capgo Cloud.
Example:
npx @capgo/cli@latest bundle list com.example.appOptions:
| Param | Type | Description |
|---|---|---|
| -a, | string | Clé API to link to your Compte |
| âsupa-host | string | Custom Supabase host URL (for self-hosting or Capgo DĂ©veloppement) |
| âsupa-anon | string | Custom Supabase anon key (for self-hosting) |
đ§č Cleanup
Section titled â đ§č CleanupâAlias: c
npx @capgo/cli@latest bundle cleanupđ§č Supprimer old Bundles in Capgo Cloud, keeping specified number of recent versions. Bundles linked to Canaux are preserved unless âignore-Canal is used.
Example:
npx @capgo/cli@latest bundle cleanup com.example.app --bundle=1.0 --keep=3Options:
| Param | Type | Description |
|---|---|---|
| -b, | string | Bundle Version number of the Application to Supprimer |
| -a, | string | Clé API to link to your Compte |
| -k, | string | Number of versions to keep |
| -f, | string | Force removal |
| âignore-Canal | boolean | Supprimer Bundles even if linked to Canaux (Avertissement: deletes Canaux too) |
| âsupa-host | string | Custom Supabase host URL (for self-hosting or Capgo DĂ©veloppement) |
| âsupa-anon | string | Custom Supabase anon key (for self-hosting) |
đ Encrypt
Section titled â đ Encryptânpx @capgo/cli@latest bundle encryptđ Encrypt a zip Bundle for secure external storage. Retourne ivSessionKey for TĂ©lĂ©charger/decryption. Get checksum using âBundle zip âjsonâ.
Example:
npx @capgo/cli@latest bundle encrypt ./myapp.zip CHECKSUMOptions:
| Param | Type | Description |
|---|---|---|
| âkey | string | Custom path for private signing key |
| âkey-data | string | Private signing key |
| -j, | string | Output in JSON |
đ Decrypt
Section titled â đ Decryptânpx @capgo/cli@latest bundle decryptđ Decrypt an ChiffrĂ© Bundle (mainly for Test). Prints base64 session key for verification.
Example:
npx @capgo/cli@latest bundle decrypt ./myapp_encrypted.zip CHECKSUMOptions:
| Param | Type | Description |
|---|---|---|
| âkey | string | Custom path for private signing key |
| âkey-data | string | Private signing key |
| âchecksum | string | Checksum of the Bundle, to verify the integrity of the Bundle |
đč Zip
Section titled â đč Zipânpx @capgo/cli@latest bundle zipđïž CrĂ©er a zip file of your Application Bundle. Retourne checksum for use with Chiffrement. Use âjson for machine-readable output.
Example:
npx @capgo/cli@latest bundle zip com.example.app --path ./distOptions:
| Param | Type | Description |
|---|---|---|
| -p, | string | Path of the folder to Télécharger, if not provided it will use the webDir set in capacitor.config |
| -b, | string | Bundle Version number to name the zip file |
| -n, | string | Name of the zip file |
| -j, | string | Output in JSON |
| âno-code-VĂ©rifier | boolean | Ignore checking if notifyAppReady() is called in source code and index present in root folder |
| âkey-v2 | boolean | Use Chiffrement v2 |
| âpackage-json | string | Paths to package.json files for monorepos (comma-separated) |