gmabuildtool
The gmabuildtool is a utility to create app packages for an Androidâ„¢ device.
Syntax
gmabuildtool command [option [...]]
- command can be one of the following:
updatesdk
: updates the Android SDK, to download packages required by GMA.scaffold
: manages scaffold archives.build
: builds app packages (.aab and .apk).test
: deploys an APK package and launches the app on the device or emulator.
- option can be a general or command-specific option, as described in Options.
Options
Option | Short option | Description |
---|---|---|
--android-sdk path |
-as |
The path to the Android SDK installation directory. |
--help |
-h |
Display options for the tool. |
--input-options path |
-i |
Path to the file containing gmabuildtool
options. Define all options in a file and pass the file to the gmabuildtool
command with the The options file must use the following
format:
|
--java-home path |
-jh |
Java home path. Default is JAVA_HOME. |
--proxy-host host |
-ph |
Defines the proxy host. |
--proxy-host port |
-pp |
Defines the proxy port. |
--verbose-fine |
-v |
Verbose mode (level 1) |
--verbose-finer |
-vv |
Verbose mode (level 2) |
--verbose-finest |
-vvv |
Verbose mode (level 3) - shows all possible logs. |
--version |
-V |
Displays version information. |
Option | Short option | Description |
---|---|---|
--accept-licenses |
-al |
Silently accept Android SDK licenses when the Android SDK is updated. |
--no-install-extras |
-uN |
Avoid installation of extra SDK modules. |
--no-interactions |
-nI |
Silently accepts prompts when extras are installed during Android SDK installation, by answering yes to all questions asked during
the installation process.
Note: This option also answers yes to prompts to
accept licenses. gmabuildtool updatesdk --no-interactions is the same as the
command gmabuildtool updatesdk --no-interactions --accept licenses |
Option | Short option | Description |
---|---|---|
--install-plugins
plugin-list |
-ip |
Install the specified plugins in the scaffold archive. The plugin-list must be a comma-separated list of plugins. |
--list-plugins |
-lp |
List the plugins available in the scaffold archive. |
Option | Short option | Description |
---|---|---|
--clean |
-c |
Cleans the intermediate build files before a rebuild. Use the
Note: The
--clean option does not remove and replace the scaffold, as done by the
--build-force-scaffold-update option. |
--build-app-colors
color-list |
-bc |
Define the Android color theme for the app (Android 5.0+ / SDK 21+) The value must be a comma-separated
list of four hexadecimal RGB colors:
The position of the RGB value in the color list defines its purpose:
|
--build-app-genero-program-main
path |
-bgpm |
Relative path to the main module of
the application (can be .42m or .42r). Defaults to main.42m |
--build-app-genero-program
path |
-bgp |
Defines the path to the application
program files (.42m, .42f, etc) The contents of this directory will be zipped and bundled inside app packages. This option can handle an already zipped Genero program archive. If not specified, defaults to the current working directory. Note: The
path defined by this option is used as base directory for other options such as
--build-project and application icon resources options. |
--build-app-icon-hdpi
path |
-bih |
Defines the path to application icon
in hdpi. Default is top-dir/gma/ic_app_hdpi.png, where
top-dir is defined by the |
--build-app-icon-mdpi
path |
-bim |
Defines the path to application icon
in mdpi. Default is top-dir/gma/ic_app_mdpi.png, where
top-dir is defined by the |
--build-app-icon-xhdpi
path |
-bixh |
Defines the path to application icon
in xhdpi. Default is top-dir/gma/ic_app_xhdpi.png, where
top-dir is defined by the |
--build-app-icon-xxhdpi
path |
-bixxh |
Defines the path to application icon
in xxhdpi. Default is top-dir/gma/ic_app_xxhdpi.png, where
top-dir is defined by the |
--build-app-name
app-name |
-bn |
Application name. If not specified, the application name defaults to the current working directory. |
--build-app-package-name
name |
-bpn |
App package name. It is
recommended to format the package name as
" If
not specified, the application package name defaults to
|
--build-app-permissions
permissions |
-ba |
Android application permissions. The list of permissions is provided as a
comma separated list of For more details, see Android permissions. |
--build-app-version-code
version-code |
-bvc |
Application version code. For example: 100915 The value of this option must be an integer (do not use decimal numbers). |
--build-app-version-name
version-name |
-bvn |
Application version name. For example: 10.09.15 This will be the actual app version visible on devices. |
--build-apk-outputs path |
-bo |
Defines the destination folder where the app packages must be created. |
--build-cordova
cordova-plugin-names |
-bco |
Defines Cordova plugins to be embedded in the app package. When specifying multiple cordova plugins, use the comma ( The name of the plugin must match the Git repository name. It is case-sensitive. Note: To get the list of available Cordova plugins, use the
gmabuildtool scaffold --list-plugins command.
For further information, see Cordova plugins. |
--build-force-scaffold-update |
-bfsu |
Forces to re-create the app project directory with the original
GMA scaffold directory (defined by --build-project ) |
--build-gbc-runtime
gbc-archive |
-bgr |
Defines the GBC to be used for Universal Rendering. gbc-archive is the GBC ZIP archive. For more details, see the Create a runtime zip topic in the Genero Browser Client User Guide. |
--build-jarsigner-alias
alias |
-bja |
Jarsigner alias. This is the alias provided to the keystore utility to build the keystore file to sign the app. |
--build-jarsigner-keypass
keypass |
-bjk |
Jarsigner keypass. Specifies the password used to protect the private key of the keystore entry addressed by the alias specified in the --build-jarsigner-alias option. The password is required when using jarsigner to sign a JAR file. |
--build-jarsigner-keystore
path |
-bjks |
Jarsigner keystore path. This is the path to the keystore file generated by the keystore utility to sign the app. |
--build-jarsigner-storepass
storepass |
-bjs |
Jarsigner storepass. Specifies the password that is required to access the keystore. |
--build-mode
{release|debug} |
-bm |
Package build mode, to build a
release version or a development/debug version. Default: |
--build-output-apk-name
name |
-ban |
Defines the prefix for the app
packages names. By default, this prefix is "app". The file name of the app package is formed from:
MyApp and is a debug package, the
resulting package file names will be: MyApp-debug.aab and
MyApp-debug.apk. |
--build-project
path |
-bp |
Defines the path to the directory
containing the original GMA binary archive files (i.e. scaffolding), or the directory containing the
Android Studio project, when building
a customized GMA. Default is top-dir/gma/project, where
top-dir is defined by the |
--build-quietly |
-bq |
Forces a silent build, by answering yes to all questions asked
during the build process. By default, the user must answer to the build questions by yes/no. |
--build-status-icon-hdpi
path |
-bsh |
Status icon path for hdpi (high dots per inch) size. The default path is top-dir/gma/ic_status_hdpi.png, where
top-dir is defined by the If this option is not specified, yet you provide default files under the gma directory named like those defined for the default path, your package will use these files. If you don't provide any status icon files, the default files are used. |
--build-status-icon-mdpi path
|
-bsm
|
Status icon path for mdpi (medium dots per inch) size. The default path is top-dir/gma/ic_status_mdpi.png, where
top-dir is defined by the If this option is not specified, yet you provide default files under the gma directory named like those defined for the default path, your package will use these files. If you don't provide any status icon files, the default files are used. |
--build-status-icon-xhdpi
path
|
-bsxh |
Status icon path for xhdpi (extra-high dots per inch) size. The default path is top-dir/gma/ic_status_xhdpi.png,
where top-dir is defined by the If this option is not specified, yet you provide default files under the gma directory named like those defined for the default path, your package will use these files. If you don't provide any status icon files, the default files are used. |
--build-with-firebase-analytics-collection |
-bfac |
When doing push notifications with Firebase Could Messaging, enable user data collection for analytics (For more details, see Analytics in FCM documentation) |
Option | Short option | Description |
---|---|---|
--test-apk path |
-ta |
Path to the APK file to deploy and launch for testing. |