@capgo/cli 7.93.3 → 7.94.0

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
 
@@ -24,6 +24,8 @@ Follow the documentation here: https://capacitorjs.com/docs/getting-started/
24
24
  ## 📋 Table of Contents
25
25
 
26
26
  - 🚀 [Init](#init)
27
+ - 📱 [Run](#run)
28
+ - [Device](#run-device)
27
29
  - 🔹 [Star](#star)
28
30
  - 🔹 [Star-all](#star-all)
29
31
  - 👨‍⚕️ [Doctor](#doctor)
@@ -72,7 +74,13 @@ Follow the documentation here: https://capacitorjs.com/docs/getting-started/
72
74
  - [Init](#build-init)
73
75
  - [Request](#build-request)
74
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)
75
82
  - 🔹 [Probe](#probe)
83
+ - 🔹 [Generate-docs](#generate-docs)
76
84
  - 🔹 [Mcp](#mcp)
77
85
 
78
86
  ## <a id="init"></a> 🚀 **Init**
@@ -86,6 +94,7 @@ npx @capgo/cli@latest init
86
94
  🚀 Initialize a new app in Capgo Cloud with step-by-step guidance.
87
95
  This includes adding code for updates, building, uploading your app, and verifying update functionality.
88
96
  Capgo bundles are web assets and can be fetched by anyone who knows the URL. Use encryption for banking, regulated, or other high-security apps.
97
+ During the iOS run-on-device step, choose a physical iPhone/iPad or simulator. If you choose a physical device, the CLI lets you connect, unlock, and check again before it launches the app.
89
98
 
90
99
  **Example:**
91
100
 
@@ -93,16 +102,45 @@ Capgo bundles are web assets and can be fetched by anyone who knows the URL. Use
93
102
  npx @capgo/cli@latest init YOUR_API_KEY com.example.app
94
103
  ```
95
104
 
96
- ## <a id="options"></a> Options
105
+ ## <a id="options-init"></a> Options (Init)
97
106
 
98
107
  | Param | Type | Description |
99
108
  | -------------- | ------------- | -------------------- |
100
- | **-n,** | <code>string</code> | App name for display in Capgo Cloud |
101
- | **-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 |
102
111
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
103
112
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
104
113
 
105
114
 
115
+ ## <a id="run"></a> 📱 **Run**
116
+
117
+ 📱 Run Capacitor apps on devices from the CLI.
118
+
119
+ ### <a id="run-device"></a> 🔹 **Device**
120
+
121
+ ```bash
122
+ npx @capgo/cli@latest run device
123
+ ```
124
+
125
+ 📱 Run your Capacitor app on a connected device or simulator.
126
+ If you omit the platform in an interactive terminal, the command asks whether to start on iOS or Android.
127
+ The command lists available devices and simulators, lets you reload the list, and runs with your selection.
128
+ For iOS, this asks whether to use a physical iPhone/iPad or simulator before showing devices.
129
+ Use --no-launch to print the resolved command without starting the app.
130
+
131
+ **Example:**
132
+
133
+ ```bash
134
+ npx @capgo/cli@latest run device ios --no-launch
135
+ ```
136
+
137
+ **Options:**
138
+
139
+ | Param | Type | Description |
140
+ | -------------- | ------------- | -------------------- |
141
+ | **--no-launch** | <code>boolean</code> | Resolve and print the run command without starting the app |
142
+
143
+
106
144
  ## <a id="star"></a> 🔹 **Star**
107
145
 
108
146
  ```bash
@@ -122,7 +160,7 @@ npx @capgo/cli@latest star-all
122
160
  ⭐ Star all Capgo GitHub repositories with a small random delay between each request.
123
161
  If you do not pass repositories, this defaults to all Cap-go repositories whose name starts with `capacitor-`.
124
162
 
125
- ## <a id="options"></a> Options
163
+ ## <a id="options-star-all"></a> Options (Star-all)
126
164
 
127
165
  | Param | Type | Description |
128
166
  | -------------- | ------------- | -------------------- |
@@ -146,7 +184,7 @@ This command helps diagnose issues with your setup.
146
184
  npx @capgo/cli@latest doctor
147
185
  ```
148
186
 
149
- ## <a id="options"></a> Options
187
+ ## <a id="options-doctor"></a> Options (Doctor)
150
188
 
151
189
  | Param | Type | Description |
152
190
  | -------------- | ------------- | -------------------- |
@@ -170,7 +208,7 @@ Use --apikey=******** in any command to override it.
170
208
  npx @capgo/cli@latest login YOUR_API_KEY
171
209
  ```
172
210
 
173
- ## <a id="options"></a> Options
211
+ ## <a id="options-login"></a> Options (Login)
174
212
 
175
213
  | Param | Type | Description |
176
214
  | -------------- | ------------- | -------------------- |
@@ -206,10 +244,10 @@ npx @capgo/cli@latest bundle upload com.example.app --path ./dist --channel prod
206
244
 
207
245
  | Param | Type | Description |
208
246
  | -------------- | ------------- | -------------------- |
209
- | **-a,** | <code>string</code> | API key to link to your account |
210
- | **-p,** | <code>string</code> | Path of the folder to upload, if not provided it will use the webDir set in capacitor.config |
211
- | **-c,** | <code>string</code> | Channel to link to |
212
- | **-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 |
213
251
  | **--iv-session-key** | <code>string</code> | Set the IV and session key for bundle URL external |
214
252
  | **--s3-region** | <code>string</code> | Region for your S3 bucket |
215
253
  | **--s3-apikey** | <code>string</code> | API key for your S3 endpoint |
@@ -224,7 +262,7 @@ npx @capgo/cli@latest bundle upload com.example.app --path ./dist --channel prod
224
262
  | **--no-key** | <code>boolean</code> | Ignore signing key and send clear update |
225
263
  | **--no-code-check** | <code>boolean</code> | Ignore checking if notifyAppReady() is called in source code and index present in root folder |
226
264
  | **--display-iv-session** | <code>boolean</code> | Show in the console the IV and session key used to encrypt the update |
227
- | **-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 |
228
266
  | **--link** | <code>string</code> | Link to external resource (e.g. GitHub release) |
229
267
  | **--comment** | <code>string</code> | Comment about this version, could be a release note, a commit hash, a commit message, etc. |
230
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 |
@@ -239,12 +277,12 @@ npx @capgo/cli@latest bundle upload com.example.app --path ./dist --channel prod
239
277
  | **--tus-chunk-size** | <code>string</code> | Chunk size in bytes for TUS resumable uploads (default: auto) |
240
278
  | **--partial** | <code>boolean</code> | [DEPRECATED] Use --delta instead. Upload incremental updates |
241
279
  | **--partial-only** | <code>boolean</code> | [DEPRECATED] Use --delta-only instead. Upload only incremental updates, skip full bundle |
242
- | **--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 |
243
281
  | **--delta-only** | <code>boolean</code> | Upload only delta updates without full bundle for maximum speed (useful for large apps) |
244
282
  | **--no-delta** | <code>boolean</code> | Disable delta updates even if Direct Update is enabled |
245
283
  | **--encrypted-checksum** | <code>string</code> | An encrypted checksum (signature). Used only when uploading an external bundle. |
246
284
  | **--auto-set-bundle** | <code>boolean</code> | Set the bundle in capacitor.config.json |
247
- | **--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) |
248
286
  | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
249
287
  | **--node-modules** | <code>string</code> | Paths to node_modules directories for monorepos (comma-separated) |
250
288
  | **--encrypt-partial** | <code>boolean</code> | Encrypt delta update files (auto-enabled for updater > 6.14.4) |
@@ -275,8 +313,8 @@ npx @capgo/cli@latest bundle compatibility com.example.app --channel production
275
313
 
276
314
  | Param | Type | Description |
277
315
  | -------------- | ------------- | -------------------- |
278
- | **-a,** | <code>string</code> | API key to link to your account |
279
- | **-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 |
280
318
  | **--text** | <code>boolean</code> | Output text instead of emojis |
281
319
  | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
282
320
  | **--node-modules** | <code>string</code> | Paths to node_modules directories for monorepos (comma-separated) |
@@ -301,8 +339,8 @@ npx @capgo/cli@latest bundle releaseType com.example.app --channel production
301
339
 
302
340
  | Param | Type | Description |
303
341
  | -------------- | ------------- | -------------------- |
304
- | **-a,** | <code>string</code> | API key to link to your account |
305
- | **-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 |
306
344
  | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
307
345
  | **--node-modules** | <code>string</code> | Paths to node_modules directories for monorepos (comma-separated) |
308
346
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
@@ -328,7 +366,7 @@ npx @capgo/cli@latest bundle delete BUNDLE_ID com.example.app
328
366
 
329
367
  | Param | Type | Description |
330
368
  | -------------- | ------------- | -------------------- |
331
- | **-a,** | <code>string</code> | API key to link to your account |
369
+ | **-a** | <code>string</code> | API key to link to your account |
332
370
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
333
371
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
334
372
 
@@ -352,7 +390,7 @@ npx @capgo/cli@latest bundle list com.example.app
352
390
 
353
391
  | Param | Type | Description |
354
392
  | -------------- | ------------- | -------------------- |
355
- | **-a,** | <code>string</code> | API key to link to your account |
393
+ | **-a** | <code>string</code> | API key to link to your account |
356
394
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
357
395
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
358
396
 
@@ -377,10 +415,10 @@ npx @capgo/cli@latest bundle cleanup com.example.app --bundle=1.0 --keep=3
377
415
 
378
416
  | Param | Type | Description |
379
417
  | -------------- | ------------- | -------------------- |
380
- | **-b,** | <code>string</code> | Bundle version number of the app to delete |
381
- | **-a,** | <code>string</code> | API key to link to your account |
382
- | **-k,** | <code>string</code> | Number of versions to keep |
383
- | **-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 |
384
422
  | **--ignore-channel** | <code>boolean</code> | Delete bundles even if linked to channels (WARNING: deletes channels too) |
385
423
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
386
424
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
@@ -406,7 +444,7 @@ npx @capgo/cli@latest bundle encrypt ./myapp.zip CHECKSUM
406
444
  | -------------- | ------------- | -------------------- |
407
445
  | **--key** | <code>string</code> | Custom path for private signing key |
408
446
  | **--key-data** | <code>string</code> | Private signing key |
409
- | **-j,** | <code>string</code> | Output in JSON |
447
+ | **-j** | <code>boolean</code> | Output in JSON |
410
448
  | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
411
449
 
412
450
  ### <a id="bundle-decrypt"></a> 🔓 **Decrypt**
@@ -452,10 +490,10 @@ npx @capgo/cli@latest bundle zip com.example.app --path ./dist
452
490
 
453
491
  | Param | Type | Description |
454
492
  | -------------- | ------------- | -------------------- |
455
- | **-p,** | <code>string</code> | Path of the folder to upload, if not provided it will use the webDir set in capacitor.config |
456
- | **-b,** | <code>string</code> | Bundle version number to name the zip file |
457
- | **-n,** | <code>string</code> | Name of the zip file |
458
- | **-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 |
459
497
  | **--no-code-check** | <code>boolean</code> | Ignore checking if notifyAppReady() is called in source code and index present in root folder |
460
498
  | **--key-v2** | <code>boolean</code> | Use encryption v2 |
461
499
  | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
@@ -486,9 +524,9 @@ npx @capgo/cli@latest app add com.example.app --name "My App" --icon ./icon.png
486
524
 
487
525
  | Param | Type | Description |
488
526
  | -------------- | ------------- | -------------------- |
489
- | **-n,** | <code>string</code> | App name for display in Capgo Cloud |
490
- | **-i,** | <code>string</code> | App icon path for display in Capgo Cloud |
491
- | **-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 |
492
530
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
493
531
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
494
532
 
@@ -510,7 +548,7 @@ npx @capgo/cli@latest app delete com.example.app
510
548
 
511
549
  | Param | Type | Description |
512
550
  | -------------- | ------------- | -------------------- |
513
- | **-a,** | <code>string</code> | API key to link to your account |
551
+ | **-a** | <code>string</code> | API key to link to your account |
514
552
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
515
553
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
516
554
 
@@ -534,7 +572,7 @@ npx @capgo/cli@latest app list
534
572
 
535
573
  | Param | Type | Description |
536
574
  | -------------- | ------------- | -------------------- |
537
- | **-a,** | <code>string</code> | API key to link to your account |
575
+ | **-a** | <code>string</code> | API key to link to your account |
538
576
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
539
577
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
540
578
 
@@ -557,8 +595,8 @@ npx @capgo/cli@latest app debug com.example.app --device DEVICE_ID
557
595
 
558
596
  | Param | Type | Description |
559
597
  | -------------- | ------------- | -------------------- |
560
- | **-a,** | <code>string</code> | API key to link to your account |
561
- | **-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 |
562
600
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
563
601
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
564
602
 
@@ -605,10 +643,10 @@ npx @capgo/cli@latest app set com.example.app --name "Updated App" --retention 3
605
643
 
606
644
  | Param | Type | Description |
607
645
  | -------------- | ------------- | -------------------- |
608
- | **-n,** | <code>string</code> | App name for display in Capgo Cloud |
609
- | **-i,** | <code>string</code> | App icon path for display in Capgo Cloud |
610
- | **-a,** | <code>string</code> | API key to link to your account |
611
- | **-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) |
612
650
  | **--expose-metadata** | <code>string</code> | Expose bundle metadata (link and comment) to the plugin (true/false, default: false) |
613
651
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
614
652
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
@@ -638,9 +676,9 @@ npx @capgo/cli@latest channel add production com.example.app --default
638
676
 
639
677
  | Param | Type | Description |
640
678
  | -------------- | ------------- | -------------------- |
641
- | **-d,** | <code>string</code> | Set the channel as default |
679
+ | **-d** | <code>boolean</code> | Set the channel as default |
642
680
  | **--self-assign** | <code>boolean</code> | Allow device to self-assign to this channel |
643
- | **-a,** | <code>string</code> | API key to link to your account |
681
+ | **-a** | <code>string</code> | API key to link to your account |
644
682
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
645
683
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
646
684
 
@@ -664,7 +702,7 @@ npx @capgo/cli@latest channel delete production com.example.app
664
702
 
665
703
  | Param | Type | Description |
666
704
  | -------------- | ------------- | -------------------- |
667
- | **-a,** | <code>string</code> | API key to link to your account |
705
+ | **-a** | <code>string</code> | API key to link to your account |
668
706
  | **--delete-bundle** | <code>boolean</code> | Delete the bundle associated with the channel |
669
707
  | **--success-if-not-found** | <code>boolean</code> | Success if the channel is not found |
670
708
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
@@ -690,7 +728,7 @@ npx @capgo/cli@latest channel list com.example.app
690
728
 
691
729
  | Param | Type | Description |
692
730
  | -------------- | ------------- | -------------------- |
693
- | **-a,** | <code>string</code> | API key to link to your account |
731
+ | **-a** | <code>string</code> | API key to link to your account |
694
732
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
695
733
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
696
734
 
@@ -712,8 +750,8 @@ npx @capgo/cli@latest channel currentBundle production com.example.app
712
750
 
713
751
  | Param | Type | Description |
714
752
  | -------------- | ------------- | -------------------- |
715
- | **-c,** | <code>string</code> | Channel to get the current bundle from |
716
- | **-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 |
717
755
  | **--quiet** | <code>boolean</code> | Only print the bundle version |
718
756
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
719
757
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
@@ -739,9 +777,9 @@ npx @capgo/cli@latest channel set production com.example.app --bundle 1.0.0 --st
739
777
 
740
778
  | Param | Type | Description |
741
779
  | -------------- | ------------- | -------------------- |
742
- | **-a,** | <code>string</code> | API key to link to your account |
743
- | **-b,** | <code>string</code> | Bundle version number of the file to set |
744
- | **-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 |
745
783
  | **--latest-remote** | <code>boolean</code> | Get the latest bundle uploaded in capgo cloud and set it to the channel |
746
784
  | **--latest** | <code>boolean</code> | Get the latest version key in the package.json to set it to the channel |
747
785
  | **--downgrade** | <code>boolean</code> | Allow to downgrade to version under native one |
@@ -790,7 +828,7 @@ npx @capgo/cli@latest key save --key ./path/to/key.pub
790
828
 
791
829
  | Param | Type | Description |
792
830
  | -------------- | ------------- | -------------------- |
793
- | **-f,** | <code>string</code> | Force generate a new one |
831
+ | **-f** | <code>boolean</code> | Force generate a new one |
794
832
  | **--key** | <code>string</code> | Key path to save in Capacitor config |
795
833
  | **--key-data** | <code>string</code> | Key data to save in Capacitor config |
796
834
 
@@ -815,7 +853,7 @@ npx @capgo/cli@latest key create
815
853
 
816
854
  | Param | Type | Description |
817
855
  | -------------- | ------------- | -------------------- |
818
- | **-f,** | <code>string</code> | Force generate a new one |
856
+ | **-f** | <code>boolean</code> | Force generate a new one |
819
857
 
820
858
  ### <a id="key-delete_old"></a> 🗑️ **Delete_old**
821
859
 
@@ -854,7 +892,7 @@ npx @capgo/cli@latest account id
854
892
 
855
893
  | Param | Type | Description |
856
894
  | -------------- | ------------- | -------------------- |
857
- | **-a,** | <code>string</code> | API key to link to your account |
895
+ | **-a** | <code>string</code> | API key to link to your account |
858
896
 
859
897
 
860
898
  ## <a id="organization"></a> 🔹 **Organization**
@@ -881,7 +919,7 @@ npx @capgo/cli@latest organization list
881
919
 
882
920
  | Param | Type | Description |
883
921
  | -------------- | ------------- | -------------------- |
884
- | **-a,** | <code>string</code> | API key to link to your account |
922
+ | **-a** | <code>string</code> | API key to link to your account |
885
923
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
886
924
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
887
925
 
@@ -905,9 +943,9 @@ npx @capgo/cli@latest organization add --name "My Company" --email admin@mycompa
905
943
 
906
944
  | Param | Type | Description |
907
945
  | -------------- | ------------- | -------------------- |
908
- | **-n,** | <code>string</code> | Organization name |
909
- | **-e,** | <code>string</code> | Management email for the organization |
910
- | **-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 |
911
949
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
912
950
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
913
951
 
@@ -935,7 +973,7 @@ npx @capgo/cli@latest organization members ORG_ID
935
973
 
936
974
  | Param | Type | Description |
937
975
  | -------------- | ------------- | -------------------- |
938
- | **-a,** | <code>string</code> | API key to link to your account |
976
+ | **-a** | <code>string</code> | API key to link to your account |
939
977
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
940
978
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
941
979
 
@@ -960,8 +998,8 @@ npx @capgo/cli@latest organization set ORG_ID --name "New Name"
960
998
 
961
999
  | Param | Type | Description |
962
1000
  | -------------- | ------------- | -------------------- |
963
- | **-n,** | <code>string</code> | Organization name |
964
- | **-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 |
965
1003
  | **--enforce-2fa** | <code>boolean</code> | Enable 2FA enforcement for all organization members |
966
1004
  | **--no-enforce-2fa** | <code>boolean</code> | Disable 2FA enforcement for organization |
967
1005
  | **--password-policy** | <code>boolean</code> | Enable password policy enforcement for organization |
@@ -978,7 +1016,7 @@ npx @capgo/cli@latest organization set ORG_ID --name "New Name"
978
1016
  | **--max-apikey-expiration-days** | <code>string</code> | Maximum days before API key expiration (1-365, null for no limit) |
979
1017
  | **--enforce-hashed-api-keys** | <code>boolean</code> | Enforce hashed/secure API keys (key value stored as hash, shown only once) |
980
1018
  | **--no-enforce-hashed-api-keys** | <code>boolean</code> | Allow plain-text API keys |
981
- | **-a,** | <code>string</code> | API key to link to your account |
1019
+ | **-a** | <code>string</code> | API key to link to your account |
982
1020
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
983
1021
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
984
1022
 
@@ -1003,7 +1041,7 @@ npx @capgo/cli@latest organization delete ORG_ID
1003
1041
 
1004
1042
  | Param | Type | Description |
1005
1043
  | -------------- | ------------- | -------------------- |
1006
- | **-a,** | <code>string</code> | API key to link to your account |
1044
+ | **-a** | <code>string</code> | API key to link to your account |
1007
1045
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
1008
1046
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
1009
1047
 
@@ -1026,7 +1064,7 @@ npx @capgo/cli@latest organisation list
1026
1064
 
1027
1065
  | Param | Type | Description |
1028
1066
  | -------------- | ------------- | -------------------- |
1029
- | **-a,** | <code>string</code> | API key to link to your account |
1067
+ | **-a** | <code>string</code> | API key to link to your account |
1030
1068
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
1031
1069
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
1032
1070
 
@@ -1044,9 +1082,9 @@ npx @capgo/cli@latest organisation add
1044
1082
 
1045
1083
  | Param | Type | Description |
1046
1084
  | -------------- | ------------- | -------------------- |
1047
- | **-n,** | <code>string</code> | Organization name |
1048
- | **-e,** | <code>string</code> | Management email for the organization |
1049
- | **-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 |
1050
1088
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
1051
1089
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
1052
1090
 
@@ -1064,8 +1102,8 @@ npx @capgo/cli@latest organisation set
1064
1102
 
1065
1103
  | Param | Type | Description |
1066
1104
  | -------------- | ------------- | -------------------- |
1067
- | **-n,** | <code>string</code> | Organization name |
1068
- | **-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 |
1069
1107
  | **--enforce-2fa** | <code>boolean</code> | Enable 2FA enforcement for all organization members |
1070
1108
  | **--no-enforce-2fa** | <code>boolean</code> | Disable 2FA enforcement for organization |
1071
1109
  | **--password-policy** | <code>boolean</code> | Enable password policy enforcement for organization |
@@ -1082,7 +1120,7 @@ npx @capgo/cli@latest organisation set
1082
1120
  | **--max-apikey-expiration-days** | <code>string</code> | Maximum days before API key expiration (1-365, null for no limit) |
1083
1121
  | **--enforce-hashed-api-keys** | <code>boolean</code> | Enforce hashed/secure API keys (key value stored as hash, shown only once) |
1084
1122
  | **--no-enforce-hashed-api-keys** | <code>boolean</code> | Allow plain-text API keys |
1085
- | **-a,** | <code>string</code> | API key to link to your account |
1123
+ | **-a** | <code>string</code> | API key to link to your account |
1086
1124
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
1087
1125
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
1088
1126
 
@@ -1100,7 +1138,7 @@ npx @capgo/cli@latest organisation delete
1100
1138
 
1101
1139
  | Param | Type | Description |
1102
1140
  | -------------- | ------------- | -------------------- |
1103
- | **-a,** | <code>string</code> | API key to link to your account |
1141
+ | **-a** | <code>string</code> | API key to link to your account |
1104
1142
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
1105
1143
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
1106
1144
 
@@ -1132,7 +1170,7 @@ Set up iOS build credentials interactively (creates certificates and profiles au
1132
1170
 
1133
1171
  | Param | Type | Description |
1134
1172
  | -------------- | ------------- | -------------------- |
1135
- | **-a,** | <code>string</code> | API key to link to your account |
1173
+ | **-a** | <code>string</code> | API key to link to your account |
1136
1174
 
1137
1175
  ### <a id="build-request"></a> 🔹 **Request**
1138
1176
 
@@ -1185,17 +1223,13 @@ npx @capgo/cli@latest build request com.example.app --platform ios --path .
1185
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 |
1186
1224
  | **--skip-build-number-bump** | <code>boolean</code> | Skip automatic build number/version code incrementing. Uses whatever version is already in the project files. |
1187
1225
  | **--no-skip-build-number-bump** | <code>boolean</code> | Override saved credentials to re-enable automatic build number incrementing for this build only. |
1188
- | **-a,** | <code>string</code> | API key to link to your account |
1226
+ | **-a** | <code>string</code> | API key to link to your account |
1189
1227
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
1190
1228
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
1191
1229
  | **--verbose** | <code>boolean</code> | Enable verbose output with detailed logging |
1192
1230
 
1193
1231
  ### <a id="build-credentials"></a> 🔹 **Credentials**
1194
1232
 
1195
- ```bash
1196
- npx @capgo/cli@latest build credentials
1197
- ```
1198
-
1199
1233
  Manage build credentials stored locally on your machine.
1200
1234
  🔒 SECURITY:
1201
1235
  - Credentials saved to ~/.capgo-credentials/credentials.json (global) or .capgo-credentials.json (local)
@@ -1206,6 +1240,181 @@ Manage build credentials stored locally on your machine.
1206
1240
  iOS setup: https://capgo.app/docs/cli/cloud-build/ios/
1207
1241
  Android setup: https://capgo.app/docs/cli/cloud-build/android/
1208
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
+
1209
1418
 
1210
1419
  ## <a id="probe"></a> 🔹 **Probe**
1211
1420
 
@@ -1223,7 +1432,7 @@ and reports whether an update would be delivered, or explains why not.
1223
1432
  npx @capgo/cli@latest probe --platform ios
1224
1433
  ```
1225
1434
 
1226
- ## <a id="options"></a> Options
1435
+ ## <a id="options-probe"></a> Options (Probe)
1227
1436
 
1228
1437
  | Param | Type | Description |
1229
1438
  | -------------- | ------------- | -------------------- |