@capgo/cli 8.24.3 → 8.24.5

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.
Files changed (6) hide show
  1. package/README.md +90 -10
  2. package/dist/index.js +515 -515
  3. package/dist/package.json +1 -1
  4. package/dist/src/api/app.d.ts +1 -0
  5. package/dist/src/sdk.js +264 -264
  6. package/package.json +1 -1
package/README.md CHANGED
@@ -1,22 +1,102 @@
1
1
  # Capgo CLI
2
- <a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
2
+ <a href="https://capgo.app/"><img src="https://capgo.app/readme-banner.svg?repo=Cap-go/capgo" alt="Capgo - Instant updates for Capacitor" /></a>
3
+ [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.com/invite/VnYRvBfgA6)
4
+ <a href="https://discord.com/invite/VnYRvBfgA6"><img src="https://img.shields.io/discord/912707985829163099?color=%237289DA&label=Discord" alt="Discord"></a>
5
+ [![npm](https://img.shields.io/npm/dm/@capgo/cli)](https://www.npmjs.com/package/@capgo/cli)
6
+ [![GitHub latest commit](https://badgen.net/github/last-commit/Cap-go/capgo/main)](https://github.com/Cap-go/capgo/commit/)
7
+ [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capgo&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=Cap-go_capgo)
8
+ [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capgo&metric=bugs)](https://sonarcloud.io/summary/new_code?id=Cap-go_capgo)
9
+ [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capgo&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=Cap-go_capgo)
10
+ [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=Cap-go_capgo&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=Cap-go_capgo)
3
11
 
4
12
  <div align="center">
5
- <h2><a href="https://capgo.app/">Check out: Capgo — Instant updates for capacitor</a></h2>
13
+ <h2><a href="https://capgo.app/?ref=cli_readme"> ➡️ Get Instant updates for your App with Capgo</a></h2>
14
+ <h2><a href="https://capgo.app/consulting/?ref=cli_readme"> Missing a feature? We’ll build it for you 💪</a></h2>
6
15
  </div>
7
16
 
8
- A CLI to upload and download files from the Capgo Cloud.
17
+ Command line tool to manage Capgo apps, bundles, channels, compatibility checks,
18
+ and cloud builds from your terminal or CI.
9
19
 
10
- You can find the most up-to-date version of this doc in our web doc:
11
- https://capgo.app/docs/cli/overview/
20
+ Open-source CLI for Capacitor live updates.
12
21
 
13
- ## Usage
22
+ ## Why Capgo CLI?
14
23
 
15
- Before using the CLI, you should register here: https://capgo.app/
24
+ Shipping live updates should not require clicking through a dashboard for every
25
+ release. Capgo CLI solves this by:
16
26
 
17
- Then go to your account in the `apikey` section and click the `all` key to copy it.
27
+ - **Fast setup** - Connect a Capacitor app to Capgo with one guided command
28
+ - **CI-ready uploads** - Build your app, upload the web bundle, and assign it to a channel
29
+ - **Compatibility checks** - Detect when a native release is required instead of an OTA update
30
+ - **Channel control** - Promote bundles through production, beta, QA, or custom release tracks
31
+ - **Cloud builds** - Save credentials locally and request iOS or Android builds from the CLI
32
+ - **Automation** - Use the SDK or MCP server for scripts, agents, and release tooling
18
33
 
19
- Follow the documentation here: https://capacitorjs.com/docs/getting-started/
34
+ Perfect for first-time setup, repeatable releases, native-vs-OTA decisions, and
35
+ teams that want Capgo controlled from CI.
36
+
37
+ ## Features
38
+
39
+ - ☁️ Cloud / Self hosted Support: Use [Capgo Cloud](https://capgo.app/) or your own Supabase backend.
40
+ - 🚀 Guided Setup: Initialize a Capacitor app and verify live updates end to end.
41
+ - 📦 Bundle Management: Upload, list, delete, encrypt, decrypt, and clean bundles.
42
+ - 📺 Channel Support: Assign bundles to release channels and manage rollout tracks.
43
+ - 🧪 Compatibility: Check native package compatibility before shipping OTA updates.
44
+ - 🔁 **Delta Updates**: Upload changed files only when instant updates are enabled.
45
+ - 🔒 **Security**: Support signed and encrypted bundles for sensitive apps.
46
+ - 📱 Device Runner: Launch iOS or Android devices and simulators from the CLI.
47
+ - 🏗️ Cloud Builds: Request iOS and Android builds with locally stored credentials.
48
+ - 🤖 MCP + SDK: Automate Capgo from AI agents, Node.js, or TypeScript scripts.
49
+ - 🔋 Supports Android and iOS
50
+ - ⚡️ Capacitor 4/5/6/7/8 support through the Capgo updater ecosystem
51
+ - 🌐 **Open Source Backend**: Self install [our backend](https://github.com/Cap-go/capgo) in your infra
52
+
53
+ You have 3 ways possible:
54
+
55
+ - Use [capgo.app](https://capgo.app) for a full featured live-update system with setup, upload, channels, rollback, stats, and cloud builds.
56
+ - Use your own self-hosted backend with `--supa-host` and `--supa-anon` on supported commands.
57
+ - Use the CLI programmatically through the SDK or MCP server for custom release automation.
58
+
59
+ ## Quick Start
60
+
61
+ Create your account in [capgo.app](https://capgo.app), get your [API key](https://console.capgo.app/dashboard/apikeys), and run:
62
+
63
+ ```bash
64
+ npx @capgo/cli@latest init YOUR_API_KEY com.example.app
65
+ ```
66
+
67
+ For an app that is already configured, upload a new bundle with:
68
+
69
+ ```bash
70
+ npx @capgo/cli@latest bundle upload com.example.app --path ./dist --channel production
71
+ ```
72
+
73
+ ## CI Upload Example
74
+
75
+ ```bash
76
+ npm ci
77
+ npm run build
78
+ npx @capgo/cli@latest bundle upload com.example.app \
79
+ --apikey "$CAPGO_API_KEY" \
80
+ --path ./dist \
81
+ --channel production \
82
+ --bundle "$GITHUB_SHA" \
83
+ --version-exists-ok
84
+ ```
85
+
86
+ Add `--fail-on-incompatible` when CI must stop instead of uploading a bundle that
87
+ cannot safely update the current native build.
88
+
89
+ ## Documentation
90
+
91
+ The most complete [documentation is here](https://capgo.app/docs/).
92
+
93
+ - CLI guide: https://capgo.app/docs/cli/overview/
94
+ - Live updates setup: https://capgo.app/docs/plugin/cloud-mode/getting-started/
95
+ - Cloud build guides: https://capgo.app/docs/cli/cloud-build/ios/ and https://capgo.app/docs/cli/cloud-build/android/
96
+
97
+ ## Community
98
+
99
+ Join the [discord](https://discord.gg/VnYRvBfgA6) to get help.
20
100
 
21
101
  <!-- AUTO-GENERATED-DOCS-START -->
22
102
  ## 📑 Capgo CLI Commands
@@ -683,7 +763,7 @@ npx @capgo/cli@latest app set com.example.app --name "Updated App" --retention 3
683
763
  | Param | Type | Description |
684
764
  | -------------- | ------------- | -------------------- |
685
765
  | **-n** | <code>string</code> | App name for display in Capgo Cloud |
686
- | **-i** | <code>string</code> | App icon path for display in Capgo Cloud |
766
+ | **-i** | <code>string</code> | Local image file path (png, jpg, webp, svg) used as the app icon in Capgo Cloud |
687
767
  | **-a** | <code>string</code> | API key to link to your account |
688
768
  | **-r** | <code>string</code> | Days to keep old bundles (0 = infinite, default: 0) |
689
769
  | **--expose-metadata** | <code>string</code> | Expose bundle metadata (link and comment) to the plugin (true/false, default: false) |