Skip to content

📱 app

📱 Manage your Capgo app settings and configurations in Capgo Cloud.

Alias: a

Terminal window
npx @capgo/cli@latest app add

➕ Add a new app to Capgo Cloud with a unique app ID in the format com.test.app. All options can be guessed from config if not provided.

Example:

Terminal window
npx @capgo/cli@latest app add com.example.app --name "My App" --icon ./icon.png

Options:

ParamTypeDescription
-n,stringApp name for display in Capgo Cloud
-i,stringApp icon path for display in Capgo Cloud
-a,stringAPI key to link to your account
—supa-hoststringCustom Supabase host URL (for self-hosting or Capgo development)
—supa-anonstringCustom Supabase anon key (for self-hosting)
Terminal window
npx @capgo/cli@latest app delete

🗑️ Delete an app from Capgo Cloud, optionally specifying a version to delete only that bundle.

Example:

Terminal window
npx @capgo/cli@latest app delete com.example.app

Options:

ParamTypeDescription
-a,stringAPI key to link to your account
—supa-hoststringCustom Supabase host URL (for self-hosting or Capgo development)
—supa-anonstringCustom Supabase anon key (for self-hosting)

Alias: l

Terminal window
npx @capgo/cli@latest app list

📋 List all apps registered under your account in Capgo Cloud.

Example:

Terminal window
npx @capgo/cli@latest app list

Options:

ParamTypeDescription
-a,stringAPI key to link to your account
—supa-hoststringCustom Supabase host URL (for self-hosting or Capgo development)
—supa-anonstringCustom Supabase anon key (for self-hosting)
Terminal window
npx @capgo/cli@latest app debug

🐞 Listen for live update events in Capgo Cloud to debug your app. Optionally target a specific device for detailed diagnostics.

Example:

Terminal window
npx @capgo/cli@latest app debug com.example.app --device DEVICE_ID

Options:

ParamTypeDescription
-a,stringAPI key to link to your account
-d,stringThe specific device ID to debug
—supa-hoststringCustom Supabase host URL (for self-hosting or Capgo development)
—supa-anonstringCustom Supabase anon key (for self-hosting)
Terminal window
npx @capgo/cli@latest app setting

⚙️ Modify Capacitor configuration programmatically. Specify setting path (e.g., plugins.CapacitorUpdater.defaultChannel) with —string or —bool.

Example:

Terminal window
npx @capgo/cli@latest app setting plugins.CapacitorUpdater.defaultChannel --string "Production"

Options:

ParamTypeDescription
—boolstringA value for the setting to modify as a boolean, ex: —bool true
—stringstringA value for the setting to modify as a string, ex: —string “Production”

Alias: s

Terminal window
npx @capgo/cli@latest app set

⚙️ Update settings for an existing app in Capgo Cloud, such as name, icon, or retention period for bundles. Retention of 0 means infinite storage.

Example:

Terminal window
npx @capgo/cli@latest app set com.example.app --name "Updated App" --retention 30

Options:

ParamTypeDescription
-n,stringApp name for display in Capgo Cloud
-i,stringApp icon path for display in Capgo Cloud
-a,stringAPI key to link to your account
-r,stringDays to keep old bundles (0 = infinite, default: 0)
—expose-metadatastringExpose bundle metadata (link and comment) to the plugin (true/false, default: false)
—supa-hoststringCustom Supabase host URL (for self-hosting or Capgo development)
—supa-anonstringCustom Supabase anon key (for self-hosting)

If you are using app to plan dashboard and API operations, connect it with API Overview for the implementation detail in API Overview, Introduction for the implementation detail in Introduction, API Keys for the implementation detail in API Keys, Devices for the implementation detail in Devices, and Bundles for the implementation detail in Bundles.