CLI Utility for Mobile SDK for Cordova

The command line tool to build and manage Mobile SDK for Cordova based applications.

Mobile SDK for Cordova allows for building native MAS enabled mobile applications using HTML, CSS and JavaScript.

This tool helps with Mobile SDK for Cordova plugin integration as well as management of multi-platform Mobile SDK for Cordova based applications.

Installation

Install the command line tool using the npm utility of Node.js. The CLI tool will automatically be downloaded by the npm utility.

On Windows (Cygwin Or Git Bash):

    $npm install -g cordova-mas-cli

On Mac OS X and Linux:

    $sudo npm install -g cordova-mas-cli

Review Prerequisites

Before you use the CLI Utility for Mobile SDK for Cordova, you must do the following Prerequisites

Supported Versions

• Mobile SDK for Cordova : 1.9.00
• Cordova : 8.0.0 or later
• Cocoapods : 1.4.0 or later
• XCode : 9.3.1 or later
• Android Studio: 3.1.1 or later
• Node.js : 8.11.1 or later

Forging and preparing a new Mobile SDK for Cordova project

This simple example demonstrates how cordova-mas-cli can be used to create a myApp project with the storage template and run it for iOS platform.

    mas forge -i myApp
    cd myApp
    mas prepare storage   
    
    // ----> cordova-mas-cli ends its role here
    // Using cordova to build and run

    cordova requirements ios    
    cordova build ios --verbose
    cordova run ios

cordova-mas-cli Quick Reference

mas forge command

This command creates a new Cordova Project in the current directory with specified name and adds Platform (iOS/Android) based on the options given in the command.

Usage: forge [options]

Synopsis

 mas forge [options] <NAME> 

 Create a MAS project 

	 NAME ......................... The name of your project directory. 

Options:

-i, --ios                Add platform iOS
-a, --android            Add platform Android
-p, --package <package>  Specify the bundle ID/application ID for your app (Reverse-domain-style package name - used in <widget id>)
-h, --help               output usage information

mas prepare command

This command adds the Mobile SDK for Cordova plugins based on the specified template and prepares the project with the file path specified. It should be executed from inside a valid Cordova project.

Usage: prepare [options] [template]

Synopsis

 mas prepare [TEMPLATE] 

 Prepare a MAS project 

	 TEMPLATE ..................... Starter named templates (ex: core, storage, identitymanagement, connecta)
					If TEMPLATE is not provided 'core' will be used by default

Options:

-p, --path <path>          Path to the application files directory to be used to prepare the project with. The given path root should contain index.html at least. If this command is run on Cygwin, use Windows style. For example, use 'C:' instead of '/cygdrive/c'
-h, --help                 output usage information

mas purge command

This command clears the cordova-mas-cli logs.

Usage: purge [options]

Synopsis

 mas purge

 Clear logs 

Options:

-h, --help  output usage information

Docs

• Overview of Mobile SDK for Cordova
• Create your first Mobile SDK for Cordova app
• Full reference docs for cordova-mas-cli has details of commands to forge, prepare and purge Mobile SDK for Cordova based projects.

How You Can Contribute

This utility is an open source project and contributors are needed to keep this project moving forward. Contributions are welcome and much appreciated. To learn more, see the Contribution Guidelines.

Communication

• Have general questions or need help?, use Stack Overflow. (Tag 'massdk')
• Find a bug?, open an issue with the steps to reproduce it.
• Request a feature or have an idea?, open an issue.

License

Copyright (c) 2016 CA. All rights reserved.

This software may be modified and distributed under the terms of the MIT license. See the LICENSE file for details.