---
description: Learn how to use the Capawesome Cloud CLI — command anatomy, global flags, JSON output, exit codes, and the doctor command.
title: CLI Usage - Capawesome
image: https://capawesome.io/docs/assets/images/social/cloud/cli/usage.png
---

[ Skip to content](#usage) 

[ 🔐 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/)
* [  Command Reference ](/docs/cloud/cli/commands/)
* [  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

# Usage[¶](#usage "Permanent link")

## Command anatomy[¶](#command-anatomy "Permanent link")

Commands follow the pattern `apps:<resource>:<action>` — for example `apps:builds:create` or `apps:channels:list`. The resource is what you're acting on (builds, channels, deployments, …) and the action is what you're doing to it (create, list, get, …). Browse them all in the [Command reference](/docs/cloud/cli/commands/).

Most commands prompt for any required values you don't provide, so you can run them interactively and fill in the blanks. Pass those values as flags instead to run non-interactively — which is what you'll do in scripts and CI.

## Global flags[¶](#global-flags "Permanent link")

These flags work across commands:

| Flag      | Description                                                                         |
| --------- | ----------------------------------------------------------------------------------- |
| \--app-id | The target app ID (skips the app prompt).                                           |
| \--token  | An API token for non-interactive [authentication](/docs/cloud/cli/authentication/). |
| \--yes    | Skip confirmation prompts (for scripts and CI).                                     |
| \--json   | Output machine-readable JSON instead of human-readable text.                        |
| \--help   | Show help for any command.                                                          |

For commands that act on a specific app, pass `--app-id` to skip the interactive app picker — essential in CI, where there's nobody to answer the prompt.

## Getting help[¶](#getting-help "Permanent link")

Show the available commands, or help for a specific one:

`[](#%5F%5Fcodelineno-0-1)npx @capawesome/cli --help
[](#%5F%5Fcodelineno-0-2)npx @capawesome/cli apps:builds:create --help
`

`--help` lists every flag a command accepts, so it's the fastest way to discover options without leaving the terminal.

## JSON output[¶](#json-output "Permanent link")

Add `--json` to any command to get structured output you can parse in scripts — for example, to read a new build's ID out of `apps:builds:create --json` and use it in a later step. Note that commands which stream progress print the JSON only at the end, so parsing them needs a little care. See [Scripting](/docs/cloud/cli/scripting/) for the details and recipes.

## Exit codes[¶](#exit-codes "Permanent link")

The CLI exits with status code `0` on success and a non-zero code on failure. In a CI pipeline this means a failed command stops the job by default — no extra error handling required to fail the build when, say, an upload or submission doesn't go through. See [Scripting](/docs/cloud/cli/scripting/) for the exceptions, such as `--detached` builds.

## Doctor[¶](#doctor "Permanent link")

Diagnose your environment and authentication — Node.js version, login state, and connectivity — with:

`[](#%5F%5Fcodelineno-1-1)npx @capawesome/cli doctor
`

This is the first thing to run when a command behaves unexpectedly.

## Next steps[¶](#next-steps "Permanent link")

* [Command reference](/docs/cloud/cli/commands/) — every command and its options.
* [Examples](/docs/cloud/cli/examples/) — practical recipes for builds, Live Updates, and CI.
* [Scripting](/docs/cloud/cli/scripting/) — automate the CLI in scripts and CI.
* [Authentication](/docs/cloud/cli/authentication/) — log in or use a token.

June 9, 2026 

 Back to top