Skip to content
Martin DONADIEU edited this page May 3, 2022 · 13 revisions

Install

npm i -g capgo/cli

or with npx @capgo/cli

Usage

All command should be run in your app folder with capacitor project ignited. See below

Capacitor: Cross-platform native runtime for web apps

Add app to Cloud

capgo add [appId] --apikey=******** 

💡 All option will be guessed in your config if not provided

Optionally, you can give:

  • [appId] your app ID the format com.test.app is explained here
  • icon with -icon /path/to/my/icon to have a custom icon in the list
  • name with -name test to have a custom name in the list

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',
}

Upload version to Cloud

capgo upload [appId] --apikey=******** 

Optionally, you can give:

  • [appId] is your app ID the format is explained here
  • icon with -path ./www to send your code to the cloud
  • channel with -channel prod to link this version to channel by default, it's dev
  • version with -version 1.0.0 to choose the version number, if not provided it use the one in the package.json
  • external zip link with -external to use zipped version from external storage, it should be a zip URL in HTTPS

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

Send version to Cloud channel

capgo set [appId] --apikey=******** 

Optionally, you can give:

  • [appId] your app ID the format is explained here
  • -version your app version already sent to the cloud
  • -channel the channel you want to link the version, it doesn't exist it will be created
  • -state set the channel state, can be private or public. To use in your app, channel need to be public.

Delete package to Cloud

capgo delete [appId] --apikey=******** 

Optionally, you can give:

[appId] your app ID present in the Cloud

Ci integration

To automate your work, I recommend you make GitHub action do the job of pushing to our server

GitHub action example

Our demo app

GitHub - Cap-go/demo-app

Don’t forget to configure CI env variable with your API key

Clone this wiki locally