@capgo/cli 7.93.4 → 7.94.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
@@ -7,14 +7,14 @@
7
7
 
8
8
  A CLI to upload and download files from the Capgo Cloud.
9
9
 
10
- You can find the most up to date version of this doc in our web doc:
10
+ You can find the most up-to-date version of this doc in our web doc:
11
11
  https://capgo.app/docs/cli/overview/
12
12
 
13
13
  ## Usage
14
14
 
15
15
  Before using the CLI, you should register here: https://capgo.app/
16
16
 
17
- Then go to your account in `apikey` section and click in the `all` key to copy it.
17
+ Then go to your account in the `apikey` section and click the `all` key to copy it.
18
18
 
19
19
  Follow the documentation here: https://capacitorjs.com/docs/getting-started/
20
20
 
@@ -74,7 +74,13 @@ Follow the documentation here: https://capacitorjs.com/docs/getting-started/
74
74
  - [Init](#build-init)
75
75
  - [Request](#build-request)
76
76
  - [Credentials](#build-credentials)
77
+ - [Save](#build-credentials-save)
78
+ - [List](#build-credentials-list)
79
+ - [Clear](#build-credentials-clear)
80
+ - [Update](#build-credentials-update)
81
+ - [Migrate](#build-credentials-migrate)
77
82
  - 🔹 [Probe](#probe)
83
+ - 🔹 [Generate-docs](#generate-docs)
78
84
  - 🔹 [Mcp](#mcp)
79
85
 
80
86
  ## <a id="init"></a> 🚀 **Init**
@@ -96,12 +102,12 @@ During the iOS run-on-device step, choose a physical iPhone/iPad or simulator. I
96
102
  npx @capgo/cli@latest init YOUR_API_KEY com.example.app
97
103
  ```
98
104
 
99
- ### <a id="init-options"></a> Options
105
+ ## <a id="options-init"></a> Options (Init)
100
106
 
101
107
  | Param | Type | Description |
102
108
  | -------------- | ------------- | -------------------- |
103
- | **-n,** | <code>string</code> | App name for display in Capgo Cloud |
104
- | **-i,** | <code>string</code> | App icon path for display in Capgo Cloud |
109
+ | **-n** | <code>string</code> | App name for display in Capgo Cloud |
110
+ | **-i** | <code>string</code> | App icon path for display in Capgo Cloud |
105
111
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
106
112
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
107
113
 
@@ -154,7 +160,7 @@ npx @capgo/cli@latest star-all
154
160
  ⭐ Star all Capgo GitHub repositories with a small random delay between each request.
155
161
  If you do not pass repositories, this defaults to all Cap-go repositories whose name starts with `capacitor-`.
156
162
 
157
- ### <a id="star-all-options"></a> Options
163
+ ## <a id="options-star-all"></a> Options (Star-all)
158
164
 
159
165
  | Param | Type | Description |
160
166
  | -------------- | ------------- | -------------------- |
@@ -178,7 +184,7 @@ This command helps diagnose issues with your setup.
178
184
  npx @capgo/cli@latest doctor
179
185
  ```
180
186
 
181
- ### <a id="doctor-options"></a> Options
187
+ ## <a id="options-doctor"></a> Options (Doctor)
182
188
 
183
189
  | Param | Type | Description |
184
190
  | -------------- | ------------- | -------------------- |
@@ -202,7 +208,7 @@ Use --apikey=******** in any command to override it.
202
208
  npx @capgo/cli@latest login YOUR_API_KEY
203
209
  ```
204
210
 
205
- ### <a id="login-options"></a> Options
211
+ ## <a id="options-login"></a> Options (Login)
206
212
 
207
213
  | Param | Type | Description |
208
214
  | -------------- | ------------- | -------------------- |
@@ -238,10 +244,10 @@ npx @capgo/cli@latest bundle upload com.example.app --path ./dist --channel prod
238
244
 
239
245
  | Param | Type | Description |
240
246
  | -------------- | ------------- | -------------------- |
241
- | **-a,** | <code>string</code> | API key to link to your account |
242
- | **-p,** | <code>string</code> | Path of the folder to upload, if not provided it will use the webDir set in capacitor.config |
243
- | **-c,** | <code>string</code> | Channel to link to |
244
- | **-e,** | <code>string</code> | Link to external URL instead of upload to Capgo Cloud |
247
+ | **-a** | <code>string</code> | API key to link to your account |
248
+ | **-p** | <code>string</code> | Path of the folder to upload, if not provided it will use the webDir set in capacitor.config |
249
+ | **-c** | <code>string</code> | Channel to link to |
250
+ | **-e** | <code>string</code> | Link to external URL instead of upload to Capgo Cloud |
245
251
  | **--iv-session-key** | <code>string</code> | Set the IV and session key for bundle URL external |
246
252
  | **--s3-region** | <code>string</code> | Region for your S3 bucket |
247
253
  | **--s3-apikey** | <code>string</code> | API key for your S3 endpoint |
@@ -256,7 +262,7 @@ npx @capgo/cli@latest bundle upload com.example.app --path ./dist --channel prod
256
262
  | **--no-key** | <code>boolean</code> | Ignore signing key and send clear update |
257
263
  | **--no-code-check** | <code>boolean</code> | Ignore checking if notifyAppReady() is called in source code and index present in root folder |
258
264
  | **--display-iv-session** | <code>boolean</code> | Show in the console the IV and session key used to encrypt the update |
259
- | **-b,** | <code>string</code> | Bundle version number of the bundle to upload |
265
+ | **-b** | <code>string</code> | Bundle version number of the bundle to upload |
260
266
  | **--link** | <code>string</code> | Link to external resource (e.g. GitHub release) |
261
267
  | **--comment** | <code>string</code> | Comment about this version, could be a release note, a commit hash, a commit message, etc. |
262
268
  | **--min-update-version** | <code>string</code> | Minimal version required to update to this version. Used only if the disable auto update is set to metadata in channel |
@@ -271,12 +277,12 @@ npx @capgo/cli@latest bundle upload com.example.app --path ./dist --channel prod
271
277
  | **--tus-chunk-size** | <code>string</code> | Chunk size in bytes for TUS resumable uploads (default: auto) |
272
278
  | **--partial** | <code>boolean</code> | [DEPRECATED] Use --delta instead. Upload incremental updates |
273
279
  | **--partial-only** | <code>boolean</code> | [DEPRECATED] Use --delta-only instead. Upload only incremental updates, skip full bundle |
274
- | **--delta** | <code>boolean</code> | Upload delta updates (only changed files) for instant, super fast updates instead of big zip downloads |
280
+ | **--delta** | <code>boolean</code> | Upload delta updates (only changed files) for instant, super-fast updates instead of big zip downloads |
275
281
  | **--delta-only** | <code>boolean</code> | Upload only delta updates without full bundle for maximum speed (useful for large apps) |
276
282
  | **--no-delta** | <code>boolean</code> | Disable delta updates even if Direct Update is enabled |
277
283
  | **--encrypted-checksum** | <code>string</code> | An encrypted checksum (signature). Used only when uploading an external bundle. |
278
284
  | **--auto-set-bundle** | <code>boolean</code> | Set the bundle in capacitor.config.json |
279
- | **--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) |
285
+ | **--dry-upload** | <code>boolean</code> | Dry upload the bundle process: add the row in database without uploading files or updating channels (Used by Capgo for internal testing) |
280
286
  | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
281
287
  | **--node-modules** | <code>string</code> | Paths to node_modules directories for monorepos (comma-separated) |
282
288
  | **--encrypt-partial** | <code>boolean</code> | Encrypt delta update files (auto-enabled for updater > 6.14.4) |
@@ -307,8 +313,8 @@ npx @capgo/cli@latest bundle compatibility com.example.app --channel production
307
313
 
308
314
  | Param | Type | Description |
309
315
  | -------------- | ------------- | -------------------- |
310
- | **-a,** | <code>string</code> | API key to link to your account |
311
- | **-c,** | <code>string</code> | Channel to check the compatibility with |
316
+ | **-a** | <code>string</code> | API key to link to your account |
317
+ | **-c** | <code>string</code> | Channel to check the compatibility with |
312
318
  | **--text** | <code>boolean</code> | Output text instead of emojis |
313
319
  | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
314
320
  | **--node-modules** | <code>string</code> | Paths to node_modules directories for monorepos (comma-separated) |
@@ -333,8 +339,8 @@ npx @capgo/cli@latest bundle releaseType com.example.app --channel production
333
339
 
334
340
  | Param | Type | Description |
335
341
  | -------------- | ------------- | -------------------- |
336
- | **-a,** | <code>string</code> | API key to link to your account |
337
- | **-c,** | <code>string</code> | Channel to compare against |
342
+ | **-a** | <code>string</code> | API key to link to your account |
343
+ | **-c** | <code>string</code> | Channel to compare against |
338
344
  | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
339
345
  | **--node-modules** | <code>string</code> | Paths to node_modules directories for monorepos (comma-separated) |
340
346
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
@@ -360,7 +366,7 @@ npx @capgo/cli@latest bundle delete BUNDLE_ID com.example.app
360
366
 
361
367
  | Param | Type | Description |
362
368
  | -------------- | ------------- | -------------------- |
363
- | **-a,** | <code>string</code> | API key to link to your account |
369
+ | **-a** | <code>string</code> | API key to link to your account |
364
370
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
365
371
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
366
372
 
@@ -384,7 +390,7 @@ npx @capgo/cli@latest bundle list com.example.app
384
390
 
385
391
  | Param | Type | Description |
386
392
  | -------------- | ------------- | -------------------- |
387
- | **-a,** | <code>string</code> | API key to link to your account |
393
+ | **-a** | <code>string</code> | API key to link to your account |
388
394
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
389
395
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
390
396
 
@@ -409,10 +415,10 @@ npx @capgo/cli@latest bundle cleanup com.example.app --bundle=1.0 --keep=3
409
415
 
410
416
  | Param | Type | Description |
411
417
  | -------------- | ------------- | -------------------- |
412
- | **-b,** | <code>string</code> | Bundle version number of the app to delete |
413
- | **-a,** | <code>string</code> | API key to link to your account |
414
- | **-k,** | <code>string</code> | Number of versions to keep |
415
- | **-f,** | <code>string</code> | Force removal |
418
+ | **-b** | <code>string</code> | Bundle version number of the app to delete |
419
+ | **-a** | <code>string</code> | API key to link to your account |
420
+ | **-k** | <code>string</code> | Number of versions to keep |
421
+ | **-f** | <code>boolean</code> | Force removal |
416
422
  | **--ignore-channel** | <code>boolean</code> | Delete bundles even if linked to channels (WARNING: deletes channels too) |
417
423
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
418
424
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
@@ -438,7 +444,7 @@ npx @capgo/cli@latest bundle encrypt ./myapp.zip CHECKSUM
438
444
  | -------------- | ------------- | -------------------- |
439
445
  | **--key** | <code>string</code> | Custom path for private signing key |
440
446
  | **--key-data** | <code>string</code> | Private signing key |
441
- | **-j,** | <code>string</code> | Output in JSON |
447
+ | **-j** | <code>boolean</code> | Output in JSON |
442
448
  | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
443
449
 
444
450
  ### <a id="bundle-decrypt"></a> 🔓 **Decrypt**
@@ -484,10 +490,10 @@ npx @capgo/cli@latest bundle zip com.example.app --path ./dist
484
490
 
485
491
  | Param | Type | Description |
486
492
  | -------------- | ------------- | -------------------- |
487
- | **-p,** | <code>string</code> | Path of the folder to upload, if not provided it will use the webDir set in capacitor.config |
488
- | **-b,** | <code>string</code> | Bundle version number to name the zip file |
489
- | **-n,** | <code>string</code> | Name of the zip file |
490
- | **-j,** | <code>string</code> | Output in JSON |
493
+ | **-p** | <code>string</code> | Path of the folder to upload, if not provided it will use the webDir set in capacitor.config |
494
+ | **-b** | <code>string</code> | Bundle version number to name the zip file |
495
+ | **-n** | <code>string</code> | Name of the zip file |
496
+ | **-j** | <code>boolean</code> | Output in JSON |
491
497
  | **--no-code-check** | <code>boolean</code> | Ignore checking if notifyAppReady() is called in source code and index present in root folder |
492
498
  | **--key-v2** | <code>boolean</code> | Use encryption v2 |
493
499
  | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
@@ -518,9 +524,9 @@ npx @capgo/cli@latest app add com.example.app --name "My App" --icon ./icon.png
518
524
 
519
525
  | Param | Type | Description |
520
526
  | -------------- | ------------- | -------------------- |
521
- | **-n,** | <code>string</code> | App name for display in Capgo Cloud |
522
- | **-i,** | <code>string</code> | App icon path for display in Capgo Cloud |
523
- | **-a,** | <code>string</code> | API key to link to your account |
527
+ | **-n** | <code>string</code> | App name for display in Capgo Cloud |
528
+ | **-i** | <code>string</code> | App icon path for display in Capgo Cloud |
529
+ | **-a** | <code>string</code> | API key to link to your account |
524
530
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
525
531
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
526
532
 
@@ -542,7 +548,7 @@ npx @capgo/cli@latest app delete com.example.app
542
548
 
543
549
  | Param | Type | Description |
544
550
  | -------------- | ------------- | -------------------- |
545
- | **-a,** | <code>string</code> | API key to link to your account |
551
+ | **-a** | <code>string</code> | API key to link to your account |
546
552
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
547
553
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
548
554
 
@@ -566,7 +572,7 @@ npx @capgo/cli@latest app list
566
572
 
567
573
  | Param | Type | Description |
568
574
  | -------------- | ------------- | -------------------- |
569
- | **-a,** | <code>string</code> | API key to link to your account |
575
+ | **-a** | <code>string</code> | API key to link to your account |
570
576
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
571
577
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
572
578
 
@@ -589,8 +595,8 @@ npx @capgo/cli@latest app debug com.example.app --device DEVICE_ID
589
595
 
590
596
  | Param | Type | Description |
591
597
  | -------------- | ------------- | -------------------- |
592
- | **-a,** | <code>string</code> | API key to link to your account |
593
- | **-d,** | <code>string</code> | The specific device ID to debug |
598
+ | **-a** | <code>string</code> | API key to link to your account |
599
+ | **-d** | <code>string</code> | The specific device ID to debug |
594
600
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
595
601
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
596
602
 
@@ -637,10 +643,10 @@ npx @capgo/cli@latest app set com.example.app --name "Updated App" --retention 3
637
643
 
638
644
  | Param | Type | Description |
639
645
  | -------------- | ------------- | -------------------- |
640
- | **-n,** | <code>string</code> | App name for display in Capgo Cloud |
641
- | **-i,** | <code>string</code> | App icon path for display in Capgo Cloud |
642
- | **-a,** | <code>string</code> | API key to link to your account |
643
- | **-r,** | <code>string</code> | Days to keep old bundles (0 = infinite, default: 0) |
646
+ | **-n** | <code>string</code> | App name for display in Capgo Cloud |
647
+ | **-i** | <code>string</code> | App icon path for display in Capgo Cloud |
648
+ | **-a** | <code>string</code> | API key to link to your account |
649
+ | **-r** | <code>string</code> | Days to keep old bundles (0 = infinite, default: 0) |
644
650
  | **--expose-metadata** | <code>string</code> | Expose bundle metadata (link and comment) to the plugin (true/false, default: false) |
645
651
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
646
652
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
@@ -670,9 +676,9 @@ npx @capgo/cli@latest channel add production com.example.app --default
670
676
 
671
677
  | Param | Type | Description |
672
678
  | -------------- | ------------- | -------------------- |
673
- | **-d,** | <code>string</code> | Set the channel as default |
679
+ | **-d** | <code>boolean</code> | Set the channel as default |
674
680
  | **--self-assign** | <code>boolean</code> | Allow device to self-assign to this channel |
675
- | **-a,** | <code>string</code> | API key to link to your account |
681
+ | **-a** | <code>string</code> | API key to link to your account |
676
682
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
677
683
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
678
684
 
@@ -696,7 +702,7 @@ npx @capgo/cli@latest channel delete production com.example.app
696
702
 
697
703
  | Param | Type | Description |
698
704
  | -------------- | ------------- | -------------------- |
699
- | **-a,** | <code>string</code> | API key to link to your account |
705
+ | **-a** | <code>string</code> | API key to link to your account |
700
706
  | **--delete-bundle** | <code>boolean</code> | Delete the bundle associated with the channel |
701
707
  | **--success-if-not-found** | <code>boolean</code> | Success if the channel is not found |
702
708
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
@@ -722,7 +728,7 @@ npx @capgo/cli@latest channel list com.example.app
722
728
 
723
729
  | Param | Type | Description |
724
730
  | -------------- | ------------- | -------------------- |
725
- | **-a,** | <code>string</code> | API key to link to your account |
731
+ | **-a** | <code>string</code> | API key to link to your account |
726
732
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
727
733
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
728
734
 
@@ -744,8 +750,8 @@ npx @capgo/cli@latest channel currentBundle production com.example.app
744
750
 
745
751
  | Param | Type | Description |
746
752
  | -------------- | ------------- | -------------------- |
747
- | **-c,** | <code>string</code> | Channel to get the current bundle from |
748
- | **-a,** | <code>string</code> | API key to link to your account |
753
+ | **-c** | <code>string</code> | Channel to get the current bundle from |
754
+ | **-a** | <code>string</code> | API key to link to your account |
749
755
  | **--quiet** | <code>boolean</code> | Only print the bundle version |
750
756
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
751
757
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
@@ -771,9 +777,9 @@ npx @capgo/cli@latest channel set production com.example.app --bundle 1.0.0 --st
771
777
 
772
778
  | Param | Type | Description |
773
779
  | -------------- | ------------- | -------------------- |
774
- | **-a,** | <code>string</code> | API key to link to your account |
775
- | **-b,** | <code>string</code> | Bundle version number of the file to set |
776
- | **-s,** | <code>string</code> | Set the state of the channel, default or normal |
780
+ | **-a** | <code>string</code> | API key to link to your account |
781
+ | **-b** | <code>string</code> | Bundle version number of the file to set |
782
+ | **-s** | <code>string</code> | Set the state of the channel, default or normal |
777
783
  | **--latest-remote** | <code>boolean</code> | Get the latest bundle uploaded in capgo cloud and set it to the channel |
778
784
  | **--latest** | <code>boolean</code> | Get the latest version key in the package.json to set it to the channel |
779
785
  | **--downgrade** | <code>boolean</code> | Allow to downgrade to version under native one |
@@ -822,7 +828,7 @@ npx @capgo/cli@latest key save --key ./path/to/key.pub
822
828
 
823
829
  | Param | Type | Description |
824
830
  | -------------- | ------------- | -------------------- |
825
- | **-f,** | <code>string</code> | Force generate a new one |
831
+ | **-f** | <code>boolean</code> | Force generate a new one |
826
832
  | **--key** | <code>string</code> | Key path to save in Capacitor config |
827
833
  | **--key-data** | <code>string</code> | Key data to save in Capacitor config |
828
834
 
@@ -847,7 +853,7 @@ npx @capgo/cli@latest key create
847
853
 
848
854
  | Param | Type | Description |
849
855
  | -------------- | ------------- | -------------------- |
850
- | **-f,** | <code>string</code> | Force generate a new one |
856
+ | **-f** | <code>boolean</code> | Force generate a new one |
851
857
 
852
858
  ### <a id="key-delete_old"></a> 🗑️ **Delete_old**
853
859
 
@@ -886,7 +892,7 @@ npx @capgo/cli@latest account id
886
892
 
887
893
  | Param | Type | Description |
888
894
  | -------------- | ------------- | -------------------- |
889
- | **-a,** | <code>string</code> | API key to link to your account |
895
+ | **-a** | <code>string</code> | API key to link to your account |
890
896
 
891
897
 
892
898
  ## <a id="organization"></a> 🔹 **Organization**
@@ -913,7 +919,7 @@ npx @capgo/cli@latest organization list
913
919
 
914
920
  | Param | Type | Description |
915
921
  | -------------- | ------------- | -------------------- |
916
- | **-a,** | <code>string</code> | API key to link to your account |
922
+ | **-a** | <code>string</code> | API key to link to your account |
917
923
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
918
924
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
919
925
 
@@ -937,9 +943,9 @@ npx @capgo/cli@latest organization add --name "My Company" --email admin@mycompa
937
943
 
938
944
  | Param | Type | Description |
939
945
  | -------------- | ------------- | -------------------- |
940
- | **-n,** | <code>string</code> | Organization name |
941
- | **-e,** | <code>string</code> | Management email for the organization |
942
- | **-a,** | <code>string</code> | API key to link to your account |
946
+ | **-n** | <code>string</code> | Organization name |
947
+ | **-e** | <code>string</code> | Management email for the organization |
948
+ | **-a** | <code>string</code> | API key to link to your account |
943
949
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
944
950
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
945
951
 
@@ -967,7 +973,7 @@ npx @capgo/cli@latest organization members ORG_ID
967
973
 
968
974
  | Param | Type | Description |
969
975
  | -------------- | ------------- | -------------------- |
970
- | **-a,** | <code>string</code> | API key to link to your account |
976
+ | **-a** | <code>string</code> | API key to link to your account |
971
977
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
972
978
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
973
979
 
@@ -992,8 +998,8 @@ npx @capgo/cli@latest organization set ORG_ID --name "New Name"
992
998
 
993
999
  | Param | Type | Description |
994
1000
  | -------------- | ------------- | -------------------- |
995
- | **-n,** | <code>string</code> | Organization name |
996
- | **-e,** | <code>string</code> | Management email for the organization |
1001
+ | **-n** | <code>string</code> | Organization name |
1002
+ | **-e** | <code>string</code> | Management email for the organization |
997
1003
  | **--enforce-2fa** | <code>boolean</code> | Enable 2FA enforcement for all organization members |
998
1004
  | **--no-enforce-2fa** | <code>boolean</code> | Disable 2FA enforcement for organization |
999
1005
  | **--password-policy** | <code>boolean</code> | Enable password policy enforcement for organization |
@@ -1010,7 +1016,7 @@ npx @capgo/cli@latest organization set ORG_ID --name "New Name"
1010
1016
  | **--max-apikey-expiration-days** | <code>string</code> | Maximum days before API key expiration (1-365, null for no limit) |
1011
1017
  | **--enforce-hashed-api-keys** | <code>boolean</code> | Enforce hashed/secure API keys (key value stored as hash, shown only once) |
1012
1018
  | **--no-enforce-hashed-api-keys** | <code>boolean</code> | Allow plain-text API keys |
1013
- | **-a,** | <code>string</code> | API key to link to your account |
1019
+ | **-a** | <code>string</code> | API key to link to your account |
1014
1020
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
1015
1021
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
1016
1022
 
@@ -1035,7 +1041,7 @@ npx @capgo/cli@latest organization delete ORG_ID
1035
1041
 
1036
1042
  | Param | Type | Description |
1037
1043
  | -------------- | ------------- | -------------------- |
1038
- | **-a,** | <code>string</code> | API key to link to your account |
1044
+ | **-a** | <code>string</code> | API key to link to your account |
1039
1045
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
1040
1046
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
1041
1047
 
@@ -1058,7 +1064,7 @@ npx @capgo/cli@latest organisation list
1058
1064
 
1059
1065
  | Param | Type | Description |
1060
1066
  | -------------- | ------------- | -------------------- |
1061
- | **-a,** | <code>string</code> | API key to link to your account |
1067
+ | **-a** | <code>string</code> | API key to link to your account |
1062
1068
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
1063
1069
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
1064
1070
 
@@ -1076,9 +1082,9 @@ npx @capgo/cli@latest organisation add
1076
1082
 
1077
1083
  | Param | Type | Description |
1078
1084
  | -------------- | ------------- | -------------------- |
1079
- | **-n,** | <code>string</code> | Organization name |
1080
- | **-e,** | <code>string</code> | Management email for the organization |
1081
- | **-a,** | <code>string</code> | API key to link to your account |
1085
+ | **-n** | <code>string</code> | Organization name |
1086
+ | **-e** | <code>string</code> | Management email for the organization |
1087
+ | **-a** | <code>string</code> | API key to link to your account |
1082
1088
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
1083
1089
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
1084
1090
 
@@ -1096,8 +1102,8 @@ npx @capgo/cli@latest organisation set
1096
1102
 
1097
1103
  | Param | Type | Description |
1098
1104
  | -------------- | ------------- | -------------------- |
1099
- | **-n,** | <code>string</code> | Organization name |
1100
- | **-e,** | <code>string</code> | Management email for the organization |
1105
+ | **-n** | <code>string</code> | Organization name |
1106
+ | **-e** | <code>string</code> | Management email for the organization |
1101
1107
  | **--enforce-2fa** | <code>boolean</code> | Enable 2FA enforcement for all organization members |
1102
1108
  | **--no-enforce-2fa** | <code>boolean</code> | Disable 2FA enforcement for organization |
1103
1109
  | **--password-policy** | <code>boolean</code> | Enable password policy enforcement for organization |
@@ -1114,7 +1120,7 @@ npx @capgo/cli@latest organisation set
1114
1120
  | **--max-apikey-expiration-days** | <code>string</code> | Maximum days before API key expiration (1-365, null for no limit) |
1115
1121
  | **--enforce-hashed-api-keys** | <code>boolean</code> | Enforce hashed/secure API keys (key value stored as hash, shown only once) |
1116
1122
  | **--no-enforce-hashed-api-keys** | <code>boolean</code> | Allow plain-text API keys |
1117
- | **-a,** | <code>string</code> | API key to link to your account |
1123
+ | **-a** | <code>string</code> | API key to link to your account |
1118
1124
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
1119
1125
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
1120
1126
 
@@ -1132,7 +1138,7 @@ npx @capgo/cli@latest organisation delete
1132
1138
 
1133
1139
  | Param | Type | Description |
1134
1140
  | -------------- | ------------- | -------------------- |
1135
- | **-a,** | <code>string</code> | API key to link to your account |
1141
+ | **-a** | <code>string</code> | API key to link to your account |
1136
1142
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
1137
1143
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
1138
1144
 
@@ -1164,7 +1170,7 @@ Set up iOS build credentials interactively (creates certificates and profiles au
1164
1170
 
1165
1171
  | Param | Type | Description |
1166
1172
  | -------------- | ------------- | -------------------- |
1167
- | **-a,** | <code>string</code> | API key to link to your account |
1173
+ | **-a** | <code>string</code> | API key to link to your account |
1168
1174
 
1169
1175
  ### <a id="build-request"></a> 🔹 **Request**
1170
1176
 
@@ -1217,17 +1223,13 @@ npx @capgo/cli@latest build request com.example.app --platform ios --path .
1217
1223
  | **--output-retention** | <code>string</code> | Override output link TTL for this build only (1h to 7d). Examples: 1h, 6h, 2d. Precedence: CLI > env > saved credentials |
1218
1224
  | **--skip-build-number-bump** | <code>boolean</code> | Skip automatic build number/version code incrementing. Uses whatever version is already in the project files. |
1219
1225
  | **--no-skip-build-number-bump** | <code>boolean</code> | Override saved credentials to re-enable automatic build number incrementing for this build only. |
1220
- | **-a,** | <code>string</code> | API key to link to your account |
1226
+ | **-a** | <code>string</code> | API key to link to your account |
1221
1227
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
1222
1228
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
1223
1229
  | **--verbose** | <code>boolean</code> | Enable verbose output with detailed logging |
1224
1230
 
1225
1231
  ### <a id="build-credentials"></a> 🔹 **Credentials**
1226
1232
 
1227
- ```bash
1228
- npx @capgo/cli@latest build credentials
1229
- ```
1230
-
1231
1233
  Manage build credentials stored locally on your machine.
1232
1234
  🔒 SECURITY:
1233
1235
  - Credentials saved to ~/.capgo-credentials/credentials.json (global) or .capgo-credentials.json (local)
@@ -1238,6 +1240,181 @@ Manage build credentials stored locally on your machine.
1238
1240
  iOS setup: https://capgo.app/docs/cli/cloud-build/ios/
1239
1241
  Android setup: https://capgo.app/docs/cli/cloud-build/android/
1240
1242
 
1243
+ #### <a id="build-credentials-save"></a> 🔹 **Save**
1244
+
1245
+ ```bash
1246
+ npx @capgo/cli@latest build credentials save
1247
+ ```
1248
+
1249
+ Save build credentials locally for iOS or Android.
1250
+ Credentials are stored in:
1251
+ - ~/.capgo-credentials/credentials.json (default, global)
1252
+ - .capgo-credentials.json in project root (with --local flag)
1253
+ ⚠️ REQUIRED BEFORE BUILDING: You must save credentials before requesting a build.
1254
+ 🔒 These credentials are NEVER stored on Capgo servers permanently.
1255
+ They are deleted immediately after the build completes.
1256
+ 📚 Setup guides:
1257
+ iOS: https://capgo.app/docs/cli/cloud-build/ios/
1258
+ Android: https://capgo.app/docs/cli/cloud-build/android/
1259
+ npx @capgo/cli build credentials save --platform ios \
1260
+ --certificate ./cert.p12 --p12-password "password" \
1261
+ --ios-provisioning-profile ./profile.mobileprovision \
1262
+ --apple-key ./AuthKey.p8 --apple-key-id "KEY123" \
1263
+ --apple-issuer-id "issuer-uuid" --apple-team-id "team-id"
1264
+ Multi-target Example (app + widget extension):
1265
+ npx @capgo/cli build credentials save --platform ios \
1266
+ --ios-provisioning-profile ./App.mobileprovision \
1267
+ --ios-provisioning-profile com.example.widget=./Widget.mobileprovision \
1268
+ ...
1269
+ npx @capgo/cli build credentials save --platform android \
1270
+ --keystore ./release.keystore --keystore-alias "my-key" \
1271
+ --keystore-key-password "key-pass" \
1272
+ --play-config ./service-account.json
1273
+ Local storage (per-project):
1274
+ npx @capgo/cli build credentials save --local --platform ios ...
1275
+
1276
+ **Example:**
1277
+
1278
+ ```bash
1279
+ iOS Example:
1280
+ ```
1281
+
1282
+ **Options:**
1283
+
1284
+ | Param | Type | Description |
1285
+ | -------------- | ------------- | -------------------- |
1286
+ | **--appId** | <code>string</code> | App ID (e.g., com.example.app) (required) |
1287
+ | **--platform** | <code>string</code> | Platform: ios or android (required) |
1288
+ | **--certificate** | <code>string</code> | iOS: Path to .p12 certificate file |
1289
+ | **--ios-provisioning-profile** | <code>string</code> | iOS: Provisioning profile path or bundleId=path (repeatable) |
1290
+ | **--p12-password** | <code>string</code> | iOS: Certificate password (optional if cert has no password) |
1291
+ | **--apple-key** | <code>string</code> | iOS: Path to .p8 App Store Connect API key |
1292
+ | **--apple-key-id** | <code>string</code> | iOS: App Store Connect API Key ID |
1293
+ | **--apple-issuer-id** | <code>string</code> | iOS: App Store Connect Issuer ID |
1294
+ | **--apple-team-id** | <code>string</code> | iOS: App Store Connect Team ID |
1295
+ | **--ios-distribution** | <code>string</code> | iOS: Distribution mode |
1296
+ | **--apple-id** | <code>string</code> | iOS: Apple ID email (optional) |
1297
+ | **--apple-app-password** | <code>string</code> | iOS: App-specific password (optional) |
1298
+ | **--keystore** | <code>string</code> | Android: Path to keystore file (.keystore or .jks) |
1299
+ | **--keystore-alias** | <code>string</code> | Android: Keystore key alias |
1300
+ | **--keystore-key-password** | <code>string</code> | Android: Keystore key password |
1301
+ | **--keystore-store-password** | <code>string</code> | Android: Keystore store password |
1302
+ | **--play-config** | <code>string</code> | Android: Path to Play Store service account JSON |
1303
+ | **--android-flavor** | <code>string</code> | Android: Product flavor to build (e.g. production). Required if your project has multiple flavors. |
1304
+ | **--local** | <code>boolean</code> | Save to .capgo-credentials.json in project root instead of global ~/.capgo-credentials/ |
1305
+ | **--output-upload** | <code>boolean</code> | Upload build outputs (IPA/APK/AAB) to Capgo storage and print download links |
1306
+ | **--no-output-upload** | <code>boolean</code> | Do not upload build outputs (IPA/APK/AAB) to Capgo storage |
1307
+ | **--output-retention** | <code>string</code> | Output link TTL: 1h to 7d (default: 1h). Examples: 1h, 6h, 2d |
1308
+ | **--skip-build-number-bump** | <code>boolean</code> | Skip automatic build number/version code incrementing on future builds |
1309
+ | **--no-skip-build-number-bump** | <code>boolean</code> | Re-enable automatic build number incrementing (default behavior) |
1310
+
1311
+ #### <a id="build-credentials-list"></a> 📋 **List**
1312
+
1313
+ ```bash
1314
+ npx @capgo/cli@latest build credentials list
1315
+ ```
1316
+
1317
+ List saved build credentials (passwords masked).
1318
+ Shows what credentials are currently saved (both global and local).
1319
+ Examples:
1320
+ npx @capgo/cli build credentials list # List all apps
1321
+ npx @capgo/cli build credentials list --appId com.example.app # List specific app
1322
+
1323
+ **Options:**
1324
+
1325
+ | Param | Type | Description |
1326
+ | -------------- | ------------- | -------------------- |
1327
+ | **--appId** | <code>string</code> | App ID to list (optional, lists all if omitted) |
1328
+ | **--local** | <code>boolean</code> | List credentials from local .capgo-credentials.json only |
1329
+
1330
+ #### <a id="build-credentials-clear"></a> 🔹 **Clear**
1331
+
1332
+ ```bash
1333
+ npx @capgo/cli@latest build credentials clear
1334
+ ```
1335
+
1336
+ Clear saved build credentials.
1337
+ Remove credentials from storage.
1338
+ Use --appId and --platform to target specific credentials.
1339
+ Examples:
1340
+ npx @capgo/cli build credentials clear # Clear all apps (global)
1341
+ npx @capgo/cli build credentials clear --local # Clear local credentials
1342
+ npx @capgo/cli build credentials clear --appId com.example.app --platform ios
1343
+
1344
+ **Options:**
1345
+
1346
+ | Param | Type | Description |
1347
+ | -------------- | ------------- | -------------------- |
1348
+ | **--appId** | <code>string</code> | App ID to clear (optional, clears all apps if omitted) |
1349
+ | **--platform** | <code>string</code> | Platform to clear: ios or android (optional, clears all platforms if omitted) |
1350
+ | **--local** | <code>boolean</code> | Clear from local .capgo-credentials.json instead of global |
1351
+
1352
+ #### <a id="build-credentials-update"></a> 🔹 **Update**
1353
+
1354
+ ```bash
1355
+ npx @capgo/cli@latest build credentials update
1356
+ ```
1357
+
1358
+ Update specific credentials without providing all of them again.
1359
+ Update existing credentials by providing only the fields you want to change.
1360
+ Platform is auto-detected from the options you provide.
1361
+ Examples:
1362
+ npx @capgo/cli build credentials update --ios-provisioning-profile ./new-profile.mobileprovision
1363
+ npx @capgo/cli build credentials update --local --keystore ./new-keystore.jks
1364
+
1365
+ **Options:**
1366
+
1367
+ | Param | Type | Description |
1368
+ | -------------- | ------------- | -------------------- |
1369
+ | **--appId** | <code>string</code> | App ID (auto-detected from capacitor.config if omitted) |
1370
+ | **--platform** | <code>string</code> | Platform: ios or android (auto-detected from options) |
1371
+ | **--local** | <code>boolean</code> | Update local .capgo-credentials.json instead of global |
1372
+ | **--certificate** | <code>string</code> | Path to P12 certificate file |
1373
+ | **--ios-provisioning-profile** | <code>string</code> | Provisioning profile path or bundleId=path (repeatable, additive by default) |
1374
+ | **--overwrite-ios-provisioning-map** | <code>boolean</code> | Replace the entire provisioning map instead of merging (default: merge) |
1375
+ | **--p12-password** | <code>string</code> | P12 certificate password |
1376
+ | **--apple-key** | <code>string</code> | Path to App Store Connect API key (.p8 file) |
1377
+ | **--apple-key-id** | <code>string</code> | App Store Connect API Key ID |
1378
+ | **--apple-issuer-id** | <code>string</code> | App Store Connect Issuer ID |
1379
+ | **--apple-team-id** | <code>string</code> | App Store Connect Team ID |
1380
+ | **--ios-distribution** | <code>string</code> | iOS: Distribution mode |
1381
+ | **--keystore** | <code>string</code> | Path to keystore file (.keystore or .jks) |
1382
+ | **--keystore-alias** | <code>string</code> | Keystore key alias |
1383
+ | **--keystore-key-password** | <code>string</code> | Keystore key password |
1384
+ | **--keystore-store-password** | <code>string</code> | Keystore store password |
1385
+ | **--play-config** | <code>string</code> | Path to Google Play service account JSON |
1386
+ | **--android-flavor** | <code>string</code> | Android: Product flavor to build (e.g. production). Required if your project has multiple flavors. |
1387
+ | **--output-upload** | <code>boolean</code> | Upload build outputs (IPA/APK/AAB) to Capgo storage and print download links |
1388
+ | **--no-output-upload** | <code>boolean</code> | Do not upload build outputs (IPA/APK/AAB) to Capgo storage |
1389
+ | **--output-retention** | <code>string</code> | Output link TTL: 1h to 7d. Examples: 1h, 6h, 2d |
1390
+ | **--skip-build-number-bump** | <code>boolean</code> | Skip automatic build number/version code incrementing on future builds |
1391
+ | **--no-skip-build-number-bump** | <code>boolean</code> | Re-enable automatic build number incrementing (default behavior) |
1392
+
1393
+ #### <a id="build-credentials-migrate"></a> 🔹 **Migrate**
1394
+
1395
+ ```bash
1396
+ npx @capgo/cli@latest build credentials migrate
1397
+ ```
1398
+
1399
+ Migrate legacy provisioning profile to the new multi-target format.
1400
+ Converts BUILD_PROVISION_PROFILE_BASE64 to CAPGO_IOS_PROVISIONING_MAP.
1401
+ Discovers the main bundle ID from your Xcode project automatically.
1402
+ npx @capgo/cli build credentials migrate --platform ios
1403
+
1404
+ **Example:**
1405
+
1406
+ ```bash
1407
+ Example:
1408
+ ```
1409
+
1410
+ **Options:**
1411
+
1412
+ | Param | Type | Description |
1413
+ | -------------- | ------------- | -------------------- |
1414
+ | **--appId** | <code>string</code> | App ID (auto-detected from capacitor.config if omitted) |
1415
+ | **--platform** | <code>string</code> | Platform (only ios is supported) |
1416
+ | **--local** | <code>boolean</code> | Migrate from local .capgo-credentials.json instead of global |
1417
+
1241
1418
 
1242
1419
  ## <a id="probe"></a> 🔹 **Probe**
1243
1420
 
@@ -1255,7 +1432,7 @@ and reports whether an update would be delivered, or explains why not.
1255
1432
  npx @capgo/cli@latest probe --platform ios
1256
1433
  ```
1257
1434
 
1258
- ### <a id="probe-options"></a> Options
1435
+ ## <a id="options-probe"></a> Options (Probe)
1259
1436
 
1260
1437
  | Param | Type | Description |
1261
1438
  | -------------- | ------------- | -------------------- |