@capgo/cli 7.14.5 โ†’ 7.15.1

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
@@ -83,8 +83,8 @@ npx @capgo/cli@latest init YOUR_API_KEY com.example.app
83
83
  | -------------- | ------------- | -------------------- |
84
84
  | **-n,** | <code>string</code> | App name for display in Capgo Cloud |
85
85
  | **-i,** | <code>string</code> | App icon path for display in Capgo Cloud |
86
- | **--supa-host** | <code>string</code> | Supabase host URL for custom setups |
87
- | **--supa-anon** | <code>string</code> | Supabase anon token for custom setups |
86
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
87
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
88
88
 
89
89
 
90
90
  ## <a id="doctor"></a> ๐Ÿ‘จโ€โš•๏ธ **Doctor**
@@ -106,7 +106,7 @@ npx @capgo/cli@latest doctor
106
106
 
107
107
  | Param | Type | Description |
108
108
  | -------------- | ------------- | -------------------- |
109
- | **--package-json** | <code>string</code> | A list of paths to package.json. Useful for monorepos (comma separated ex: ../../package.json,./package.json) |
109
+ | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
110
110
 
111
111
 
112
112
  ## <a id="login"></a> ๐Ÿ”‘ **Login**
@@ -131,8 +131,8 @@ npx @capgo/cli@latest login YOUR_API_KEY
131
131
  | Param | Type | Description |
132
132
  | -------------- | ------------- | -------------------- |
133
133
  | **--local** | <code>boolean</code> | Only save in local folder, git ignored for security. |
134
- | **--supa-host** | <code>string</code> | Supabase host URL for custom setups |
135
- | **--supa-anon** | <code>string</code> | Supabase anon token for custom setups |
134
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
135
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
136
136
 
137
137
 
138
138
  ## <a id="bundle"></a> ๐Ÿ“ฆ **Bundle**
@@ -147,18 +147,10 @@ npx @capgo/cli@latest login YOUR_API_KEY
147
147
  npx @capgo/cli@latest bundle upload
148
148
  ```
149
149
 
150
- โฌ†๏ธ Upload a new app bundle to Capgo Cloud for distribution, optionally linking to a channel or external URL.
151
- External option supports privacy concerns or large apps (>200MB) by storing only the link.
152
- Capgo never inspects external content. Encryption adds a trustless security layer.
153
- Version must be > 0.0.0 and unique.
154
- > โ„น๏ธ External option helps with corporate privacy concerns and apps larger than 200MB by storing only the link.
155
-
156
- > โ„น๏ธ Capgo Cloud never looks at the content in the link for external options or in the code when stored.
157
-
158
- > โ„น๏ธ You can add a second layer of security with encryption, making Capgo trustless.
159
-
160
- > โ„น๏ธ Version should be greater than "0.0.0" and cannot be overridden or reused after deletion for security reasons.
161
-
150
+ โฌ†๏ธ Upload a new app bundle to Capgo Cloud for distribution.
151
+ Version must be > 0.0.0 and unique. Deleted versions cannot be reused for security.
152
+ External option: Store only a URL link (useful for apps >200MB or privacy requirements).
153
+ Capgo never inspects external content. Add encryption for trustless security.
162
154
 
163
155
  **Example:**
164
156
 
@@ -196,27 +188,27 @@ npx @capgo/cli@latest bundle upload com.example.app --path ./dist --channel prod
196
188
  | **--ignore-metadata-check** | <code>boolean</code> | Ignores the metadata (node_modules) check when uploading |
197
189
  | **--ignore-checksum-check** | <code>boolean</code> | Ignores the checksum check when uploading |
198
190
  | **--timeout** | <code>string</code> | Timeout for the upload process in seconds |
199
- | **--multipart** | <code>boolean</code> | Uses multipart protocol to upload data to S3, Deprecated, use tus instead |
191
+ | **--multipart** | <code>boolean</code> | [DEPRECATED] Use --tus instead. Uses multipart protocol for S3 uploads |
200
192
  | **--zip** | <code>boolean</code> | Upload the bundle using zip to Capgo cloud (legacy) |
201
193
  | **--tus** | <code>boolean</code> | Upload the bundle using TUS to Capgo cloud |
202
- | **--tus-chunk-size** | <code>string</code> | Chunk size for the TUS upload |
203
- | **--partial** | <code>boolean</code> | Upload partial files to Capgo cloud (deprecated, use --delta instead) |
204
- | **--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) |
205
- | **--delta** | <code>boolean</code> | Upload delta update to Capgo cloud (old name: --partial) |
206
- | **--delta-only** | <code>boolean</code> | Upload only delta update to Capgo cloud, skip the zipped file, useful for big bundle (old name: --partial-only) |
194
+ | **--tus-chunk-size** | <code>string</code> | Chunk size in bytes for TUS resumable uploads (default: auto) |
195
+ | **--partial** | <code>boolean</code> | [DEPRECATED] Use --delta instead. Upload incremental updates |
196
+ | **--partial-only** | <code>boolean</code> | [DEPRECATED] Use --delta-only instead. Upload only incremental updates, skip full bundle |
197
+ | **--delta** | <code>boolean</code> | Upload incremental/differential updates to reduce bandwidth |
198
+ | **--delta-only** | <code>boolean</code> | Upload only delta updates without full bundle (useful for large apps) |
207
199
  | **--encrypted-checksum** | <code>string</code> | An encrypted checksum (signature). Used only when uploading an external bundle. |
208
200
  | **--auto-set-bundle** | <code>boolean</code> | Set the bundle in capacitor.config.json |
209
201
  | **--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) |
210
- | **--package-json** | <code>string</code> | A list of paths to package.json. Useful for monorepos (comma separated ex: ../../package.json,./package.json) |
211
- | **--node-modules** | <code>string</code> | A list of paths to node_modules. Useful for monorepos (comma separated ex: ../../node_modules,./node_modules) |
212
- | **--encrypt-partial** | <code>boolean</code> | Encrypt the partial update files (automatically applied for updater > 6.14.4) |
202
+ | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
203
+ | **--node-modules** | <code>string</code> | Paths to node_modules directories for monorepos (comma-separated) |
204
+ | **--encrypt-partial** | <code>boolean</code> | Encrypt delta update files (auto-enabled for updater > 6.14.4) |
213
205
  | **--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 |
214
- | **--no-brotli-patterns** | <code>string</code> | Glob patterns for files to exclude from brotli compression (comma-separated) |
206
+ | **--no-brotli-patterns** | <code>string</code> | Files to exclude from Brotli compression (comma-separated globs, e.g., "*.jpg,*.png") |
215
207
  | **--disable-brotli** | <code>boolean</code> | Completely disable brotli compression even if updater version supports it |
216
208
  | **--version-exists-ok** | <code>boolean</code> | Exit successfully if bundle version already exists, useful for CI/CD workflows with monorepos |
217
- | **--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 |
218
- | **--supa-host** | <code>string</code> | Supabase host URL, for self-hosted Capgo or testing |
219
- | **--supa-anon** | <code>string</code> | Supabase anon token, for self-hosted Capgo or testing |
209
+ | **--self-assign** | <code>boolean</code> | Allow devices to auto-join this channel (updates channel setting) |
210
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
211
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
220
212
 
221
213
  ### <a id="bundle-compatibility"></a> ๐Ÿงช **Compatibility**
222
214
 
@@ -239,10 +231,10 @@ npx @capgo/cli@latest bundle compatibility com.example.app --channel production
239
231
  | **-a,** | <code>string</code> | API key to link to your account |
240
232
  | **-c,** | <code>string</code> | Channel to check the compatibility with |
241
233
  | **--text** | <code>boolean</code> | Output text instead of emojis |
242
- | **--package-json** | <code>string</code> | A list of paths to package.json. Useful for monorepos (comma separated ex: ../../package.json,./package.json) |
243
- | **--node-modules** | <code>string</code> | A list of paths to node_modules. Useful for monorepos (comma separated ex: ../../node_modules,./node_modules) |
244
- | **--supa-host** | <code>string</code> | Supabase host URL for custom setups |
245
- | **--supa-anon** | <code>string</code> | Supabase anon token for custom setups |
234
+ | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
235
+ | **--node-modules** | <code>string</code> | Paths to node_modules directories for monorepos (comma-separated) |
236
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
237
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
246
238
 
247
239
  ### <a id="bundle-delete"></a> ๐Ÿ—‘๏ธ **Delete**
248
240
 
@@ -265,8 +257,8 @@ npx @capgo/cli@latest bundle delete BUNDLE_ID com.example.app
265
257
  | Param | Type | Description |
266
258
  | -------------- | ------------- | -------------------- |
267
259
  | **-a,** | <code>string</code> | API key to link to your account |
268
- | **--supa-host** | <code>string</code> | Supabase host URL for custom setups |
269
- | **--supa-anon** | <code>string</code> | Supabase anon token for custom setups |
260
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
261
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
270
262
 
271
263
  ### <a id="bundle-list"></a> ๐Ÿ“‹ **List**
272
264
 
@@ -289,8 +281,8 @@ npx @capgo/cli@latest bundle list com.example.app
289
281
  | Param | Type | Description |
290
282
  | -------------- | ------------- | -------------------- |
291
283
  | **-a,** | <code>string</code> | API key to link to your account |
292
- | **--supa-host** | <code>string</code> | Supabase host URL for custom setups |
293
- | **--supa-anon** | <code>string</code> | Supabase anon token for custom setups |
284
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
285
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
294
286
 
295
287
  ### <a id="bundle-cleanup"></a> ๐Ÿงน **Cleanup**
296
288
 
@@ -300,8 +292,8 @@ npx @capgo/cli@latest bundle list com.example.app
300
292
  npx @capgo/cli@latest bundle cleanup
301
293
  ```
302
294
 
303
- ๐Ÿงน Cleanup old bundles in Capgo Cloud, keeping a specified number of recent versions or those linked to channels.
304
- Ignores bundles in use.
295
+ ๐Ÿงน Delete old bundles in Capgo Cloud, keeping specified number of recent versions.
296
+ Bundles linked to channels are preserved unless --ignore-channel is used.
305
297
 
306
298
  **Example:**
307
299
 
@@ -317,9 +309,9 @@ npx @capgo/cli@latest bundle cleanup com.example.app --bundle=1.0 --keep=3
317
309
  | **-a,** | <code>string</code> | API key to link to your account |
318
310
  | **-k,** | <code>string</code> | Number of versions to keep |
319
311
  | **-f,** | <code>string</code> | Force removal |
320
- | **--ignore-channel** | <code>boolean</code> | Delete all versions even if linked to a channel, this will delete channel as well |
321
- | **--supa-host** | <code>string</code> | Supabase host URL for custom setups |
322
- | **--supa-anon** | <code>string</code> | Supabase anon token for custom setups |
312
+ | **--ignore-channel** | <code>boolean</code> | Delete bundles even if linked to channels (WARNING: deletes channels too) |
313
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
314
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
323
315
 
324
316
  ### <a id="bundle-encrypt"></a> ๐Ÿ”’ **Encrypt**
325
317
 
@@ -327,10 +319,8 @@ npx @capgo/cli@latest bundle cleanup com.example.app --bundle=1.0 --keep=3
327
319
  npx @capgo/cli@latest bundle encrypt
328
320
  ```
329
321
 
330
- ๐Ÿ”’ Encrypt a zip bundle using the new encryption method for secure external storage or testing.
331
- Used with external sources or for testing, prints ivSessionKey for upload or decryption.
332
- The command will return the ivSessionKey for upload or decryption.
333
- The checksum is the checksum of the zip file, you can get it with the --json option of the zip command.
322
+ ๐Ÿ”’ Encrypt a zip bundle for secure external storage.
323
+ Returns ivSessionKey for upload/decryption. Get checksum using 'bundle zip --json'.
334
324
 
335
325
  **Example:**
336
326
 
@@ -352,8 +342,8 @@ npx @capgo/cli@latest bundle encrypt ./myapp.zip CHECKSUM
352
342
  npx @capgo/cli@latest bundle decrypt
353
343
  ```
354
344
 
355
- ๐Ÿ”“ Decrypt a zip bundle using the new encryption method, mainly for testing purposes.
356
- Prints the base64 decrypted session key for verification.
345
+ ๐Ÿ”“ Decrypt an encrypted bundle (mainly for testing).
346
+ Prints base64 session key for verification.
357
347
 
358
348
  **Example:**
359
349
 
@@ -375,9 +365,8 @@ npx @capgo/cli@latest bundle decrypt ./myapp_encrypted.zip CHECKSUM
375
365
  npx @capgo/cli@latest bundle zip
376
366
  ```
377
367
 
378
- ๐Ÿ—œ๏ธ Create a zip file of your app bundle for upload or local storage.
379
- Useful for preparing bundles before encryption or upload.
380
- The command will return the checksum of the zip file, you can use it to encrypt the zip file with the --key-v2 option.
368
+ ๐Ÿ—œ๏ธ Create a zip file of your app bundle.
369
+ Returns checksum for use with encryption. Use --json for machine-readable output.
381
370
 
382
371
  **Example:**
383
372
 
@@ -395,7 +384,7 @@ npx @capgo/cli@latest bundle zip com.example.app --path ./dist
395
384
  | **-j,** | <code>string</code> | Output in JSON |
396
385
  | **--no-code-check** | <code>boolean</code> | Ignore checking if notifyAppReady() is called in source code and index present in root folder |
397
386
  | **--key-v2** | <code>boolean</code> | Use encryption v2 |
398
- | **--package-json** | <code>string</code> | A list of paths to package.json. Useful for monorepos (comma separated ex: ../../package.json,./package.json) |
387
+ | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
399
388
 
400
389
 
401
390
  ## <a id="app"></a> ๐Ÿ“ฑ **App**
@@ -426,8 +415,8 @@ npx @capgo/cli@latest app add com.example.app --name "My App" --icon ./icon.png
426
415
  | **-n,** | <code>string</code> | App name for display in Capgo Cloud |
427
416
  | **-i,** | <code>string</code> | App icon path for display in Capgo Cloud |
428
417
  | **-a,** | <code>string</code> | API key to link to your account |
429
- | **--supa-host** | <code>string</code> | Supabase host URL for custom setups |
430
- | **--supa-anon** | <code>string</code> | Supabase anon token for custom setups |
418
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
419
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
431
420
 
432
421
  ### <a id="app-delete"></a> ๐Ÿ—‘๏ธ **Delete**
433
422
 
@@ -448,8 +437,8 @@ npx @capgo/cli@latest app delete com.example.app
448
437
  | Param | Type | Description |
449
438
  | -------------- | ------------- | -------------------- |
450
439
  | **-a,** | <code>string</code> | API key to link to your account |
451
- | **--supa-host** | <code>string</code> | Supabase host URL for custom setups |
452
- | **--supa-anon** | <code>string</code> | Supabase anon token for custom setups |
440
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
441
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
453
442
 
454
443
  ### <a id="app-list"></a> ๐Ÿ“‹ **List**
455
444
 
@@ -472,8 +461,8 @@ npx @capgo/cli@latest app list
472
461
  | Param | Type | Description |
473
462
  | -------------- | ------------- | -------------------- |
474
463
  | **-a,** | <code>string</code> | API key to link to your account |
475
- | **--supa-host** | <code>string</code> | Supabase host URL for custom setups |
476
- | **--supa-anon** | <code>string</code> | Supabase anon token for custom setups |
464
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
465
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
477
466
 
478
467
  ### <a id="app-debug"></a> ๐Ÿž **Debug**
479
468
 
@@ -496,8 +485,8 @@ npx @capgo/cli@latest app debug com.example.app --device DEVICE_ID
496
485
  | -------------- | ------------- | -------------------- |
497
486
  | **-a,** | <code>string</code> | API key to link to your account |
498
487
  | **-d,** | <code>string</code> | The specific device ID to debug |
499
- | **--supa-host** | <code>string</code> | Supabase host URL for custom setups |
500
- | **--supa-anon** | <code>string</code> | Supabase anon token for custom setups |
488
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
489
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
501
490
 
502
491
  ### <a id="app-setting"></a> โš™๏ธ **Setting**
503
492
 
@@ -505,8 +494,8 @@ npx @capgo/cli@latest app debug com.example.app --device DEVICE_ID
505
494
  npx @capgo/cli@latest app setting
506
495
  ```
507
496
 
508
- โš™๏ธ Modify Capacitor configuration programmatically by specifying the path to the setting.
509
- (e.g., plugins.CapacitorUpdater.defaultChannel). You MUST provide either --string or --bool.
497
+ โš™๏ธ Modify Capacitor configuration programmatically.
498
+ Specify setting path (e.g., plugins.CapacitorUpdater.defaultChannel) with --string or --bool.
510
499
 
511
500
  **Example:**
512
501
 
@@ -545,9 +534,9 @@ npx @capgo/cli@latest app set com.example.app --name "Updated App" --retention 3
545
534
  | **-n,** | <code>string</code> | App name for display in Capgo Cloud |
546
535
  | **-i,** | <code>string</code> | App icon path for display in Capgo Cloud |
547
536
  | **-a,** | <code>string</code> | API key to link to your account |
548
- | **-r,** | <code>string</code> | Retention period of app bundle in days, 0 by default = infinite |
549
- | **--supa-host** | <code>string</code> | Supabase host URL for custom setups |
550
- | **--supa-anon** | <code>string</code> | Supabase anon token for custom setups |
537
+ | **-r,** | <code>string</code> | Days to keep old bundles (0 = infinite, default: 0) |
538
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
539
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
551
540
 
552
541
 
553
542
  ## <a id="channel"></a> ๐Ÿ“ข **Channel**
@@ -577,8 +566,8 @@ npx @capgo/cli@latest channel add production com.example.app --default
577
566
  | **-d,** | <code>string</code> | Set the channel as default |
578
567
  | **--self-assign** | <code>boolean</code> | Allow device to self-assign to this channel |
579
568
  | **-a,** | <code>string</code> | API key to link to your account |
580
- | **--supa-host** | <code>string</code> | Supabase host URL, for self-hosted Capgo or testing |
581
- | **--supa-anon** | <code>string</code> | Supabase anon token, for self-hosted Capgo or testing |
569
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
570
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
582
571
 
583
572
  ### <a id="channel-delete"></a> ๐Ÿ—‘๏ธ **Delete**
584
573
 
@@ -603,8 +592,8 @@ npx @capgo/cli@latest channel delete production com.example.app
603
592
  | **-a,** | <code>string</code> | API key to link to your account |
604
593
  | **--delete-bundle** | <code>boolean</code> | Delete the bundle associated with the channel |
605
594
  | **--success-if-not-found** | <code>boolean</code> | Success if the channel is not found |
606
- | **--supa-host** | <code>string</code> | Supabase host URL, for self-hosted Capgo or testing |
607
- | **--supa-anon** | <code>string</code> | Supabase anon token, for self-hosted Capgo or testing |
595
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
596
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
608
597
 
609
598
  ### <a id="channel-list"></a> ๐Ÿ“‹ **List**
610
599
 
@@ -627,8 +616,8 @@ npx @capgo/cli@latest channel list com.example.app
627
616
  | Param | Type | Description |
628
617
  | -------------- | ------------- | -------------------- |
629
618
  | **-a,** | <code>string</code> | API key to link to your account |
630
- | **--supa-host** | <code>string</code> | Supabase host URL, for self-hosted Capgo or testing |
631
- | **--supa-anon** | <code>string</code> | Supabase anon token, for self-hosted Capgo or testing |
619
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
620
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
632
621
 
633
622
  ### <a id="channel-currentBundle"></a> ๐Ÿ“ฆ **CurrentBundle**
634
623
 
@@ -651,8 +640,8 @@ npx @capgo/cli@latest channel currentBundle production com.example.app
651
640
  | **-c,** | <code>string</code> | Channel to get the current bundle from |
652
641
  | **-a,** | <code>string</code> | API key to link to your account |
653
642
  | **--quiet** | <code>boolean</code> | Only print the bundle version |
654
- | **--supa-host** | <code>string</code> | Supabase host URL, for self-hosted Capgo or testing |
655
- | **--supa-anon** | <code>string</code> | Supabase anon token, for self-hosted Capgo or testing |
643
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
644
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
656
645
 
657
646
  ### <a id="channel-set"></a> โš™๏ธ **Set**
658
647
 
@@ -688,15 +677,15 @@ npx @capgo/cli@latest channel set production com.example.app --bundle 1.0.0 --st
688
677
  | **--no-android** | <code>boolean</code> | Disable sending update to Android devices |
689
678
  | **--self-assign** | <code>boolean</code> | Allow device to self-assign to this channel |
690
679
  | **--no-self-assign** | <code>boolean</code> | Disable devices to self-assign to this channel |
691
- | **--disable-auto-update** | <code>string</code> | Disable auto update strategy for this channel. The possible options are: major, minor, metadata, patch, none |
680
+ | **--disable-auto-update** | <code>string</code> | Block updates by type: major, minor, metadata, patch, or none (allows all) |
692
681
  | **--dev** | <code>boolean</code> | Allow sending update to development devices |
693
682
  | **--no-dev** | <code>boolean</code> | Disable sending update to development devices |
694
683
  | **--emulator** | <code>boolean</code> | Allow sending update to emulator devices |
695
684
  | **--no-emulator** | <code>boolean</code> | Disable sending update to emulator devices |
696
- | **--package-json** | <code>string</code> | A list of paths to package.json. Useful for monorepos (comma separated ex: ../../package.json,./package.json) |
685
+ | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
697
686
  | **--ignore-metadata-check** | <code>boolean</code> | Ignore checking node_modules compatibility if present in the bundle |
698
- | **--supa-host** | <code>string</code> | Supabase host URL, for self-hosted Capgo or testing |
699
- | **--supa-anon** | <code>string</code> | Supabase anon token, for self-hosted Capgo or testing |
687
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
688
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
700
689
 
701
690
 
702
691
  ## <a id="key"></a> ๐Ÿ” **Key**
@@ -732,12 +721,10 @@ npx @capgo/cli@latest key save --key ./path/to/key.pub
732
721
  npx @capgo/cli@latest key create
733
722
  ```
734
723
 
735
- ๐Ÿ”จ Create a new encryption key pair for end-to-end encryption in Capgo Cloud.
736
- Do not commit or share the private key; save it securely.
737
- 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.
738
- The public key is used to decrypt the zip file in the mobile app.
739
- 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.
740
- The private key is used to encrypt the zip file in the CLI.
724
+ ๐Ÿ”จ Create RSA key pair for end-to-end encryption.
725
+ Creates .capgo_key_v2 (private) and .capgo_key_v2.pub (public) in project root.
726
+ Public key is saved to capacitor.config for mobile app decryption.
727
+ NEVER commit the private key - store it securely!
741
728
 
742
729
  **Example:**
743
730
 
@@ -816,8 +803,8 @@ npx @capgo/cli@latest organisation list
816
803
  | Param | Type | Description |
817
804
  | -------------- | ------------- | -------------------- |
818
805
  | **-a,** | <code>string</code> | API key to link to your account |
819
- | **--supa-host** | <code>string</code> | Supabase host URL for custom setups |
820
- | **--supa-anon** | <code>string</code> | Supabase anon token for custom setups |
806
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
807
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
821
808
 
822
809
  ### <a id="organisation-add"></a> โž• **Add**
823
810
 
@@ -842,8 +829,8 @@ npx @capgo/cli@latest organisation add --name "My Company" --email admin@mycompa
842
829
  | **-n,** | <code>string</code> | Organization name |
843
830
  | **-e,** | <code>string</code> | Management email for the organization |
844
831
  | **-a,** | <code>string</code> | API key to link to your account |
845
- | **--supa-host** | <code>string</code> | Supabase host URL for custom setups |
846
- | **--supa-anon** | <code>string</code> | Supabase anon token for custom setups |
832
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
833
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
847
834
 
848
835
  ### <a id="organisation-set"></a> โš™๏ธ **Set**
849
836
 
@@ -868,8 +855,8 @@ npx @capgo/cli@latest organisation set ORG_ID --name "Updated Company Name"
868
855
  | **-n,** | <code>string</code> | Organization name |
869
856
  | **-e,** | <code>string</code> | Management email for the organization |
870
857
  | **-a,** | <code>string</code> | API key to link to your account |
871
- | **--supa-host** | <code>string</code> | Supabase host URL for custom setups |
872
- | **--supa-anon** | <code>string</code> | Supabase anon token for custom setups |
858
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
859
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
873
860
 
874
861
  ### <a id="organisation-delete"></a> ๐Ÿ—‘๏ธ **Delete**
875
862
 
@@ -893,8 +880,8 @@ npx @capgo/cli@latest organisation delete ORG_ID
893
880
  | Param | Type | Description |
894
881
  | -------------- | ------------- | -------------------- |
895
882
  | **-a,** | <code>string</code> | API key to link to your account |
896
- | **--supa-host** | <code>string</code> | Supabase host URL for custom setups |
897
- | **--supa-anon** | <code>string</code> | Supabase anon token for custom setups |
883
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
884
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
898
885
 
899
886
 
900
887