@capgo/cli 8.0.0 → 8.0.2

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
@@ -30,6 +30,7 @@ Follow the documentation here: https://capacitorjs.com/docs/getting-started/
30
30
  - 🔹 [Star-all](#star-all)
31
31
  - 👨‍⚕️ [Doctor](#doctor)
32
32
  - 🔑 [Login](#login)
33
+ - 🔹 [Get-qr](#get-qr)
33
34
  - 📦 [Bundle](#bundle)
34
35
  - [Upload](#bundle-upload)
35
36
  - [Compatibility](#bundle-compatibility)
@@ -220,6 +221,32 @@ npx @capgo/cli@latest login YOUR_API_KEY
220
221
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
221
222
 
222
223
 
224
+ ## <a id="get-qr"></a> 🔹 **Get-qr**
225
+
226
+ ```bash
227
+ npx @capgo/cli@latest get-qr
228
+ ```
229
+
230
+ 🔳 Print a terminal QR code for a bundle or channel preview.
231
+ Preview must be enabled for the app.
232
+ Examples:
233
+ npx @capgo/cli@latest get-qr com.example.app --bundle 1.2.3
234
+ npx @capgo/cli@latest get-qr com.example.app --bundle 123
235
+ npx @capgo/cli@latest get-qr com.example.app --channel production
236
+ npx @capgo/cli@latest get-qr com.example.app production --type channel
237
+
238
+ ## <a id="options-get-qr"></a> Options (Get-qr)
239
+
240
+ | Param | Type | Description |
241
+ | -------------- | ------------- | -------------------- |
242
+ | **-a** | <code>string</code> | API key to link to your account |
243
+ | **--bundle** | <code>string</code> | Bundle name or id to preview |
244
+ | **--channel** | <code>string</code> | Channel name or id to preview |
245
+ | **--type** | <code>string</code> | Type for positional target |
246
+ | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
247
+ | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
248
+
249
+
223
250
  ## <a id="bundle"></a> 📦 **Bundle**
224
251
 
225
252
  📦 Manage app bundles for deployment in Capgo Cloud, including upload, compatibility checks, and encryption.
@@ -295,6 +322,7 @@ npx @capgo/cli@latest bundle upload com.example.app --path ./dist --channel prod
295
322
  | **--disable-brotli** | <code>boolean</code> | Completely disable brotli compression even if updater version supports it |
296
323
  | **--version-exists-ok** | <code>boolean</code> | Exit successfully if bundle version already exists, useful for CI/CD workflows with monorepos |
297
324
  | **--self-assign** | <code>boolean</code> | Allow devices to auto-join this channel (updates channel setting) |
325
+ | **--qr-preview** | <code>boolean</code> | Print a terminal QR code for this bundle preview after upload |
298
326
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
299
327
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
300
328
  | **--verbose** | <code>boolean</code> | Enable verbose output with detailed logging |
@@ -652,6 +680,8 @@ npx @capgo/cli@latest app set com.example.app --name "Updated App" --retention 3
652
680
  | **-a** | <code>string</code> | API key to link to your account |
653
681
  | **-r** | <code>string</code> | Days to keep old bundles (0 = infinite, default: 0) |
654
682
  | **--expose-metadata** | <code>string</code> | Expose bundle metadata (link and comment) to the plugin (true/false, default: false) |
683
+ | **--preview** | <code>boolean</code> | Enable bundle and channel preview QR codes for this app |
684
+ | **--no-preview** | <code>boolean</code> | Disable bundle and channel preview QR codes for this app |
655
685
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
656
686
  | **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
657
687
 
@@ -803,6 +833,7 @@ npx @capgo/cli@latest channel set production com.example.app --bundle 1.0.0 --st
803
833
  | **--no-emulator** | <code>boolean</code> | Disable sending update to emulator devices |
804
834
  | **--device** | <code>boolean</code> | Allow sending update to physical devices |
805
835
  | **--no-device** | <code>boolean</code> | Disable sending update to physical devices |
836
+ | **--qr-preview** | <code>boolean</code> | Print a terminal QR code for this channel preview after updating it |
806
837
  | **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
807
838
  | **--ignore-metadata-check** | <code>boolean</code> | Ignore checking node_modules compatibility if present in the bundle |
808
839
  | **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |