@capgo/cli 8.97.3 → 8.98.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 +121 -1
- package/dist/index.js +939 -910
- package/dist/notify-app-ready-worker.js +4 -4
- package/dist/onboarding-worker.js +4 -4
- package/dist/package.json +4 -2
- package/dist/src/analytics/opt-out.d.ts +1 -0
- package/dist/src/build/archive.d.ts +54 -0
- package/dist/src/build/credentials-remote.d.ts +55 -0
- package/dist/src/build/request.d.ts +6 -30
- package/dist/src/build/zip-command.d.ts +10 -0
- package/dist/src/bundle/delta-pack.d.ts +45 -0
- package/dist/src/bundle/partial.d.ts +8 -1
- package/dist/src/bundle/upload-artifact.d.ts +51 -0
- package/dist/src/mcp/tool-schemas.d.ts +1 -0
- package/dist/src/schemas/build.d.ts +41 -0
- package/dist/src/schemas/bundle.d.ts +49 -1
- package/dist/src/schemas/sdk.d.ts +23 -1
- package/dist/src/sdk.d.ts +10 -2
- package/dist/src/sdk.js +381 -379
- package/dist/src/shared/json-stdout.d.ts +6 -0
- package/dist/updater-installed-worker.js +4 -4
- package/package.json +4 -2
- package/skills/native-builds/SKILL.md +22 -0
- package/skills/release-management/SKILL.md +15 -2
package/README.md
CHANGED
|
@@ -185,6 +185,7 @@ Capgo continues to load the root config while writing only the selected source.
|
|
|
185
185
|
- [Needed](#build-needed)
|
|
186
186
|
- [Init](#build-init)
|
|
187
187
|
- [Request](#build-request)
|
|
188
|
+
- [Zip](#build-zip)
|
|
188
189
|
- [Sync-ios-version](#build-sync-ios-version)
|
|
189
190
|
- [Prescan](#build-prescan)
|
|
190
191
|
- [Last-output](#build-last-output)
|
|
@@ -198,6 +199,9 @@ Capgo continues to load the root config while writing only the selected source.
|
|
|
198
199
|
- [Manage](#build-credentials-manage)
|
|
199
200
|
- [Export](#build-credentials-export)
|
|
200
201
|
- [Migrate](#build-credentials-migrate)
|
|
202
|
+
- [Push](#build-credentials-push)
|
|
203
|
+
- [Remote-status](#build-credentials-remote-status)
|
|
204
|
+
- [Remote-delete](#build-credentials-remote-delete)
|
|
201
205
|
- 🔹 [Notifications](#notifications)
|
|
202
206
|
- [Setup](#notifications-setup)
|
|
203
207
|
- 🔹 [Probe](#probe)
|
|
@@ -658,6 +662,9 @@ npx @capgo/cli@latest bundle zip
|
|
|
658
662
|
|
|
659
663
|
🗜️ Create a zip file of your app bundle.
|
|
660
664
|
Returns checksum for use with encryption. Use --json for machine-readable output.
|
|
665
|
+
Works offline: no API key and no calls to Capgo.
|
|
666
|
+
--for-upload produces exactly what 'bundle upload' would send (same checksum, v2 encryption, native packages metadata)
|
|
667
|
+
so the zip can be uploaded through a signed URL. --delta-pack also writes the delta (manifest) files.
|
|
661
668
|
|
|
662
669
|
**Example:**
|
|
663
670
|
|
|
@@ -675,8 +682,17 @@ npx @capgo/cli@latest bundle zip com.example.app --path ./dist
|
|
|
675
682
|
| **-j** | <code>boolean</code> | Output in JSON |
|
|
676
683
|
| **--no-code-check** | <code>boolean</code> | Ignore checking if notifyAppReady() is called in source code and index present in root folder |
|
|
677
684
|
| **--ignore-notify-app-ready** | <code>boolean</code> | Skip notifyAppReady() check (not recommended — updates may roll back) |
|
|
678
|
-
| **--key-v2** | <code>
|
|
685
|
+
| **--key-v2** | <code>string</code> | Use encryption v2. With --for-upload: custom path for private signing key (v2 system), defaults to .capgo_key_v2 |
|
|
686
|
+
| **--key-data-v2** | <code>string</code> | Private signing key (v2 system), used with --for-upload |
|
|
687
|
+
| **--no-key** | <code>boolean</code> | Ignore signing key and produce a clear bundle (with --for-upload) |
|
|
688
|
+
| **--for-upload** | <code>boolean</code> | Produce the exact artifact and metadata 'bundle upload' would send (encryption, checksum, native packages) |
|
|
689
|
+
| **--delta-pack** | <code>string</code> | Also write a delta pack zip (manifest + per-file upload bytes) for delta uploads. Implies --for-upload |
|
|
690
|
+
| **--encrypt-delta** | <code>boolean</code> | Encrypt delta update files (auto-enabled for updater >= 6.14.4) |
|
|
691
|
+
| **--encrypt-partial** | <code>boolean</code> | [DEPRECATED] Use --encrypt-delta instead. Encrypt delta update files |
|
|
692
|
+
| **--disable-brotli** | <code>boolean</code> | Completely disable brotli compression even if updater version supports it |
|
|
693
|
+
| **--force-crc32-checksum** | <code>boolean</code> | Force CRC32 checksum for upload (override auto-detection) |
|
|
679
694
|
| **--package-json** | <code>string</code> | Paths to package.json files for monorepos (comma-separated) |
|
|
695
|
+
| **--node-modules** | <code>string</code> | Paths to node_modules directories for monorepos (comma-separated) |
|
|
680
696
|
|
|
681
697
|
|
|
682
698
|
## <a id="app"></a> 📱 **App**
|
|
@@ -1692,6 +1708,7 @@ Examples:
|
|
|
1692
1708
|
| **--ios-target** | <code>string</code> | iOS: Xcode target for reading build settings (default: same as scheme) |
|
|
1693
1709
|
| **--xcode-version** | <code>string</code> | iOS: build on a machine with this Xcode version (e.g. 26, 26.0.1, 27). A major version accepts any minor. Default: any machine. Precedence: CLI > env (CAPGO_IOS_XCODE_VERSION) > saved credentials |
|
|
1694
1710
|
| **--ios-distribution** | <code>string</code> | iOS: Distribution mode. app_store (default) uploads to TestFlight/App Store; ad_hoc skips store upload and builds an Ad Hoc IPA for device install. Use ad_hoc with --output-upload when the App Store app does not exist yet or you only need an IPA download. |
|
|
1711
|
+
| **--use-stored-credentials** | <code>boolean</code> | Use the signing credentials stored on Capgo for this app (see "build credentials push"). Requires app admin rights (app settings permission) on the app. Credentials given by flags, env or a local saved file still take precedence; Capgo validates the merged set. |
|
|
1695
1712
|
| **--ios-provisioning-profile** | <code>string</code> | iOS: Provisioning profile path or bundleId=path mapping (repeatable) |
|
|
1696
1713
|
| **--no-cache** | <code>boolean</code> | Disable Xcode compilation cache for this build (default: cache enabled) |
|
|
1697
1714
|
| **--cache-key** | <code>string</code> | Custom compilation cache key for this build (e.g. rc, prod, feature-branch). Use to share or isolate cache between environments. Precedence over the default appId-only key; ignored when --no-cache is set. |
|
|
@@ -1736,6 +1753,35 @@ Examples:
|
|
|
1736
1753
|
| **--api-host** | <code>string</code> | Custom Capgo API URL for self-hosting or testing, e.g. https://api.example.com or http://127.0.0.1:8787 (env: CAPGO_API_HOST) |
|
|
1737
1754
|
| **--files-host** | <code>string</code> | Custom Capgo files API URL when it differs from --api-host (env: CAPGO_FILES_HOST) |
|
|
1738
1755
|
|
|
1756
|
+
### <a id="build-zip"></a> 🔹 **Zip**
|
|
1757
|
+
|
|
1758
|
+
```bash
|
|
1759
|
+
npx @capgo/cli@latest build zip
|
|
1760
|
+
```
|
|
1761
|
+
|
|
1762
|
+
Zip the native project exactly like 'build request' does, without uploading it.
|
|
1763
|
+
Works offline: no API key and no calls to Capgo. Use it when an agent uploads the archive
|
|
1764
|
+
through a signed URL (Capgo MCP). With --json, prints the archive path, size, sha256 and the
|
|
1765
|
+
non-secret build options derived from the project.
|
|
1766
|
+
|
|
1767
|
+
**Example:**
|
|
1768
|
+
|
|
1769
|
+
```bash
|
|
1770
|
+
npx @capgo/cli@latest build zip com.example.app --platform ios --json
|
|
1771
|
+
```
|
|
1772
|
+
|
|
1773
|
+
**Options:**
|
|
1774
|
+
|
|
1775
|
+
| Param | Type | Description |
|
|
1776
|
+
| -------------- | ------------- | -------------------- |
|
|
1777
|
+
| **--platform** | <code>string</code> | Target platform: ios or android (required) |
|
|
1778
|
+
| **--path** | <code>string</code> | Path to the project directory to build (default: current directory) |
|
|
1779
|
+
| **--node-modules** | <code>string</code> | Paths to node_modules directories for monorepos (comma-separated) |
|
|
1780
|
+
| **--sync-ios-version** | <code>boolean</code> | iOS: sync the app version from package.json before uploading the project. Updates MARKETING_VERSION or CFBundleShortVersionString based on the Xcode Info.plist configuration. |
|
|
1781
|
+
| **--sync-android-version** | <code>boolean</code> | Android: sync versionName in android/app/build.gradle from package.json before uploading the project. Fails unless versionName is a standalone quoted string literal. |
|
|
1782
|
+
| **--output** | <code>string</code> | Path of the zip file to write (default: <appId>_<platform>_native.zip) |
|
|
1783
|
+
| **-j** | <code>boolean</code> | Output in JSON |
|
|
1784
|
+
|
|
1739
1785
|
### <a id="build-sync-ios-version"></a> 🔹 **Sync-ios-version**
|
|
1740
1786
|
|
|
1741
1787
|
```bash
|
|
@@ -2112,6 +2158,80 @@ Example:
|
|
|
2112
2158
|
| **--platform** | <code>string</code> | Platform (only ios is supported) |
|
|
2113
2159
|
| **--local** | <code>boolean</code> | Migrate from local .capgo-credentials.json instead of global |
|
|
2114
2160
|
|
|
2161
|
+
#### <a id="build-credentials-push"></a> 🔹 **Push**
|
|
2162
|
+
|
|
2163
|
+
```bash
|
|
2164
|
+
npx @capgo/cli@latest build credentials push
|
|
2165
|
+
```
|
|
2166
|
+
|
|
2167
|
+
Store this machine's saved build credentials for one platform on Capgo, encrypted.
|
|
2168
|
+
Builds can then use them without sending secrets (build request --use-stored-credentials,
|
|
2169
|
+
or the hosted Capgo MCP). Requires app settings permission (app admin) on the app, and so
|
|
2170
|
+
do builds that use the stored credentials. Custom env names that load code into every
|
|
2171
|
+
build (NODE_OPTIONS, JAVA_TOOL_OPTIONS, GRADLE_OPTS, LD_PRELOAD, PATH, ...) cannot be stored.
|
|
2172
|
+
Only key names are printed; values never are.
|
|
2173
|
+
Examples:
|
|
2174
|
+
npx @capgo/cli@latest build credentials push com.example.app --platform ios
|
|
2175
|
+
npx @capgo/cli@latest build credentials push --platform android --mode merge
|
|
2176
|
+
|
|
2177
|
+
**Options:**
|
|
2178
|
+
|
|
2179
|
+
| Param | Type | Description |
|
|
2180
|
+
| -------------- | ------------- | -------------------- |
|
|
2181
|
+
| **--platform** | <code>string</code> | Platform to store: ios or android (required) |
|
|
2182
|
+
| **--mode** | <code>string</code> | replace: overwrite stored keys (default). merge: keep stored keys not in the local set |
|
|
2183
|
+
| **--local** | <code>boolean</code> | Read from local .capgo-credentials.json only |
|
|
2184
|
+
| **--global** | <code>boolean</code> | Read from ~/.capgo-credentials/credentials.json only |
|
|
2185
|
+
| **-a** | <code>string</code> | API key to link to your account |
|
|
2186
|
+
| **--api-host** | <code>string</code> | Custom Capgo API URL for self-hosting or testing, e.g. https://api.example.com or http://127.0.0.1:8787 (env: CAPGO_API_HOST) |
|
|
2187
|
+
|
|
2188
|
+
#### <a id="build-credentials-remote-status"></a> 🔹 **Remote-status**
|
|
2189
|
+
|
|
2190
|
+
```bash
|
|
2191
|
+
npx @capgo/cli@latest build credentials remote-status
|
|
2192
|
+
```
|
|
2193
|
+
|
|
2194
|
+
Show which build credentials are stored on Capgo for an app (key names and
|
|
2195
|
+
non-secret facts only) and what is still missing to build.
|
|
2196
|
+
|
|
2197
|
+
**Example:**
|
|
2198
|
+
|
|
2199
|
+
```bash
|
|
2200
|
+
npx @capgo/cli@latest build credentials remote-status com.example.app
|
|
2201
|
+
```
|
|
2202
|
+
|
|
2203
|
+
**Options:**
|
|
2204
|
+
|
|
2205
|
+
| Param | Type | Description |
|
|
2206
|
+
| -------------- | ------------- | -------------------- |
|
|
2207
|
+
| **--platform** | <code>string</code> | Only show ios or android |
|
|
2208
|
+
| **-a** | <code>string</code> | API key to link to your account |
|
|
2209
|
+
| **--api-host** | <code>string</code> | Custom Capgo API URL for self-hosting or testing, e.g. https://api.example.com or http://127.0.0.1:8787 (env: CAPGO_API_HOST) |
|
|
2210
|
+
|
|
2211
|
+
#### <a id="build-credentials-remote-delete"></a> 🗑️ **Remote-delete**
|
|
2212
|
+
|
|
2213
|
+
```bash
|
|
2214
|
+
npx @capgo/cli@latest build credentials remote-delete
|
|
2215
|
+
```
|
|
2216
|
+
|
|
2217
|
+
Delete the build credentials stored on Capgo for one platform. Local saved
|
|
2218
|
+
credentials are not touched.
|
|
2219
|
+
|
|
2220
|
+
**Example:**
|
|
2221
|
+
|
|
2222
|
+
```bash
|
|
2223
|
+
npx @capgo/cli@latest build credentials remote-delete com.example.app --platform ios --yes
|
|
2224
|
+
```
|
|
2225
|
+
|
|
2226
|
+
**Options:**
|
|
2227
|
+
|
|
2228
|
+
| Param | Type | Description |
|
|
2229
|
+
| -------------- | ------------- | -------------------- |
|
|
2230
|
+
| **--platform** | <code>string</code> | Platform to delete: ios or android (required) |
|
|
2231
|
+
| **-y** | <code>boolean</code> | Do not ask for confirmation |
|
|
2232
|
+
| **-a** | <code>string</code> | API key to link to your account |
|
|
2233
|
+
| **--api-host** | <code>string</code> | Custom Capgo API URL for self-hosting or testing, e.g. https://api.example.com or http://127.0.0.1:8787 (env: CAPGO_API_HOST) |
|
|
2234
|
+
|
|
2115
2235
|
|
|
2116
2236
|
## <a id="notifications"></a> 🔹 **Notifications**
|
|
2117
2237
|
|