Skip to content

CLI

The Capawesome Cloud Command Line Interface (CLI) can be used to manage your apps and resources from the command line, including Live Updates, Native Builds, and App Submissions.

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/cli --help

Command Reference

apps:create

Create a new app in Capawesome Cloud.

npx @capawesome/cli apps:create [options]

Options:

  • --name: The name of the app.
  • --organization-id: The ID of the organization to create the app in.

apps:delete

Delete an app from Capawesome Cloud.

npx @capawesome/cli apps:delete [options]

Options:

  • --app-id: The ID of the app.

apps:builds:cancel

Cancel an app build.

npx @capawesome/cli apps:builds:cancel [options]

Options:

  • --app-id: The ID of the app the build belongs to.
  • --build-id: The ID of the build to cancel.

apps:builds:create

Create a new app build.

npx @capawesome/cli apps:builds:create [options]

Options:

  • --aab: Download the generated AAB file (Android only). Optionally provide a file path.
  • --apk: Download the generated APK file (Android only). Optionally provide a file path.
  • --app-id: The ID of the app to create the build for.
  • --certificate: The name of the certificate to use for the build.
  • --detached: Exit immediately after creating the build without waiting for completion.
  • --environment: The name of the environment to use for the build.
  • --git-ref: The Git reference (branch, tag, or commit SHA) to build.
  • --ipa: Download the generated IPA file (iOS only). Optionally provide a file path.
  • --json: Output in JSON format. This will include additional information such as the build ID.
  • --platform: The platform for the build. Supported values are ios and android.
  • --type: The type of build. For iOS, supported values are simulator, development, ad-hoc, app-store, and enterprise. For Android, supported values are debug and release.

apps:builds:download

Download the build artifacts for an app build.

npx @capawesome/cli apps:builds:download [options]

Options: - --app-id: The ID of the app the build belongs to. - --build-id: The ID of the build to download artifacts for. - --aab: Download the generated AAB file (Android only). Optionally provide a file path. - --apk: Download the generated APK file (Android only). Optionally provide a file path. - --ipa: Download the generated IPA file (iOS only). Optionally provide a file path.

apps:builds:logs

Display the logs for a ongoing or completed app build.

npx @capawesome/cli apps:builds:logs [options]

Options: - --app-id: The ID of the app the build belongs to. - --build-id: The ID of the build to display logs for.

apps:bundles:create

Create a new bundle for an app in Capawesome Cloud.

npx @capawesome/cli apps:bundles:create [options]

Options:

  • --android-eq: The exact Android version code (versionCode) that the bundle does not support.
  • --android-max: The maximum Android version code (versionCode) that the bundle supports.
  • --android-min: The minimum Android version code (versionCode) that the bundle supports.
  • --app-id: 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.
  • --commit-message: The commit message of the Git commit that the bundle is linked to.
  • --commit-ref: The commit ref of the Git commit that the bundle is linked to.
  • --commit-sha: The commit SHA of the Git commit that the bundle is linked to.
  • --custom-property: A custom property to assign to the bundle. Must be in the format key=value. Can be specified multiple times.
  • --expires-in-days: The number of days until the bundle is automatically deleted.
  • --ios-eq: The exact iOS version code (CFBundleVersion) that the bundle does not support.
  • --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:delete

Delete a bundle from an app in Capawesome Cloud.

npx @capawesome/cli apps:bundles:delete [options]

Options:

  • --app-id: The ID of the app.
  • --bundle-id: The ID of the bundle.

apps:bundles:update

Update an existing bundle for an app in Capawesome Cloud.

npx @capawesome/cli apps:bundles:update [options]

Options:

  • --app-id: 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:channels:create

Create a new channel for an app in Capawesome Cloud.

npx @capawesome/cli apps:channels:create [options]

Options:

  • --app-id: 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.
  • --expires-in-days: The number of days until the channel is automatically deleted (including all bundles assigned to the channel). Defaults to never expire.
  • --ignore-errors: Ignore errors when creating the channel. This is useful for CI/CD pipelines where the channel may already exist. Defaults to false.
  • --name: The name of the channel.

apps:channels:delete

Delete a channel from an app in Capawesome Cloud.

npx @capawesome/cli apps:channels:delete [options]

Options:

  • --app-id: The ID of the app.
  • --channel-id: The ID of the channel. Either the ID or the name of the channel must be provided.
  • --name: The name of the channel. Either the ID or the name of the channel must be provided.

apps:channels:get

Get a channel from an app in Capawesome Cloud.

npx @capawesome/cli apps:channels:get [options]

Options:

  • --app-id: The ID of the app.
  • --channel-id: The ID of the channel. Either the ID or the name of the channel must be provided.
  • --json: Output in JSON format.
  • --name: The name of the channel. Either the ID or the name of the channel must be provided.

apps:channels:list

List all channels for an app in Capawesome Cloud.

npx @capawesome/cli apps:channels:list [options]

Options:

  • --app-id: The ID of the app.
  • --json: Output in JSON format.
  • --limit: The maximum number of channels to return.
  • --offset: The offset to start returning channels from.

apps:channels:update

Update an existing channel from an app in Capawesome Cloud.

npx @capawesome/cli apps:channels:update [options]

Options:

  • --app-id: 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.
  • --channel-id: The ID of the channel.
  • --name: The name of the channel.

apps:deployments:cancel

Cancel an ongoing app deployment.

npx @capawesome/cli apps:deployments:cancel [options]

Options:

  • --app-id: The ID of the app the deployment belongs to.
  • --deployment-id: The ID of the deployment to cancel.

apps:deployments:create

Create a new app deployment.

npx @capawesome/cli apps:deployments:create [options]

Options:

  • --app-id: The ID of the app to create the deployment for.
  • --build-id: The ID of the build to deploy.
  • --destination: The name of the destination to deploy to.
  • --detached: Exit immediately after creating the deployment without waiting for completion.

apps:deployments:logs

Display the logs for a ongoing or completed app deployment.

npx @capawesome/cli apps:deployments:logs [options]

Options: - --app-id: The ID of the app the deployment belongs to. - --deployment-id: The ID of the deployment to display logs for.

apps:devices:delete

Delete a device from an app in Capawesome Cloud.

npx @capawesome/cli apps:devices:delete [options]

Options:

  • --app-id: The ID of the app.
  • --device-id: The ID of the device.

doctor

Print various information about the Capawesome CLI and your environment. This is useful for debugging issues with the CLI or your environment.

npx @capawesome/cli doctor

login

Log in to Capawesome Cloud.

npx @capawesome/cli login

Options:

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

logout

Log out of Capawesome Cloud.

npx @capawesome/cli logout

manifests:generate

Generate a manifest file for a bundle.

npx @capawesome/cli manifests:generate [options]

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

organizations:create

Create a new organization in Capawesome Cloud.

npx @capawesome/cli organizations:create [options]

Options:

  • --name: The name of the organization.