📢 channel
Copy a setup prompt with the install steps and the full markdown guide for this plugin.
📢 Manage distribution channels for app updates in Capgo Cloud, controlling how updates are delivered to devices.
Alias: a
npx @capgo/cli@latest channel add➕ Create a new channel for app distribution in Capgo Cloud to manage update delivery.
Example:
npx @capgo/cli@latest channel add production com.example.app --defaultOptions:
| Param | Type | Description |
|---|---|---|
| -d, | string | Set the channel as default |
| —self-assign | boolean | Allow device to self-assign to this channel |
| -a, | string | API key to link to your account |
| —supa-host | string | Custom Supabase host URL (for self-hosting or Capgo development) |
| —supa-anon | string | Custom Supabase anon key (for self-hosting) |
🗑️ Delete
Section titled “ 🗑️ Delete”Alias: d
npx @capgo/cli@latest channel delete🗑️ Delete a channel from Capgo Cloud, optionally removing associated bundles to free up resources.
Example:
npx @capgo/cli@latest channel delete production com.example.appOptions:
| Param | Type | Description |
|---|---|---|
| -a, | string | API key to link to your account |
| —delete-bundle | boolean | Delete the bundle associated with the channel |
| —success-if-not-found | boolean | Success if the channel is not found |
| —supa-host | string | Custom Supabase host URL (for self-hosting or Capgo development) |
| —supa-anon | string | Custom Supabase anon key (for self-hosting) |
📋 List
Section titled “ 📋 List”Alias: l
npx @capgo/cli@latest channel list📋 List all channels configured for an app in Capgo Cloud to review distribution settings.
Example:
npx @capgo/cli@latest channel list com.example.appOptions:
| Param | Type | Description |
|---|---|---|
| -a, | string | API key to link to your account |
| —supa-host | string | Custom Supabase host URL (for self-hosting or Capgo development) |
| —supa-anon | string | Custom Supabase anon key (for self-hosting) |
📦 CurrentBundle
Section titled “ 📦 CurrentBundle”npx @capgo/cli@latest channel currentBundle📦 Get the current bundle linked to a specific channel in Capgo Cloud for update tracking.
Example:
npx @capgo/cli@latest channel currentBundle production com.example.appOptions:
| Param | Type | Description |
|---|---|---|
| -c, | string | Channel to get the current bundle from |
| -a, | string | API key to link to your account |
| —quiet | boolean | Only print the bundle version |
| —supa-host | string | Custom Supabase host URL (for self-hosting or Capgo development) |
| —supa-anon | string | Custom Supabase anon key (for self-hosting) |
⚙️ Set
Section titled “ ⚙️ Set”Alias: s
npx @capgo/cli@latest channel set⚙️ Configure settings for a channel, such as linking a bundle, setting update strategies (major, minor, metadata, patch, none), or device targeting (iOS, Android, dev, prod, emulator, device). One channel must be default.
Example:
npx @capgo/cli@latest channel set production com.example.app --bundle 1.0.0 --state defaultOptions:
| Param | Type | Description |
|---|---|---|
| -a, | string | API key to link to your account |
| -b, | string | Bundle version number of the file to set |
| -s, | string | Set the state of the channel, default or normal |
| —latest-remote | boolean | Get the latest bundle uploaded in capgo cloud and set it to the channel |
| —latest | boolean | Get the latest version key in the package.json to set it to the channel |
| —downgrade | boolean | Allow to downgrade to version under native one |
| —no-downgrade | boolean | Disable downgrade to version under native one |
| —ios | boolean | Allow sending update to iOS devices |
| —no-ios | boolean | Disable sending update to iOS devices |
| —android | boolean | Allow sending update to Android devices |
| —no-android | boolean | Disable sending update to Android devices |
| —self-assign | boolean | Allow device to self-assign to this channel |
| —no-self-assign | boolean | Disable devices to self-assign to this channel |
| —disable-auto-update | string | Block updates by type: major, minor, metadata, patch, or none (allows all) |
| —dev | boolean | Allow sending update to development devices |
| —no-dev | boolean | Disable sending update to development devices |
| —prod | boolean | Allow sending update to production devices |
| —no-prod | boolean | Disable sending update to production devices |
| —emulator | boolean | Allow sending update to emulator devices |
| —no-emulator | boolean | Disable sending update to emulator devices |
| —device | boolean | Allow sending update to physical devices |
| —no-device | boolean | Disable sending update to physical devices |
| —package-json | string | Paths to package.json files for monorepos (comma-separated) |
| —ignore-metadata-check | boolean | Ignore checking node_modules compatibility if present in the bundle |
| —supa-host | string | Custom Supabase host URL (for self-hosting or Capgo development) |
| —supa-anon | string | Custom Supabase anon key (for self-hosting) |
Keep going from channel
Section titled “Keep going from channel”If you are using channel to plan channel routing and staged rollout, connect it with Channels for the implementation detail in Channels, Channels for the implementation detail in Channels, Channels for the implementation detail in Channels, Beta Testing Solution for the product workflow in Beta Testing Solution, and Version Targeting Solution for the product workflow in Version Targeting Solution.