@capgo/cli 7.7.2 → 7.9.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -195,8 +195,10 @@ npx @capgo/cli@latest bundle upload com.example.app --path ./dist --channel prod
195
195
  | **--zip** | <code>boolean</code> | Upload the bundle using zip to Capgo cloud (legacy) |
196
196
  | **--tus** | <code>boolean</code> | Upload the bundle using TUS to Capgo cloud |
197
197
  | **--tus-chunk-size** | <code>string</code> | Chunk size for the TUS upload |
198
- | **--partial** | <code>boolean</code> | Upload partial files to Capgo cloud |
199
- | **--partial-only** | <code>boolean</code> | Upload only partial files to Capgo cloud, skip the zipped file, useful for big bundle |
198
+ | **--partial** | <code>boolean</code> | Upload partial files to Capgo cloud (deprecated, use --delta instead) |
199
+ | **--partial-only** | <code>boolean</code> | Upload only partial files to Capgo cloud, skip the zipped file, useful for big bundle (deprecated, use --delta-only instead) |
200
+ | **--delta** | <code>boolean</code> | Upload delta update to Capgo cloud (old name: --partial) |
201
+ | **--delta-only** | <code>boolean</code> | Upload only delta update to Capgo cloud, skip the zipped file, useful for big bundle (old name: --partial-only) |
200
202
  | **--encrypted-checksum** | <code>string</code> | An encrypted checksum (signature). Used only when uploading an external bundle. |
201
203
  | **--auto-set-bundle** | <code>boolean</code> | Set the bundle in capacitor.config.json |
202
204
  | **--dry-upload** | <code>boolean</code> | Dry upload the bundle process, mean it will not upload the files but add the row in database (Used by Capgo for internal testing) |
@@ -206,6 +208,8 @@ npx @capgo/cli@latest bundle upload com.example.app --path ./dist --channel prod
206
208
  | **--delete-linked-bundle-on-upload** | <code>boolean</code> | Locates the currently linked bundle in the channel you are trying to upload to, and deletes it |
207
209
  | **--no-brotli-patterns** | <code>string</code> | Glob patterns for files to exclude from brotli compression (comma-separated) |
208
210
  | **--disable-brotli** | <code>boolean</code> | Completely disable brotli compression even if updater version supports it |
211
+ | **--version-exists-ok** | <code>boolean</code> | Exit successfully if bundle version already exists, useful for CI/CD workflows with monorepos |
212
+ | **--self-assign** | <code>boolean</code> | Allow device to self-assign to this channel, this will update the channel, if not provided it will leave the channel as is |
209
213
  | **--supa-host** | <code>string</code> | Supabase host URL, for self-hosted Capgo or testing |
210
214
  | **--supa-anon** | <code>string</code> | Supabase anon token, for self-hosted Capgo or testing |
211
215
 
@@ -320,6 +324,8 @@ npx @capgo/cli@latest bundle encrypt
320
324
 
321
325
  🔒 Encrypt a zip bundle using the new encryption method for secure external storage or testing.
322
326
  Used with external sources or for testing, prints ivSessionKey for upload or decryption.
327
+ The command will return the ivSessionKey for upload or decryption.
328
+ The checksum is the checksum of the zip file, you can get it with the --json option of the zip command.
323
329
 
324
330
  **Example:**
325
331
 
@@ -366,6 +372,7 @@ npx @capgo/cli@latest bundle zip
366
372
 
367
373
  🗜️ Create a zip file of your app bundle for upload or local storage.
368
374
  Useful for preparing bundles before encryption or upload.
375
+ The command will return the checksum of the zip file, you can use it to encrypt the zip file with the --key-v2 option.
369
376
 
370
377
  **Example:**
371
378
 
@@ -563,6 +570,7 @@ npx @capgo/cli@latest channel add production com.example.app --default
563
570
  | Param | Type | Description |
564
571
  | -------------- | ------------- | -------------------- |
565
572
  | **-d,** | <code>string</code> | Set the channel as default |
573
+ | **--self-assign** | <code>boolean</code> | Allow device to self-assign to this channel |
566
574
  | **-a,** | <code>string</code> | API key to link to your account |
567
575
  | **--supa-host** | <code>string</code> | Supabase host URL, for self-hosted Capgo or testing |
568
576
  | **--supa-anon** | <code>string</code> | Supabase anon token, for self-hosted Capgo or testing |
@@ -696,13 +704,13 @@ npx @capgo/cli@latest channel set production com.example.app --bundle 1.0.0 --st
696
704
  npx @capgo/cli@latest key save
697
705
  ```
698
706
 
699
- 💾 Save a base64 encryption key in the Capacitor config, useful for CI environments.
707
+ 💾 Save the public key in the Capacitor config, useful for CI environments.
700
708
  Recommended not to commit the key for security.
701
709
 
702
710
  **Example:**
703
711
 
704
712
  ```bash
705
- npx @capgo/cli@latest key save --key ./path/to/key
713
+ npx @capgo/cli@latest key save --key ./path/to/key.pub
706
714
  ```
707
715
 
708
716
  **Options:**
@@ -721,6 +729,10 @@ npx @capgo/cli@latest key create
721
729
 
722
730
  🔨 Create a new encryption key pair for end-to-end encryption in Capgo Cloud.
723
731
  Do not commit or share the private key; save it securely.
732
+ This command will create a new key pair with the name .capgo_key_v2 and .capgo_key_v2.pub in the root of the project.
733
+ The public key is used to decrypt the zip file in the mobile app.
734
+ The public key will also be stored in the capacitor config. This is the one used in the mobile app. The file is just a backup.
735
+ The private key is used to encrypt the zip file in the CLI.
724
736
 
725
737
  **Example:**
726
738