NAME
bb-mobile - Get bb project or global options
SYNOPSIS
bb-mobile [--help] [-v|--version]
bb-mobile encrypt [--help] [-a|--hashassets] [-b|--buildvariant <buildvariantname>]
[-d|--directory <path>] <platform>,<configuration>
bb-mobile upgrade-conf [--help] [-s|--source <version>] [-t|--target <version>]
[-o|--output <path>] <configuration>
bb-mobile upgrade-model [--help] [-s|--source <version>] [-t|--target <version>]
[-o|--output <path>] <model>
DESCRIPTION
To execute commands related to the mobile application development.
When bb-cli commands are run the options are taken from the currently selected configuration.
OPTIONS
| Option | Description |
|---|---|
| -v, --version | output the version number |
| --help | Output usage information |
COMMANDS
NAME
bb-mobile encrypt - Encrypt a configuration file
SYNOPSIS
bb-mobile encrypt [--help] [-a|--hashassets] [-b|--buildvariant <buildvariantname>]
[-d|--directory <path>] <platform>,<configuration>
DESCRIPTION
To encrypt a configuration file during building time. Optionally, hashes from the assets can be calculated and added to the encrypted configuration to be used as part of the Runtime Integrity Check feature of the SDK.
OPTIONS
| Option | Description |
|---|---|
| -a, --hashassets | Generates the hashes of the assets for runtime checks |
| -b, --buildvariant <buildvariantname> | (Android only) consider all |
| the paths specific to this build variant when hashing assets | |
| -d, --directory <path> | Search path for the assets to be hashed. In android, |
| the following path will be appended to the given : /app/src/main/assets | |
| --help | Output usage information |
ARGUMENTS
platform Platform to be encrypt the configuration (supported platforms: android, ios)
configuration Path to the configuration file to be encrypted.
EXAMPLES
In order to encrypt a configuration file you can use:
For Android:
bb-mobile encrypt android app/src/main/assets/config.json
or for iOS:
bb-mobile encrypt ios assets/config.json
If you want to enable the Runtime Integrity Check you can add the -a or --hashassets flag.
For Android:
bb-mobile encrypt android app/src/main/assets/config.json -a
or
bb-mobile encrypt android app/src/main/assets/config.json --hashassets
For iOS:
bb-mobile encrypt ios assets/config.json -a
or
bb-mobile encrypt ios assets/config.json --hashassets
NAME
bb-mobile upgrade-conf - Upgrade configuration file from 1.x format to 2.x or 3.x format
SYNOPSIS
bb-mobile upgrade-conf [--help] [-s|--source <version>] [-t|--target <version>]
[-o|--output <path>] <configuration>
DESCRIPTION
To upgrade an application configuration file to a newer configuration format required by a specific Mobile SDK version.
OPTIONS
| Option | Description |
|---|---|
| -s, --source <version> | Source version to upgrade from |
| -t, --target <version> | Target version to upgrade to |
| -o, --output <path> | Output path for the upgraded configuration. |
| If none is provided the upgraded configuration will be output in the standard output (stdout) | |
| --help | Output usage information |
ARGUMENTS
configuration Path to the configuration file to be upgraded.
EXAMPLES
In order to upgrade a configuration file you can use:
bb-mobile upgrade-conf app/src/main/assets/config.json -o app/src/main/assets/config-3.json
If you want to simply preview the upgraded result, you can omit the --output parameter and the result will be displayed on the standard output
bb-mobile upgrade-conf app/src/main/assets/config.json
If you want to migrate a configuration from version 1 to version 3, you can use:
bb-mobile upgrade-conf app/src/main/assets/config.json -s 1 -t 3 -o config-3.json
or, omit the target version as 3 is the default.
bb-mobile upgrade-conf app/src/main/assets/config.json -s 1 -o config-3.json
If you want to migrate a configuration from version 2 to version 3, you can use:
bb-mobile upgrade-conf app/src/main/assets/config.json -t 3 -o config-3.json
The -s 2 flag can be omitted as 2 is the default source version.
NAME
bb-mobile upgrade-model - Upgrade model file (local model) from 1.x format to 2.x or 3.4 format (mobile optimized)
SYNOPSIS
bb-mobile upgrade-model [--help] [-s|--source <version>] [-t|--target <version>]
[-o|--output <path>] <model>
DESCRIPTION
To upgrade an application model file to a newer model format required by a specific Mobile SDK version.
OPTIONS
| Option | Description |
|---|---|
| -s, --source <version> | Source version to upgrade from |
| -t, --target <version> | Target version to upgrade to |
| -o, --output <path> | Output path for the upgraded model. |
| If none is provided the upgraded model will be output in the standard output (stdout) | |
| --help | Output usage information |
ARGUMENTS
model Path to the local model file to be upgraded.
EXAMPLES
In order to upgrade a local model file you can use:
bb-mobile upgrade-model app/src/main/assets/local_model.json -o app/src/main/assets/local_model-3.json
If you want to simply preview the upgraded result, you can omit the --output parameter and the result will be displayed on the standard output
bb-mobile upgrade-model app/src/main/assets/local_model.json
If you want to migrate a local model from version 1 to version 3.4, you can use:
bb-mobile upgrade-model app/src/main/assets/local_model.json -s 1 -t 3.4 -o local_model-3.json
or, omit the target version as 3.4 is the default.
bb-mobile upgrade-model app/src/main/assets/local_model.json -s 1 -o local_model-3.json
If you want to migrate a local model from version 2 to version 3.4, you can use:
bb-mobile upgrade-model app/src/main/assets/local_model.json -t 3.4 -o local_model-3.json
The -s 2 flag can be omitted as 2 is the default source version.
ENVIRONMENT VARIABLES
Set the amount of log output
LOG_LEVEL=silly|verbose|info|warn|error
Set whether or not to use colors in output
COLOR=false|true