📢 channel

📢 Manage distribution channels for app updates in Capgo Cloud, controlling how updates are delivered to devices.

➕ Add

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 --default

Options:

Param	Type	Description
-d	boolean	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

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.app

Options:

Param	Type	Description
-a	string	API key to link to your account
—delete-bundle	boolean	Delete the bundle associated with the channel. An App Preview key can atomically delete only its own preview channel and linked, unshared bundle.
—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)

Caution

Use an organization- and app-bound App Preview API key with --delete-bundle only for a non-public PR preview channel. The command uses a narrow atomic cleanup route: it succeeds only for the channel and linked, unshared bundle that key created. The key cannot use it on an existing default/main channel, another preview key’s channel, or another key’s bundle, and it still does not receive general bundle.delete. See API Keys for setup.

📋 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.app

Options:

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

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.app

Options:

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

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 default

Options:

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)
—rollout-bundle	string	Bundle version to release gradually on this channel
—rollout-percentage	string	Rollout percentage from 0 to 100
—rollout-percentage-bps	string	Rollout percentage in basis points from 0 to 10000
—rollout-enable	boolean	Enable the configured rollout
—rollout-disable	boolean	Disable the configured rollout
—rollout-pause	boolean	Pause rollout exposure without rolling back selected devices
—rollout-resume	boolean	Resume a paused rollout
—rollout-rollback	boolean	Clear rollout state and return devices to stable
—rollout-promote	boolean	Promote rollout target to stable and clear rollout state
—rollout-cache-ttl-seconds	string	Cloudflare rollout decision cache TTL in seconds
—auto-pause-enabled	boolean	Enable rollout auto-pause policy
—auto-pause-disabled	boolean	Disable rollout auto-pause policy
—auto-pause-window-minutes	string	Stats window for rollout auto-pause
—auto-pause-failure-rate-bps	string	Failure-rate threshold in basis points
—auto-pause-confidence	string	Confidence level between 0 and 1
—auto-pause-min-attempts	string	Minimum install plus fail attempts before auto-pause can trigger
—auto-pause-min-failures	string	Minimum failures before auto-pause can trigger
—auto-pause-action	string	Auto-pause action: pause, rollback, or notify
—auto-pause-cooldown-minutes	string	Cooldown before auto-pause can trigger again
—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
—qr-preview	boolean	Print a terminal QR code for this channel preview after updating it
—send-update-notification	boolean	Send a native update-check notification to devices after updating the linked channel bundle
—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)