--- description: Reference for every Capawesome Cloud CLI command — apps, builds, certificates, channels, deployments, devices, environments, live updates, and organizations. title: CLI Command Reference - Capawesome image: https://capawesome.io/docs/assets/images/social/cloud/cli/commands.png --- [ Skip to content](#command-reference) [ 🔐 Introducing the **Capacitor Vault** plugin — store secrets behind biometrics or a device passcode.](/blog/announcing-the-capacitor-vault-plugin/) * [ SDKs ](/docs/sdks/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm or Yarn ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * [ Examples ](/docs/cloud/cli/examples/) * [ Scripting ](/docs/cloud/cli/scripting/) * APIs and SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories # Command Reference[¶](#command-reference "Permanent link") Reference for every Capawesome Cloud CLI command. For installation, authentication, and general usage, see the [CLI overview](/docs/cloud/cli/), [Installation](/docs/cloud/cli/installation/), [Authentication](/docs/cloud/cli/authentication/), and [Usage](/docs/cloud/cli/usage/). * [apps:create](#appscreate) * [apps:delete](#appsdelete) * [apps:get](#appsget) * [apps:link](#appslink) * [apps:list](#appslist) * [apps:transfer](#appstransfer) * [apps:unlink](#appsunlink) * [apps:builds:cancel](#appsbuildscancel) * [apps:builds:create](#appsbuildscreate) * [apps:builds:download](#appsbuildsdownload) * [apps:builds:failure-summary](#appsbuildsfailure-summary) * [apps:builds:get](#appsbuildsget) * [apps:builds:list](#appsbuildslist) * [apps:builds:logs](#appsbuildslogs) * [apps:certificates:create](#appscertificatescreate) * [apps:certificates:delete](#appscertificatesdelete) * [apps:certificates:get](#appscertificatesget) * [apps:certificates:list](#appscertificateslist) * [apps:certificates:update](#appscertificatesupdate) * [apps:channels:create](#appschannelscreate) * [apps:channels:delete](#appschannelsdelete) * [apps:channels:get](#appschannelsget) * [apps:channels:list](#appschannelslist) * [apps:channels:pause](#appschannelspause) * [apps:channels:resume](#appschannelsresume) * [apps:channels:update](#appschannelsupdate) * [apps:deployments:cancel](#appsdeploymentscancel) * [apps:deployments:create](#appsdeploymentscreate) * [apps:deployments:failure-summary](#appsdeploymentsfailure-summary) * [apps:deployments:get](#appsdeploymentsget) * [apps:deployments:list](#appsdeploymentslist) * [apps:deployments:logs](#appsdeploymentslogs) * [apps:destinations:create](#appsdestinationscreate) * [apps:destinations:delete](#appsdestinationsdelete) * [apps:destinations:get](#appsdestinationsget) * [apps:destinations:list](#appsdestinationslist) * [apps:destinations:update](#appsdestinationsupdate) * [apps:devices:delete](#appsdevicesdelete) * [apps:devices:forcechannel](#appsdevicesforcechannel) * [apps:devices:probe](#appsdevicesprobe) * [apps:devices:unforcechannel](#appsdevicesunforcechannel) * [apps:environments:create](#appsenvironmentscreate) * [apps:environments:delete](#appsenvironmentsdelete) * [apps:environments:get](#appsenvironmentsget) * [apps:environments:list](#appsenvironmentslist) * [apps:environments:set](#appsenvironmentsset) * [apps:environments:unset](#appsenvironmentsunset) * [apps:liveupdates:bundle](#appsliveupdatesbundle) * [apps:liveupdates:create](#appsliveupdatescreate) * [apps:liveupdates:generatemanifest](#appsliveupdatesgeneratemanifest) * [apps:liveupdates:generatesigningkey](#appsliveupdatesgeneratesigningkey) * [apps:liveupdates:rollback](#appsliveupdatesrollback) * [apps:liveupdates:rollout](#appsliveupdatesrollout) * [apps:liveupdates:upload](#appsliveupdatesupload) * [apps:liveupdates:register](#appsliveupdatesregister) * [apps:liveupdates:setnativeversions](#appsliveupdatessetnativeversions) * [doctor](#doctor) * [login](#login) * [logout](#logout) * [whoami](#whoami) * [organizations:create](#organizationscreate) * [organizations:get](#organizationsget) * [organizations:list](#organizationslist) ### `apps:create`[¶](#appscreate "Permanent link") Create a new app in Capawesome Cloud. `[](#%5F%5Fcodelineno-0-1)npx @capawesome/cli apps:create [options] ` **Options:** * `--json`: Output in JSON format. * `--link`: Connect the created app to the local git repository. * `--name`: The name of the app. * `--organization-id`: The ID of the organization to create the app in. * `--type`: The type of the app. Must be `android`, `capacitor`, `cordova`, or `ios`. Defaults to `capacitor`. * `--yes, -y`: Skip all confirmation prompts. ### `apps:delete`[¶](#appsdelete "Permanent link") Delete an app from Capawesome Cloud. `[](#%5F%5Fcodelineno-1-1)npx @capawesome/cli apps:delete [options] ` **Options:** * `--app-id`: The ID of the app. * `--yes, -y`: Skip confirmation prompt. ### `apps:get`[¶](#appsget "Permanent link") Get an existing app from Capawesome Cloud. `[](#%5F%5Fcodelineno-2-1)npx @capawesome/cli apps:get [options] ` **Options:** * `--app-id`: The ID of the app. * `--json`: Output in JSON format. ### `apps:list`[¶](#appslist "Permanent link") List all apps in an organization. `[](#%5F%5Fcodelineno-3-1)npx @capawesome/cli apps:list [options] ` **Options:** * `--json`: Output in JSON format. * `--limit`: The maximum number of apps to return. * `--offset`: The offset to start returning apps from. * `--organization-id`: The ID of the organization. ### `apps:transfer`[¶](#appstransfer "Permanent link") Transfer an app to another organization. `[](#%5F%5Fcodelineno-4-1)npx @capawesome/cli apps:transfer [options] ` **Options:** * `--app-id`: The ID of the app. * `--organization-id`: The ID of the target organization. * `--yes, -y`: Skip confirmation prompt. ### `apps:link`[¶](#appslink "Permanent link") Connect a git repository to an app. The repository information (provider, owner, and repository name) is automatically detected from the local git remote (`origin`). `[](#%5F%5Fcodelineno-5-1)npx @capawesome/cli apps:link [options] ` **Options:** * `--app-id`: The ID of the app. ### `apps:unlink`[¶](#appsunlink "Permanent link") Disconnect a git repository from an app. `[](#%5F%5Fcodelineno-6-1)npx @capawesome/cli apps:unlink [options] ` **Options:** * `--app-id`: The ID of the app. * `--yes, -y`: Skip confirmation prompt. ### `apps:builds:cancel`[¶](#appsbuildscancel "Permanent link") Cancel an app build. `[](#%5F%5Fcodelineno-7-1)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`[¶](#appsbuildscreate "Permanent link") Create a new app build. `[](#%5F%5Fcodelineno-8-1)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. * `--channel`: The name of the channel to deploy to (Web only). * `--destination`: The name of the destination to deploy to (Android/iOS only). * `--detached`: Exit immediately after creating the build without waiting for completion. * `--environment`: The name of the environment to use for the build. * `--failure-summary`: Request an AI-powered failure summary (Capawesome Cloud Assist) if the build fails. Cannot be used together with `--detached`. * `--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. * `--path`: Path to local source files to upload. Cannot be used together with `--git-ref`. * `--platform`: The platform for the build. Supported values are `android`, `ios`, and `web`. * `--stack`: The name of the stack to use for the build. Must be either `macos-sequoia` or `macos-tahoe`. * `--type`: The type of build. For Android, supported values are `debug` and `release`. For iOS, supported values are `simulator`, `development`, `ad-hoc`, `app-store`, and `enterprise`. For Web, no type is required. * `--url`: URL to a zip file to use as build source. Cannot be used together with `--git-ref` or `--path`. * `--variable`: Ad hoc environment variable in `key=value` format. Can be specified multiple times. * `--variable-file`: Path to a file containing ad hoc environment variables in `.env` format. * `--yes, -y`: Skip confirmation prompts. * `--zip`: Download the generated zip file (Web only). Optionally provide a file path. ### `apps:builds:download`[¶](#appsbuildsdownload "Permanent link") Download the build artifacts for an app build. `[](#%5F%5Fcodelineno-9-1)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. - `--zip`: Download the generated zip file (Web only). Optionally provide a file path. ### `apps:builds:failure-summary`[¶](#appsbuildsfailure-summary "Permanent link") Explain why an app build failed using Capawesome Cloud Assist (AI). `[](#%5F%5Fcodelineno-10-1)npx @capawesome/cli apps:builds:failure-summary [options] ` **Options:** * `--app-id`: The ID of the app the build belongs to. * `--build-id`: The ID of the build to summarize. Alternative to `--build-number`. * `--build-number`: The build number to summarize (e.g., "1", "42"). Alternative to `--build-id`. ### `apps:builds:get`[¶](#appsbuildsget "Permanent link") Get an existing app build. When `--json` is set, the response also includes the related job (status, logs, timing) so failed builds can be debugged programmatically. `[](#%5F%5Fcodelineno-11-1)npx @capawesome/cli apps:builds:get [options] ` **Options:** * `--app-id`: The ID of the app the build belongs to. * `--build-id`: The ID of the build. * `--json`: Output in JSON format. Includes the related job. ### `apps:builds:list`[¶](#appsbuildslist "Permanent link") List all builds for an app. When `--json` is set, each build also includes the related job (status, logs, timing) so failed builds can be debugged programmatically. `[](#%5F%5Fcodelineno-12-1)npx @capawesome/cli apps:builds:list [options] ` **Options:** * `--app-id`: The ID of the app. * `--json`: Output in JSON format. Includes the related job for each build. * `--limit`: The maximum number of builds to return. * `--number-as-string`: Filter by build number. * `--offset`: The offset to start returning builds from. * `--platform`: Filter by platform. Supported values are `android`, `ios`, and `web`. ### `apps:builds:logs`[¶](#appsbuildslogs "Permanent link") Display the logs for a ongoing or completed app build. `[](#%5F%5Fcodelineno-13-1)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:certificates:create`[¶](#appscertificatescreate "Permanent link") Create a new certificate for an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-14-1)npx @capawesome/cli apps:certificates:create [options] ` **Options:** * `--app-id`: The ID of the app. * `--file`: Path to the certificate file. * `--json`: Output in JSON format. * `--key-alias`: Key alias for the certificate. * `--key-password`: Key password for the certificate. * `--name`: The name of the certificate. * `--password`: Password for the certificate. * `--platform`: The platform of the certificate. Supported values are `android`, `ios`, and `web`. * `--provisioning-profile`: Paths to provisioning profile files to upload and link. Can be specified multiple times. * `--type`: The type of the certificate. Supported values are `development` and `production`. * `--yes, -y`: Skip optional prompts. ### `apps:certificates:delete`[¶](#appscertificatesdelete "Permanent link") Delete a certificate from an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-15-1)npx @capawesome/cli apps:certificates:delete [options] ` **Options:** * `--app-id`: The ID of the app. * `--certificate-id`: The ID of the certificate. * `--name`: The name of the certificate. * `--platform`: The platform of the certificate (`android`, `ios`, `web`). * `--type`: The type of the certificate. Supported values are `development` and `production`. * `--yes, -y`: Skip confirmation prompt. ### `apps:certificates:get`[¶](#appscertificatesget "Permanent link") Get a certificate from an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-16-1)npx @capawesome/cli apps:certificates:get [options] ` **Options:** * `--app-id`: The ID of the app. * `--certificate-id`: The ID of the certificate. * `--json`: Output in JSON format. * `--name`: The name of the certificate. * `--platform`: The platform of the certificate (`android`, `ios`, `web`). * `--type`: The type of the certificate. Supported values are `development` and `production`. ### `apps:certificates:list`[¶](#appscertificateslist "Permanent link") List all certificates for an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-17-1)npx @capawesome/cli apps:certificates:list [options] ` **Options:** * `--app-id`: The ID of the app. * `--json`: Output in JSON format. * `--limit`: The maximum number of certificates to return. * `--offset`: The offset to start returning certificates from. * `--platform`: Filter by platform. Supported values are `android`, `ios`, and `web`. * `--type`: Filter by type. Supported values are `development` and `production`. ### `apps:certificates:update`[¶](#appscertificatesupdate "Permanent link") Update an existing certificate from an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-18-1)npx @capawesome/cli apps:certificates:update [options] ` **Options:** * `--app-id`: The ID of the app. * `--certificate-id`: The ID of the certificate. * `--key-alias`: Key alias for the certificate. * `--key-password`: Key password for the certificate. * `--name`: The name of the certificate. * `--password`: Password for the certificate. * `--type`: The type of the certificate. Supported values are `development` and `production`. ### `apps:channels:create`[¶](#appschannelscreate "Permanent link") Create a new channel for an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-19-1)npx @capawesome/cli apps:channels:create [options] ` **Options:** * `--app-id`: The ID of the app. * `--ignore-errors`: Ignore errors when creating the channel. This is useful for CI/CD pipelines where the channel may already exist. Defaults to `false`. * `--json`: Output in JSON format. * `--name`: The name of the channel. * `--protected`: Whether to protect the channel or not. Defaults to `false`. ### `apps:channels:delete`[¶](#appschannelsdelete "Permanent link") Delete a channel from an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-20-1)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. * `--yes, -y`: Skip confirmation prompt. ### `apps:channels:get`[¶](#appschannelsget "Permanent link") Get a channel from an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-21-1)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`[¶](#appschannelslist "Permanent link") List all channels for an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-22-1)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:pause`[¶](#appschannelspause "Permanent link") Pause an app channel. `[](#%5F%5Fcodelineno-23-1)npx @capawesome/cli apps:channels:pause [options] ` **Options:** * `--app-id`: The ID of the app. * `--channel`: The name of the channel to pause. ### `apps:channels:resume`[¶](#appschannelsresume "Permanent link") Resume an app channel. `[](#%5F%5Fcodelineno-24-1)npx @capawesome/cli apps:channels:resume [options] ` **Options:** * `--app-id`: The ID of the app. * `--channel`: The name of the channel to resume. ### `apps:channels:update`[¶](#appschannelsupdate "Permanent link") Update an existing channel from an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-25-1)npx @capawesome/cli apps:channels:update [options] ` **Options:** * `--app-id`: The ID of the app. * `--channel-id`: The ID of the channel. * `--name`: The name of the channel. * `--protected`: Whether to protect the channel or not. ### `apps:deployments:cancel`[¶](#appsdeploymentscancel "Permanent link") Cancel an ongoing app deployment. `[](#%5F%5Fcodelineno-26-1)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`[¶](#appsdeploymentscreate "Permanent link") Create a new app deployment. `[](#%5F%5Fcodelineno-27-1)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. Alternative to `--build-number`. * `--build-number`: The build number to deploy (e.g., "1", "42"). Alternative to `--build-id`. * `--channel`: The name of the channel to deploy the build to (Web only). * `--destination`: The name of the destination to deploy to (Android/iOS only). * `--detached`: Exit immediately after creating the deployment without waiting for completion. * `--failure-summary`: Request an AI-powered failure summary (Capawesome Cloud Assist) if the deployment fails. * `--json`: Output in JSON format. ### `apps:deployments:failure-summary`[¶](#appsdeploymentsfailure-summary "Permanent link") Explain why an app deployment failed using Capawesome Cloud Assist (AI). `[](#%5F%5Fcodelineno-28-1)npx @capawesome/cli apps:deployments:failure-summary [options] ` **Options:** * `--app-id`: The ID of the app the deployment belongs to. * `--deployment-id`: The ID of the deployment to summarize. ### `apps:deployments:get`[¶](#appsdeploymentsget "Permanent link") Get an existing app deployment. When `--json` is set, the response also includes the related job (status, logs, timing) so failed deployments can be debugged programmatically. `[](#%5F%5Fcodelineno-29-1)npx @capawesome/cli apps:deployments:get [options] ` **Options:** * `--app-id`: The ID of the app the deployment belongs to. * `--deployment-id`: The ID of the deployment. * `--json`: Output in JSON format. Includes the related job. ### `apps:deployments:list`[¶](#appsdeploymentslist "Permanent link") List all deployments for an app. When `--json` is set, each deployment also includes the related job (status, logs, timing) so failed deployments can be debugged programmatically. `[](#%5F%5Fcodelineno-30-1)npx @capawesome/cli apps:deployments:list [options] ` **Options:** * `--app-id`: The ID of the app. * `--build-id`: Filter by build ID. * `--channel-id`: Filter by channel ID. * `--destination-id`: Filter by destination ID. * `--json`: Output in JSON format. Includes the related job for each deployment. * `--limit`: The maximum number of deployments to return. * `--offset`: The offset to start returning deployments from. ### `apps:deployments:logs`[¶](#appsdeploymentslogs "Permanent link") Display the logs for a ongoing or completed app deployment. `[](#%5F%5Fcodelineno-31-1)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:destinations:create`[¶](#appsdestinationscreate "Permanent link") Create a new destination for an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-32-1)npx @capawesome/cli apps:destinations:create [options] ` **Options:** * `--app-id`: The ID of the app. * `--json`: Output in JSON format. * `--name`: The name of the destination. * `--platform`: The platform of the destination. Supported values are `android` and `ios`. * `--android-build-artifact-type`: Android build artifact type. Supported values are `aab` and `apk`. * `--android-package-name`: Android package name. * `--android-release-status`: Android release status. Supported values are `completed` and `draft`. * `--google-play-track`: Google Play track. * `--google-service-account-key-file`: Path to the Google service account key JSON file. * `--apple-api-key-file`: Path to the Apple API key (.p8) file. * `--apple-app-id`: Apple App ID. * `--apple-app-password`: Apple app-specific password. * `--apple-id`: Apple ID. * `--apple-issuer-id`: Apple Issuer ID. * `--apple-team-id`: Apple Team ID. ### `apps:destinations:delete`[¶](#appsdestinationsdelete "Permanent link") Delete a destination from an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-33-1)npx @capawesome/cli apps:destinations:delete [options] ` **Options:** * `--app-id`: The ID of the app. * `--destination-id`: The ID of the destination. * `--name`: The name of the destination. * `--platform`: The platform of the destination (`android`, `ios`). * `--yes, -y`: Skip confirmation prompt. ### `apps:destinations:get`[¶](#appsdestinationsget "Permanent link") Get a destination from an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-34-1)npx @capawesome/cli apps:destinations:get [options] ` **Options:** * `--app-id`: The ID of the app. * `--destination-id`: The ID of the destination. * `--json`: Output in JSON format. * `--name`: The name of the destination. * `--platform`: The platform of the destination (`android`, `ios`). ### `apps:destinations:list`[¶](#appsdestinationslist "Permanent link") List all destinations for an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-35-1)npx @capawesome/cli apps:destinations:list [options] ` **Options:** * `--app-id`: The ID of the app. * `--json`: Output in JSON format. * `--limit`: The maximum number of destinations to return. * `--offset`: The offset to start returning destinations from. * `--platform`: Filter by platform. Supported values are `android` and `ios`. ### `apps:destinations:update`[¶](#appsdestinationsupdate "Permanent link") Update an existing destination from an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-36-1)npx @capawesome/cli apps:destinations:update [options] ` **Options:** * `--app-id`: The ID of the app. * `--destination-id`: The ID of the destination. * `--name`: The name of the destination. * `--android-build-artifact-type`: Android build artifact type. Supported values are `aab` and `apk`. * `--android-package-name`: Android package name. * `--android-release-status`: Android release status. Supported values are `completed` and `draft`. * `--app-google-service-account-key-id`: App Google Service Account Key ID. * `--google-play-track`: Google Play track. * `--apple-api-key-id`: Apple API Key ID. * `--apple-app-id`: Apple App ID. * `--apple-app-password`: Apple app-specific password. * `--apple-id`: Apple ID. * `--apple-issuer-id`: Apple Issuer ID. * `--apple-team-id`: Apple Team ID. * `--app-apple-api-key-id`: App Apple API Key ID. ### `apps:devices:delete`[¶](#appsdevicesdelete "Permanent link") Delete a device from an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-37-1)npx @capawesome/cli apps:devices:delete [options] ` **Options:** * `--app-id`: The ID of the app. * `--device-id`: The ID of the device. * `--yes, -y`: Skip confirmation prompt. ### `apps:devices:forcechannel`[¶](#appsdevicesforcechannel "Permanent link") Force a device to use a specific channel. `[](#%5F%5Fcodelineno-38-1)npx @capawesome/cli apps:devices:forcechannel [options] ` **Options:** * `--app-id`: The ID of the app. * `--device-id`: The ID of the device. Can be specified multiple times. * `--channel`: The name of the channel to force. ### `apps:devices:probe`[¶](#appsdevicesprobe "Permanent link") Check whether a device would receive a live update. This is useful for debugging and testing purposes, especially when setting up new devices or troubleshooting existing ones. `[](#%5F%5Fcodelineno-39-1)npx @capawesome/cli apps:devices:probe [options] ` **Options:** * `--app-id`: The ID of the app. * `--device-id`: The ID of the device. * `--json`: Output in JSON format. ### `apps:devices:unforcechannel`[¶](#appsdevicesunforcechannel "Permanent link") Remove the forced channel from a device. `[](#%5F%5Fcodelineno-40-1)npx @capawesome/cli apps:devices:unforcechannel [options] ` **Options:** * `--app-id`: The ID of the app. * `--device-id`: The ID of the device. Can be specified multiple times. ### `apps:environments:create`[¶](#appsenvironmentscreate "Permanent link") Create a new environment for an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-41-1)npx @capawesome/cli apps:environments:create [options] ` **Options:** * `--app-id`: The ID of the app. * `--json`: Output in JSON format. * `--name`: The name of the environment. ### `apps:environments:delete`[¶](#appsenvironmentsdelete "Permanent link") Delete an environment from an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-42-1)npx @capawesome/cli apps:environments:delete [options] ` **Options:** * `--app-id`: The ID of the app. * `--environment-id`: The ID of the environment. Either the ID or name must be provided. * `--name`: The name of the environment. Either the ID or name must be provided. * `--yes, -y`: Skip confirmation prompt. ### `apps:environments:get`[¶](#appsenvironmentsget "Permanent link") Get an existing environment for an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-43-1)npx @capawesome/cli apps:environments:get [options] ` **Options:** * `--app-id`: The ID of the app. * `--environment-id`: The ID of the environment. Either the ID or name must be provided. * `--name`: The name of the environment. Either the ID or name must be provided. * `--json`: Output in JSON format. ### `apps:environments:list`[¶](#appsenvironmentslist "Permanent link") List all environments for an app in Capawesome Cloud. `[](#%5F%5Fcodelineno-44-1)npx @capawesome/cli apps:environments:list [options] ` **Options:** * `--app-id`: The ID of the app. * `--json`: Output in JSON format. * `--limit`: The maximum number of environments to return. * `--offset`: The offset to start returning environments from. ### `apps:environments:set`[¶](#appsenvironmentsset "Permanent link") Set environment variables and secrets for an environment in Capawesome Cloud. `[](#%5F%5Fcodelineno-45-1)npx @capawesome/cli apps:environments:set [options] ` **Options:** * `--app-id`: The ID of the app. * `--environment-id`: The ID of the environment. Either the ID or name must be provided. * `--name`: The name of the environment. Either the ID or name must be provided. * `--variable`: Environment variable in `key=value` format. Can be specified multiple times. * `--variable-file`: Path to a file containing environment variables in `.env` format. * `--secret`: Environment secret in `key=value` format. Can be specified multiple times. * `--secret-file`: Path to a file containing environment secrets in `.env` format. ### `apps:environments:unset`[¶](#appsenvironmentsunset "Permanent link") Unset environment variables and secrets for an environment in Capawesome Cloud. `[](#%5F%5Fcodelineno-46-1)npx @capawesome/cli apps:environments:unset [options] ` **Options:** * `--app-id`: The ID of the app. * `--environment-id`: The ID of the environment. Either the ID or name must be provided. * `--name`: The name of the environment. Either the ID or name must be provided. * `--variable`: Key of the environment variable to unset. Can be specified multiple times. * `--secret`: Key of the environment secret to unset. Can be specified multiple times. ### `apps:liveupdates:bundle`[¶](#appsliveupdatesbundle "Permanent link") Generate manifest file and compress web assets into a zip file. `[](#%5F%5Fcodelineno-47-1)npx @capawesome/cli apps:liveupdates:bundle [options] ` **Options:** * `--input-path`: Path to the web assets directory. * `--output-path`: Output path for the generated artifact file. Defaults to `./bundle.zip`. * `--overwrite`: Overwrite output file if it already exists. Defaults to `false`. * `--skip-manifest`: Skip manifest file generation. Defaults to `false`. ### `apps:liveupdates:create`[¶](#appsliveupdatescreate "Permanent link") Create a new live update by building and deploying web assets using Capawesome Cloud Runners. `[](#%5F%5Fcodelineno-48-1)npx @capawesome/cli apps:liveupdates:create [options] ` **Options:** * `--android-eq`: The exact Android versionCode for the live update. * `--android-max`: The maximum Android versionCode for the live update. * `--android-min`: The minimum Android versionCode for the live update. * `--app-id`: The ID of the app to create the live update for. * `--certificate`: The name of the certificate to use for the build. * `--channel`: The name of the channel to deploy to. Can be specified multiple times. * `--custom-property`: A custom property to assign to the build. Must be in the format `key=value`. Can be specified multiple times. * `--environment`: The name of the environment to use for the build. * `--git-ref`: The Git reference (branch, tag, or commit SHA) to build. * `--ios-eq`: The exact iOS CFBundleVersion for the live update. * `--ios-max`: The maximum iOS CFBundleVersion for the live update. * `--ios-min`: The minimum iOS CFBundleVersion for the live update. * `--json`: Output in JSON format. * `--path`: Path to local source files to upload. Cannot be used together with `--git-ref` or `--url`. * `--rollout-percentage`: The rollout percentage for the deployment (0-100). Defaults to `100`. * `--stack`: The build stack to use for the build process. Must be either `macos-sequoia` or `macos-tahoe`. * `--url`: URL to a zip file to use as build source. Cannot be used together with `--git-ref` or `--path`. * `--variable`: Ad hoc environment variable in `key=value` format. Can be specified multiple times. * `--variable-file`: Path to a file containing ad hoc environment variables in `.env` format. * `--yes, -y`: Skip confirmation prompts. ### `apps:liveupdates:generatemanifest`[¶](#appsliveupdatesgeneratemanifest "Permanent link") Generate a manifest file. `[](#%5F%5Fcodelineno-49-1)npx @capawesome/cli apps:liveupdates:generatemanifest [options] ` **Options:** * `--path`: Path to the web assets folder (e.g. `www` or `dist`). ### `apps:liveupdates:generatesigningkey`[¶](#appsliveupdatesgeneratesigningkey "Permanent link") Generate a new code signing key pair for Live Updates. This command creates an RSA key pair that can be used to sign and verify Live Updates bundles. `[](#%5F%5Fcodelineno-50-1)npx @capawesome/cli apps:liveupdates:generatesigningkey [options] ` **Options:** * `--app-type`: The app type to configure code signing for. Either `capacitor` or `cordova`. * `--key-size`: The RSA key size in bits. Must be `2048`, `3072`, or `4096`. Defaults to `2048`. * `--public-key-path`: Path where the public key should be saved. Defaults to `public.pem`. * `--private-key-path`: Path where the private key should be saved. Defaults to `private.pem`. ### `apps:liveupdates:rollback`[¶](#appsliveupdatesrollback "Permanent link") Rollback the active build in a channel to a previous deployment. `[](#%5F%5Fcodelineno-51-1)npx @capawesome/cli apps:liveupdates:rollback [options] ` **Options:** * `--app-id`: The ID of the app. * `--channel`: The name of the channel to rollback. * `--steps`: The number of deployments to go back (1-5). ### `apps:liveupdates:rollout`[¶](#appsliveupdatesrollout "Permanent link") Update the rollout percentage of the active build in a channel. `[](#%5F%5Fcodelineno-52-1)npx @capawesome/cli apps:liveupdates:rollout [options] ` **Options:** * `--app-id`: The ID of the app. * `--channel`: The name of the channel to update rollout for. * `--percentage`: The rollout percentage (0-100). ### `apps:liveupdates:upload`[¶](#appsliveupdatesupload "Permanent link") Upload a locally built bundle and deploy it to a channel. `[](#%5F%5Fcodelineno-53-1)npx @capawesome/cli apps:liveupdates:upload [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. Deprecated, use `--git-ref` instead. * `--commit-ref`: The commit ref of the Git commit that the bundle is linked to. Deprecated, use `--git-ref` instead. * `--commit-sha`: The commit SHA of the Git commit that the bundle is linked to. Deprecated, use `--git-ref` instead. * `--custom-property`: A custom property to assign to the bundle. Must be in the format `key=value`. Can be specified multiple times. * `--git-ref`: The Git reference (branch, tag, or commit SHA) to associate with the bundle. * `--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. * `--json`: Output in JSON format. * `--path`: The path to the bundle to upload. Must be a folder or zip archive. * `--private-key`: The private key to sign the bundle with. Can be a file path to a .pem file or the private key content as plain text. * `--rollout-percentage`: The percentage of devices to deploy the bundle to. Must be an integer between 0 and 100. * `--yes, -y`: Skip confirmation prompts. ### `apps:liveupdates:register`[¶](#appsliveupdatesregister "Permanent link") Register a self-hosted bundle URL and deploy it to a channel. `[](#%5F%5Fcodelineno-54-1)npx @capawesome/cli apps:liveupdates:register [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. * `--channel`: The channel to deploy the bundle to. * `--commit-message`: The commit message of the Git commit that the bundle is linked to. Deprecated, use `--git-ref` instead. * `--commit-ref`: The commit ref of the Git commit that the bundle is linked to. Deprecated, use `--git-ref` instead. * `--commit-sha`: The commit SHA of the Git commit that the bundle is linked to. Deprecated, use `--git-ref` instead. * `--custom-property`: A custom property to assign to the bundle. Must be in the format `key=value`. Can be specified multiple times. * `--git-ref`: The Git reference (branch, tag, or commit SHA) to associate with the bundle. * `--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. * `--json`: Output in JSON format. * `--path`: Path to zip file for code signing only. * `--private-key`: The private key to sign the bundle with. Can be a file path to a .pem file or the private key content as plain text. * `--rollout-percentage`: The percentage of devices to deploy the bundle to. Must be an integer between 0 and 100. * `--url`: The URL to the self-hosted bundle file. The URL must start with `https://`. * `--yes, -y`: Skip confirmation prompts. ### `apps:liveupdates:setnativeversions`[¶](#appsliveupdatessetnativeversions "Permanent link") Set native version constraints on a web build. `[](#%5F%5Fcodelineno-55-1)npx @capawesome/cli apps:liveupdates:setnativeversions [options] ` **Options:** * `--app-id`: The ID of the app. * `--build-id`: The ID of the build to update. * `--android-eq`: The exact Android version code (`versionCode`) that the build supports. * `--android-max`: The maximum Android version code (`versionCode`) that the build supports. * `--android-min`: The minimum Android version code (`versionCode`) that the build supports. * `--ios-eq`: The exact iOS bundle version (`CFBundleVersion`) that the build supports. * `--ios-max`: The maximum iOS bundle version (`CFBundleVersion`) that the build supports. * `--ios-min`: The minimum iOS bundle version (`CFBundleVersion`) that the build supports. ### `doctor`[¶](#doctor "Permanent link") Print various information about the Capawesome CLI and your environment. This is useful for debugging issues with the CLI or your environment. `[](#%5F%5Fcodelineno-56-1)npx @capawesome/cli doctor ` ### `login`[¶](#login "Permanent link") Log in to Capawesome Cloud. `[](#%5F%5Fcodelineno-57-1)npx @capawesome/cli login ` **Options:** * `--token`: The token to use for authentication. ### `logout`[¶](#logout "Permanent link") Log out of Capawesome Cloud. `[](#%5F%5Fcodelineno-58-1)npx @capawesome/cli logout ` ### `whoami`[¶](#whoami "Permanent link") Show the current logged-in user. `[](#%5F%5Fcodelineno-59-1)npx @capawesome/cli whoami ` ### `organizations:create`[¶](#organizationscreate "Permanent link") Create a new organization in Capawesome Cloud. `[](#%5F%5Fcodelineno-60-1)npx @capawesome/cli organizations:create [options] ` **Options:** * `--json`: Output in JSON format. * `--name`: The name of the organization. ### `organizations:get`[¶](#organizationsget "Permanent link") Get an existing organization from Capawesome Cloud. `[](#%5F%5Fcodelineno-61-1)npx @capawesome/cli organizations:get [options] ` **Options:** * `--json`: Output in JSON format. * `--organization-id`: The ID of the organization. ### `organizations:list`[¶](#organizationslist "Permanent link") List all organizations the current user belongs to. `[](#%5F%5Fcodelineno-62-1)npx @capawesome/cli organizations:list [options] ` **Options:** * `--json`: Output in JSON format. * `--limit`: The maximum number of organizations to return. * `--offset`: The offset to start returning organizations from. June 9, 2026 Back to top