CLI
All command should be run in your app folder with capacitor project ignited. See below
npx @capgo/cli init [apikey]This method is here to onboard you step by step.
It will add your app to Capgo. It will add the code to your app to validate update. It will build your app. It will upload your app to Capgo. And it will help you to check if update works.
npx @capgo/cli login [apikey]This method is here to remember the
apikey for you.use
--apikey=******** in any command to override itOptionaly you can give:
--local This will store your apikey in the local repo and git ignore it.npx @capgo/cli doctorCommand to check if your are up to date with capgo packages.
This command will also be usefull for bug report.
npx @capgo/cli app add [appId]💡 All option will be guessed in your config if not provided.
Optionally, you can give:
--icon [/path/to/my/icon]to have a custom icon display in Capgo webapp.--name [test]to have a custom name in the list.--apikey [key]API key to link to your account.
Example of capacitor.config.json for appId and AppName, the icon is guess in the resources folder
{
"appId": "ee.forgr.capacitor_go",
"appName": "Capgo",
"webDir": "dist",
}
npx @capgo/cli app set [appId]Optionally, you can give:
--icon [/path/to/my/icon]to have a custom icon display in Capgo webapp.--name [test]to have a custom name in the list.--apikey [key]API key to link to your account.
npx @capgo/cli app list [appId]Optionally, you can give:
--apikey [key]API key to link to your account.
npx @capgo/cli app delete [appId]Optionally, you can give:
--apikey [key]API key to link to your account.--bundlewith the version number will only delete this version.
npx @capgo/cli bundle upload [appId]Optionally, you can give:
--apikey [key]API key to link to your account.--path [/path/to/my/bundle]to upload a specific folder.--channel [test]to upload to a specific channel.--external="https://mydomain.com/myapp.zip"to link to an external URL instead of upload to Capgo cloud, it should be a zip URL in HTTPS.--key [/path/to/my/private_key]the path of your private key.--key-data [privateKey]the private key data, if you want to use inline.--no-keyto ignore signing key and send clear update.--bundle [1.0.0]to set the bundle version number of the file to upload.--iv-session-key [key]to send a custom session key to the cloud.
⭐️ External option help to unlock 2 cases: corporate with privacy concern, don't send the code to a third part and app bigger than 200 MB. With this setting, Capgo store only the link to the zip and send the link to all app.
👀 Capgo cloud never look of what is in the link (for external option), or in the code when stored.
🔑 You can add a second layer of security by using encryption, then Capgo will not be able to look or modify anything, it becomes “trustless”.
Example of package.json for version
{
"version": "1.0.2"
}
⛔ Version should be greater than “0.0.0”.
💡 Don't forget to update the version number each time you send one, or device will don't see the update.
npx @capgo/cli bundle list [appId]Optionally, you can give:
--apikey [key]API key to link to your account.
npx @capgo/cli bundle delete [appId]Optionally, you can give:
--apikey [key]API key to link to your account.--bundlewith the version number will only delete this version.
in a SemVer range for a major version to Cloud
npx @capgo/cli bundle cleanup [appId] --bundle=[majorVersion] --keep=[numberToKeep]Optionally, you can give:
--apikey [key]API key to link to your account.--bundle [majorVersion]a version you wish to remove previous packages for, it will keep the last one + numberToKeep.--keep [numberToKeep]the number of packages you wish to keep (default 4).
For example: If you have 10 versions from 10.0.1 to 10.0.11, and you use
npx @capgo/cli cleanup [appId] --bundle=10.0.0 it will remove 10.0.1 to 10.0.6. 10.0.7 until 10.0.11 will be kept.If you have 20 versions in total, and you don't provide a bundle number like this:
npx @capgo/cli cleanup [appId] --keep=2 It will remove 18 versions, and keep the last 2.This command will ask for confirmation, it shows a table of what it will be keeping and removing.
npx @capgo/cli bundle encrypt [path/to/zip]Optionally, you can give:
--key [/path/to/my/private_key] the path of your private key.--key-data [privateKey] the private key data, if you want to use inline. This command is use when you use external source to store your code or for test purpose. The command will print your ivSessionKey and the encrypted zip, you can use it with the--iv-session-key and --external option of the upload command, or for decrypting the zip.npx @capgo/cli bundle decrypt [path/to/zip] [ivSessionKey]Optionally, you can give:
--key [/path/to/my/private_key] the path of your private key.--key-data [privateKey] the private key data, if you want to use inline. This command is mainly used for test purpose, it will decrypt the zip and print the base64 decrypted session key in the console.npx @capgo/cli bundle zip [appId]Optionally, you can give:
--path [/path/to/my/bundle]to upload a specific folder.--bundle [1.0.0]to set the bundle version number of the fileName.
npx @capgo/cli channel add [channelId] [appId][channelId] the name of your new channel. [appId] your app ID the format com.test.app is explained here.npx @capgo/cli channel delete [channelId] [appId][channelId] the name of your channel you want to delete. [appId] your app ID the format com.test.app is explained here.npx @capgo/cli channel list [appId]Optionally, you can give:
--apikey [key]API key to link to your account.
npx @capgo/cli channel set [channelId] [appId]Optionally, you can give:
--bundle [1.2.3]your app bundle already sent to the cloud, to link it to a channel.--latestget the bundle version frompackage.json:version, cannot be used with--bundle.--state [ normal | default ]set the channel state, can benormalordefault. One channel need to bedefault.--downgradeallow the channel to send downgrade version to devices.--no-downgradedisallow the channel to send downgrade version to devices.--upgradeallow the channel to send upgrade (major) version to devices.--no-upgradedisallow the channel to send upgrade (major) version to devices.--iosallow the channel to send version to iOS devices.--no-iosdisallow the channel to send version to iOS devices.--androidallow the channel to send version to android devices.--no-androiddisallow the channel to send version to android devices.--self-assignallow devices to self assign to this channel.--no-self-assigndisallow devices to self assign to this channel.--apikey [key]API key to link to your account.
Capgo support end-to-end encryption, this mean that your bundle(code) is encrypted before send to the cloud and decrypted on the device. For that, you need to generate an RSA key pair, you can use the following command to generate it.
The encryption system is a combination of RSA and AES, the RSA key is used to encrypt the AES key, and the AES key is used to encrypt the file.
See below for more information about the encryption system.
Ecryption schema
npx @capgo/cli key createOptionally, you can give:
--force to overwrite the existing key. This command will create for you a key pair in your app, and will ask you to save the private key in a safe place. It's recommended to not git commit the private and public key, and to not share it with anyone.After your local test remove the key from config file and add it on CI step withkey save
npx @capgo/cli key saveOptionally, you can give:
--key [/path/to/my/private_key] the path of your private key.--key-data [privateKey] the private key data, if you want to use inline. This command is useful if you followed the recommendation and didn't commit the key in your app, and in the config.To automate your work, I recommend you make GitHub action do the job of pushing to our server
Don’t forget to configure CI env variable with your API key
Last modified 21d ago