Skip to content

Commit eac3fa6

Browse files
authored
Merge pull request #888 from Cap-go/codex/document-provider-infra-block
docs: cover provider blocks and recent Capgo features
2 parents 0bc90b6 + 5fb3833 commit eac3fa6

24 files changed

Lines changed: 1056 additions & 176 deletions

apps/docs/src/content/docs/docs/cli/commands.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ sidebar:
66
---
77
import { LinkCard } from '@astrojs/starlight/components';
88

9+
This page is a guided overview. Use the current command reference for exact flags: [app](/docs/cli/reference/app/), [bundle](/docs/cli/reference/bundle/), [channel](/docs/cli/reference/channel/), and [build](/docs/cli/reference/build/).
10+
911
### Usage
1012

1113
All command should be run in your app folder with capacitor project ignited properly.
@@ -83,6 +85,14 @@ Optionally, you can give:
8385
* `--icon [/path/to/my/icon]` to have a custom icon display in Capgo web app.
8486
* `--name [test]` to have a custom name in the list.
8587
* `--retention [retention]` retention period of app bundle in days, 0 by default = infinite.
88+
* `--expose-metadata [true|false]` to expose bundle metadata (link and comment) to the plugin.
89+
* `--preview` or `--no-preview` to enable or disable bundle and channel preview QR codes.
90+
* `--allow-device-custom-id` or `--no-allow-device-custom-id` to control custom device IDs.
91+
* `--block-provider-infra-requests` or `--no-block-provider-infra-requests` to control blocking of known Google and Apple datacenter requests.
92+
* `--build-timeout-minutes [5-360]` to set the native build timeout.
93+
* `--ios-store-url [url]` or `--android-store-url [url]` to set the store URL.
94+
* `--default-upload-channel [channel]` to set the default upload channel.
95+
* `--default-download-channel [channel]` to set the default download channel, or `--disable-download-channels` to make all download channels non-public.
8696
* `--apikey [key]` API key to link to your account.
8797

8898
### **List**

apps/docs/src/content/docs/docs/cli/reference/app.mdx

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@ title: 📱 app
33
description: "📱 Manage your Capgo app settings and configurations in Capgo Cloud."
44
sidebar_label: app
55
sidebar:
6-
order: 7
6+
order: 9
77
---
88

99
📱 Manage your Capgo app settings and configurations in Capgo Cloud.
1010

11+
1112
### <a id="app-add"></a> ➕ **Add**
1213

1314
**Alias:** `a`
@@ -29,9 +30,9 @@ npx @capgo/cli@latest app add com.example.app --name "My App" --icon ./icon.png
2930

3031
| Param | Type | Description |
3132
| -------------- | ------------- | -------------------- |
32-
| **-n,** | <code>string</code> | App name for display in Capgo Cloud |
33-
| **-i,** | <code>string</code> | App icon path for display in Capgo Cloud |
34-
| **-a,** | <code>string</code> | API key to link to your account |
33+
| **-n** | <code>string</code> | App name for display in Capgo Cloud |
34+
| **-i** | <code>string</code> | App icon path for display in Capgo Cloud |
35+
| **-a** | <code>string</code> | API key to link to your account |
3536
| **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
3637
| **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
3738

@@ -53,7 +54,7 @@ npx @capgo/cli@latest app delete com.example.app
5354

5455
| Param | Type | Description |
5556
| -------------- | ------------- | -------------------- |
56-
| **-a,** | <code>string</code> | API key to link to your account |
57+
| **-a** | <code>string</code> | API key to link to your account |
5758
| **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
5859
| **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
5960

@@ -77,7 +78,7 @@ npx @capgo/cli@latest app list
7778

7879
| Param | Type | Description |
7980
| -------------- | ------------- | -------------------- |
80-
| **-a,** | <code>string</code> | API key to link to your account |
81+
| **-a** | <code>string</code> | API key to link to your account |
8182
| **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
8283
| **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
8384

@@ -100,8 +101,8 @@ npx @capgo/cli@latest app debug com.example.app --device DEVICE_ID
100101

101102
| Param | Type | Description |
102103
| -------------- | ------------- | -------------------- |
103-
| **-a,** | <code>string</code> | API key to link to your account |
104-
| **-d,** | <code>string</code> | The specific device ID to debug |
104+
| **-a** | <code>string</code> | API key to link to your account |
105+
| **-d** | <code>string</code> | The specific device ID to debug |
105106
| **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
106107
| **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
107108

@@ -148,14 +149,23 @@ npx @capgo/cli@latest app set com.example.app --name "Updated App" --retention 3
148149

149150
| Param | Type | Description |
150151
| -------------- | ------------- | -------------------- |
151-
| **-n,** | <code>string</code> | App name for display in Capgo Cloud |
152-
| **-i,** | <code>string</code> | App icon path for display in Capgo Cloud |
153-
| **-a,** | <code>string</code> | API key to link to your account |
154-
| **-r,** | <code>string</code> | Days to keep old bundles (0 = infinite, default: 0) |
152+
| **-n** | <code>string</code> | App name for display in Capgo Cloud |
153+
| **-i** | <code>string</code> | Local image file path (png, jpg, webp, svg) used as the app icon in Capgo Cloud |
154+
| **-a** | <code>string</code> | API key to link to your account |
155+
| **-r** | <code>string</code> | Days to keep old bundles (0 = infinite, default: 0) |
155156
| **--expose-metadata** | <code>string</code> | Expose bundle metadata (link and comment) to the plugin (true/false, default: false) |
157+
| **--preview** | <code>boolean</code> | Enable bundle and channel preview QR codes for this app |
158+
| **--no-preview** | <code>boolean</code> | Disable bundle and channel preview QR codes for this app |
159+
| **--allow-device-custom-id** | <code>boolean</code> | Allow devices to set a custom device ID for this app |
160+
| **--no-allow-device-custom-id** | <code>boolean</code> | Disallow custom device IDs for this app |
161+
| **--block-provider-infra-requests** | <code>boolean</code> | Block provider infrastructure requests for this app |
162+
| **--no-block-provider-infra-requests** | <code>boolean</code> | Allow provider infrastructure requests for this app |
163+
| **--build-timeout-minutes** | <code>string</code> | Native build timeout in minutes (5-360, default: 15) |
164+
| **--ios-store-url** | <code>string</code> | iOS App Store URL for this app |
165+
| **--android-store-url** | <code>string</code> | Google Play Store URL for this app |
166+
| **--default-upload-channel** | <code>string</code> | Default upload channel name for this app |
167+
| **--default-download-channel** | <code>string</code> | Default download channel name for this app (sets channel public=true) |
168+
| **--disable-download-channels** | <code>boolean</code> | Disable Capgo download channels for this app (sets all channels public=false) |
156169
| **--supa-host** | <code>string</code> | Custom Supabase host URL (for self-hosting or Capgo development) |
157170
| **--supa-anon** | <code>string</code> | Custom Supabase anon key (for self-hosting) |
158171

159-
## Keep going from app
160-
161-
If you are using **app** to plan dashboard and API operations, connect it with [API Overview](/docs/public-api/) for the implementation detail in API Overview, [Introduction](/docs/webapp/) for the implementation detail in Introduction, [API Keys](/docs/public-api/api-keys/) for the implementation detail in API Keys, [Devices](/docs/public-api/devices/) for the implementation detail in Devices, and [Bundles](/docs/public-api/bundles/) for the implementation detail in Bundles.

0 commit comments

Comments
 (0)