new Appc_Helper()
Commands to interact with the Appcelerator and Titanium CLI. This contains a
series of specific commands, or a more general runner command for your own
CLI interactions.
- Source:
Methods
(static) build(dir, platform, opts)
Build a specified application for a given platform. Also allows users to
specify their own arguments.
Parameters:
| Name |
Type |
Description |
dir |
String
|
The path to the application root |
platform |
String
|
The mobile OS the app is being built for |
opts |
Object
|
Optional arguments
Properties
| Name |
Type |
Description |
args |
Array.<String>
|
Any additional arguments to be passed to the command |
ti |
Boolean
|
Whether or not to use the titanium CLI |
|
- Source:
(static) createAppPath(dir, platform, appName)
Generate a path to the built application based upon platform
Parameters:
| Name |
Type |
Description |
dir |
String
|
The path to the root of the application project |
platform |
String
|
The relevant mobile OS |
appName |
String
|
The name of the app to identify the app package |
- Source:
(async, static) installCLI(appc)
Install the latest version of the required CLI version for testing.
Parameters:
| Name |
Type |
Description |
appc |
Object
|
The details for the Appcelerator run
Properties
| Name |
Type |
Description |
cli |
String
|
The version of the CLI to install |
username |
String
|
The username to authenticate with |
password |
String
|
The password to authenticate with |
organisation |
String
|
The relevant org ID to log in to |
|
- Source:
(async, static) installSDK(sdk, force)
Take the passed SDK, and attempt to install it. If it is a straight defined
SDK, then install it. Otherwise if it is a branch, get the latest version
of it.
Parameters:
| Name |
Type |
Default |
Description |
sdk |
String
|
|
The version or branch of the SDK to install |
force |
Boolean
|
false
|
Whether or not to force re-install the SDK |
- Source:
(async, static) login(appc, env)
Login to the Appcelerator CLI using the login command.
Parameters:
| Name |
Type |
Description |
appc |
Object
|
The details for the Appcelerator run
Properties
| Name |
Type |
Description |
username |
String
|
The username to authenticate with |
password |
String
|
The password to authenticate with |
organisation |
String
|
The relevant org ID to log in to |
|
env |
String
|
The Appcelerator environment to login to. |
- Source:
(async, static) parseSDK(sdk)
Takes in an SDK identifier and attempts to resolve it to the applicable SDK
version. Can take a release version, pre-release version, or branch
identifier and attempts to resolve it to an installable identifier.
Parameters:
| Name |
Type |
Description |
sdk |
String
|
The version or branch of the SDK to validate |
- Source:
(static) runner(args, opts)
Build a specified application for a given platform. Also allows users to
specify their own arguments
Parameters:
| Name |
Type |
Description |
args |
String
|
Arguments to be run after calling appc |
opts |
Object
|
Optional arguments
Properties
| Name |
Type |
Description |
matcher |
function
|
A function that can be used to resolve |
ti |
Boolean
|
Whether or not to use the titanium CLI |
proc |
String
|
Custom name for the global, if empty no global will be created |
|
- Source: