Skip to content

CLI

The Capawesome Cloud Command Line Interface (CLI) can be used to manage Live Updates from the command line.

Installation

The Capawesome CLI can be installed globally via npm:

npm install -g @capawesome/cli

Help

The Capawesome CLI ships with command documentation that is accessible with the --help flag.

npx capawesome --help

Command Reference

apps:create

Create a new app in Capawesome Cloud.

npx capawesome apps:create [options]

Options:

  • --name: The name of the app.

apps:delete

Delete an app from Capawesome Cloud.

npx capawesome apps:delete [options]

Options:

  • --appId: The ID of the app.

apps:bundles:create

Create a new bundle for an app in Capawesome Cloud.

npx capawesome apps:bundles:create [options]

Options:

  • --android-max: The maximum Android version code (versionCode) that the bundle supports.
  • --android-min: The minimum Android version code (versionCode) that the bundle supports.
  • --appId: The ID of the app.
  • --artifact-type: The type of artifact to upload. Must be zip or manifest. Defaults to zip.
  • --channel: The channel to deploy the bundle to.
  • --expires-in-days: The number of days until the bundle is automatically deleted.
  • --ios-max: The maximum iOS version code (CFBundleVersion) that the bundle supports.
  • --ios-min: The minimum iOS version code (CFBundleVersion) that the bundle supports.
  • --path: The path to the bundle to upload. Must be a folder or zip archive.
  • --private-key: The path to the private key to sign the bundle with.
  • --rollout: The percentage of devices to deploy the bundle to. Must be a number between 0 and 1 (e.g. 0.5).
  • --url: The url to the self-hosted bundle file. The url must start with https://.

apps:bundles:update

Update an existing bundle for an app in Capawesome Cloud.

npx capawesome apps:bundles:update [options]

Options:

  • --appId: The ID of the app.
  • --rollout: The percentage of devices to deploy the bundle to. Must be a number between 0 and 1 (e.g. 0.5).
  • --android-max: The maximum Android version code (versionCode) that the bundle supports.
  • --android-min: The minimum Android version code (versionCode) that the bundle supports.
  • --ios-max: The maximum iOS version code (CFBundleVersion) that the bundle supports.
  • --ios-min: The minimum iOS version code (CFBundleVersion) that the bundle supports.

apps:bundles:delete

Delete a bundle from an app in Capawesome Cloud.

npx capawesome apps:bundles:delete [options]

Options:

  • --appId: The ID of the app.
  • --bundleId: The ID of the bundle.

apps:channels:create

Create a new channel for an app in Capawesome Cloud.

npx capawesome apps:channels:create [options]

Options:

  • --appId: The ID of the app.
  • --bundle-limit: The maximum number of bundles that can be assigned to the channel. If more bundles are assigned, the oldest bundles will be automatically deleted. Defaults to unlimited.
  • --name: The name of the channel.

apps:channels:delete

Delete a channel from an app in Capawesome Cloud.

npx capawesome apps:channels:delete [options]

Options:

  • --appId: The ID of the app.
  • --channelId: The ID of the channel.

apps:devices:delete

Delete a device from an app in Capawesome Cloud.

npx capawesome apps:devices:delete [options]

Options:

  • --appId: The ID of the app.
  • --deviceId: The ID of the device.

login

Log in to Capawesome Cloud.

npx capawesome login

Options:

  • --token: The token to use for authentication.

logout

Log out of Capawesome Cloud.

npx capawesome logout

manifests:generate

Generate a manifest file for a bundle.

npx capawesome manifests:generate [options]

Options: - --path: The path to the folder containing the bundle files (e.g. www/dist).