@capgo/cli v7.7.1

Capgo CLI

A CLI to upload and download files from the Capgo Cloud.

You can find the most up to date version of this doc in our web doc: https://capgo.app/docs/cli/overview/

Usage

Before use the CLI, you should register here : https://capgo.app/

Then go to your account in apikey section and click in the all key to copy it.

Follow the documentation here : "https://capacitorjs.com/docs/getting-started/

📑 Capgo CLI Commands

📋 Table of Contents

• 🚀 Init
• 👨‍⚕️ Doctor
• 🔑 Login
• 📦 Bundle
  • Upload
  • Compatibility
  • Delete
  • List
  • Cleanup
  • Encrypt
  • Decrypt
  • Zip
• 📱 App
  • Add
  • Delete
  • List
  • Debug
  • Setting
  • Set
• 📢 Channel
  • Add
  • Delete
  • List
  • CurrentBundle
  • Set
• 🔐 Key
  • Save
  • Create
  • Delete_old
• 👤 Account
  • Id

🚀 Init

Alias: i

npx @capgo/cli@latest init

🚀 Initialize a new app in Capgo Cloud with step-by-step guidance. This includes adding code for updates, building, uploading your app, and verifying update functionality.

Example:

npx @capgo/cli@latest init YOUR_API_KEY com.example.app

Options

👨‍⚕️ Doctor

npx @capgo/cli@latest doctor

👨‍⚕️ Check if your Capgo app installation is up-to-date and gather information useful for bug reports. This command helps diagnose issues with your setup.

Example:

npx @capgo/cli@latest doctor

Options

🔑 Login

Alias: l

npx @capgo/cli@latest login

🔑 Save your Capgo API key to your machine or local folder for easier access to Capgo Cloud services. Use --apikey=**** in any command to override it.

Example:

npx @capgo/cli@latest login YOUR_API_KEY

Options

📦 Bundle

📦 Manage app bundles for deployment in Capgo Cloud, including upload, compatibility checks, and encryption.

⬆️ Upload

Alias: u

npx @capgo/cli@latest bundle upload

⬆️ Upload a new app bundle to Capgo Cloud for distribution, optionally linking to a channel or external URL. External option supports privacy concerns or large apps (>200MB) by storing only the link. Capgo never inspects external content. Encryption adds a trustless security layer. Version must be > 0.0.0 and unique.

ℹ️ External option helps with corporate privacy concerns and apps larger than 200MB by storing only the link.

ℹ️ Capgo Cloud never looks at the content in the link for external options or in the code when stored.

ℹ️ You can add a second layer of security with encryption, making Capgo trustless.

ℹ️ Version should be greater than "0.0.0" and cannot be overridden or reused after deletion for security reasons.

Example:

npx @capgo/cli@latest bundle upload com.example.app --path ./dist --channel production

Options:

🧪 Compatibility

npx @capgo/cli@latest bundle compatibility

🧪 Check compatibility of a bundle with a specific channel in Capgo Cloud to ensure updates are safe.

Example:

npx @capgo/cli@latest bundle compatibility com.example.app --channel production

Options:

🗑️ Delete

Alias: d

npx @capgo/cli@latest bundle delete

🗑️ Delete a specific bundle from Capgo Cloud, optionally targeting a single version.

Example:

npx @capgo/cli@latest bundle delete BUNDLE_ID com.example.app

Options:

📋 List

Alias: l

npx @capgo/cli@latest bundle list

📋 List all bundles uploaded for an app in Capgo Cloud.

Example:

npx @capgo/cli@latest bundle list com.example.app

Options:

🧹 Cleanup

Alias: c

npx @capgo/cli@latest bundle cleanup

🧹 Cleanup old bundles in Capgo Cloud, keeping a specified number of recent versions or those linked to channels. Ignores bundles in use.

Example:

npx @capgo/cli@latest bundle cleanup com.example.app --bundle=1.0 --keep=3

Options:

🔒 Encrypt

npx @capgo/cli@latest bundle encrypt

🔒 Encrypt a zip bundle using the new encryption method for secure external storage or testing. Used with external sources or for testing, prints ivSessionKey for upload or decryption.

Example:

npx @capgo/cli@latest bundle encrypt ./myapp.zip CHECKSUM

Options:

🔓 Decrypt

npx @capgo/cli@latest bundle decrypt

🔓 Decrypt a zip bundle using the new encryption method, mainly for testing purposes. Prints the base64 decrypted session key for verification.

Example:

npx @capgo/cli@latest bundle decrypt ./myapp_encrypted.zip CHECKSUM

Options:

🔹 Zip

npx @capgo/cli@latest bundle zip

🗜️ Create a zip file of your app bundle for upload or local storage. Useful for preparing bundles before encryption or upload.

Example:

npx @capgo/cli@latest bundle zip com.example.app --path ./dist

Options:

📱 App

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

➕ Add

Alias: a

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:

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

Options:

🗑️ Delete

npx @capgo/cli@latest app delete

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

Example:

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

Options:

📋 List

Alias: l

npx @capgo/cli@latest app list

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

Example:

npx @capgo/cli@latest app list

Options:

🐞 Debug

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:

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

Options:

⚙️ Setting

npx @capgo/cli@latest app setting

⚙️ Modify Capacitor configuration programmatically by specifying the path to the setting. (e.g., plugins.CapacitorUpdater.defaultChannel). You MUST provide either --string or --bool.

Example:

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

Options:

⚙️ Set

Alias: s

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:

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

Options:

📢 Channel

📢 Manage distribution channels for app updates in Capgo Cloud, controlling how updates are delivered to devices.

➕ Add

Alias: a

npx @capgo/cli@latest channel add

➕ Create a new channel for app distribution in Capgo Cloud to manage update delivery.

Example:

npx @capgo/cli@latest channel add production com.example.app --default

Options:

🗑️ Delete

Alias: d

npx @capgo/cli@latest channel delete

🗑️ Delete a channel from Capgo Cloud, optionally removing associated bundles to free up resources.

Example:

npx @capgo/cli@latest channel delete production com.example.app

Options:

📋 List

Alias: l

npx @capgo/cli@latest channel list

📋 List all channels configured for an app in Capgo Cloud to review distribution settings.

Example:

npx @capgo/cli@latest channel list com.example.app

Options:

📦 CurrentBundle

npx @capgo/cli@latest channel currentBundle

📦 Get the current bundle linked to a specific channel in Capgo Cloud for update tracking.

Example:

npx @capgo/cli@latest channel currentBundle production com.example.app

Options:

⚙️ Set

Alias: s

npx @capgo/cli@latest channel set

⚙️ Configure settings for a channel, such as linking a bundle, setting update strategies (major, minor, metadata, patch, none), or device targeting (iOS, Android, dev, emulator). One channel must be default.

Example:

npx @capgo/cli@latest channel set production com.example.app --bundle 1.0.0 --state default

Options:

🔐 Key

🔐 Manage encryption keys for secure bundle distribution in Capgo Cloud, supporting end-to-end encryption with RSA and AES combination.

🔹 Save

npx @capgo/cli@latest key save

💾 Save a base64 encryption key in the Capacitor config, useful for CI environments. Recommended not to commit the key for security.

Example:

npx @capgo/cli@latest key save --key ./path/to/key

Options:

🔨 Create

npx @capgo/cli@latest key create

🔨 Create a new encryption key pair for end-to-end encryption in Capgo Cloud. Do not commit or share the private key; save it securely.

Example:

npx @capgo/cli@latest key create

Options:

🗑️ Delete_old

npx @capgo/cli@latest key delete_old

🧹 Delete the old encryption key from the Capacitor config to ensure only the current key is used.

Example:

npx @capgo/cli@latest key delete_old

👤 Account

👤 Manage your Capgo account details and retrieve information for support or collaboration.

🔹 Id

npx @capgo/cli@latest account id

🪪 Retrieve your account ID, safe to share for collaboration or support purposes in Discord or other platforms.

Example:

npx @capgo/cli@latest account id

Options: