@getik-public/cli
v1.5.5
Published
Getik CLI
Readme
Getik CLI
@getik-public/cli is a collection of scripts meant to ease the development flow. For available scripts read further.
How to use the cli
Add next line in your package.json file under devDependencies:"@getik-public/cli": "X.Y.Z" or simply run npm i @getik-public/cli@latest --save-dev.
Available scripts
mobile-build
Usage: getik-cli mobile-build [-p, --platform] [-e, --environment] [--syncOnly] [--aab] [--upload]
Example: getik-cli mobile-build -p android -e getikDebug --syncOnly
Example: getik-cli mobile-build --platform ios --environment getik --upload
| Option | Required | Values | Description |
|---------------------|----------|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| -p, --platform | NO | android, ios | Platform to build for. |
| -e, --environment | YES | <string>, <string>Debug | While environment can be any name, be consistent and use these: getik, vbox, qa, prod. Every environment must have a pair for debug build, so have these environments also defined: getikDebug, vboxDebug, qaDebug, prodDebug |
| --syncOnly | NO | - | For development only, if you need to apply javascript build, or a new plugin was added. This will not go further to trigger an android or ios build script. If --platform missing it will run cap sync for all platforms. |
| --aab | NO | - | For --platform android only. Build aab file instead of apk file. |
| --upload | NO | - | For --platform ios only. Instant upload to store after build, if successful. |
| --releaseTesting | NO | - | For --platform ios only. Will apply *-export-options.testing.plist file instead of *-export-options.plist. |
web-build
Usage: getik-cli web-build [-e, --environment] [--syncOnly]
Example: getik-cli web-build -e getik --syncOnly
Example: getik-cli web-build -e getik
| Option | Required | Values | Description |
|-----------------------|----------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| -e, --environment | YES | <string> | While environment can be any name, be consistent and use these: getik, vbox, qa, preprod, prod. |
| --syncOnly | NO | - | For development only, it will create a file named version.ts with version found in package.json. Use this version in all environment.ts files. This will not go further to trigger the actual build script. |
| --includeDemo | NO | - | Use this flag to also include the demo build variant for the selected environment. |
| --includeFallback | NO | - | Use this flag to also include the fallback build variant for the selected environment. |
upload-to-getik-cloud
Usage: getik-cli upload-to-getik-cloud ./path/to/my-file.apk --host awesome.host.net --useCommitHash
Use this command to upload apk files to getik cloud. If successful, in command line you will find a direct link to fresh uploaded file alongside a link to the full list.
Run this command from the root of the project, as it tries to look for project name in package.json file. Project name will be used as file name.
Use --useCommitHash option if git hash needs to be added to the file name. This parameter is optional.
