Command-Line Usage
Cordova now ships with a set of command-line tools that make it easier for you to develop cross-platform applications. You can build, clean, and launch an emulator with a single command. You can consider these instructions as an alternative to the Getting Started guides. Whereas the Getting Started guides help you get setup with the default IDEs and tooling surrounding the platforms you are working with, the command-line tools aim to provide a shell-based approach to creating and working with Cordova projects.
Supported Platforms
iOS
The iOS command-line tools are built upon shell scripts and rely on
Xcode command-line tools such as xcode-select
and xcodebuild
.
Create a project
Run the create
command with the following parameters:
- Path to your new Cordova iOS project
- Package name, following reverse-domain style convention
- Project name
$ ./path/to/cordova-ios/bin/create /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName
Build a project
$ /path/to/my_new_cordova_project/cordova/debug
Launch emulator
$ /path/to/my_new_cordova_project/cordova/emulate
Logging
$ /path/to/my_new_cordova_project/cordova/log
Android
The Android command-line tools are built upon shell scripts. You must
have the Android SDK's tools
and platform-tools
folders in your
PATH!
Create a project
Run the create
command with the following parameters:
- Path to your new Cordova Android project
- Package name, following reverse-domain style convention
- Main Activity name
$ /path/to/cordova-android/bin/create /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName
or, on Windows
$ /path/to/cordova-android/bin/create.bat /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName
Build a project
$ /path/to/my_new_cordova_project/cordova/debug
or, on Windows
$ /path/to/my_new_cordova_project/cordova/debug.bat
Launch emulator
$ /path/to/my_new_cordova_project/cordova/emulate
or, on Windows
$ /path/to/my_new_cordova_project/cordova/emulate.bat
Make sure you have created at least one Android Virtual Device. If you did not it will ask you to create one with the android
command.
If you have multiple AVDs, it will prompt you to select an AVD.
Logging
$ /path/to/my_new_cordova_project/cordova/log
or, on Windows
$ /path/to/my_new_cordova_project/cordova/log.bat
Cleaning
$ /path/to/my_new_cordova_project/cordova/clean
or, on Windows
$ /path/to/my_new_cordova_project/cordova/clean.bat
Clean, build, deploy and launch
$ /path/to/my_new_cordova_project/cordova/BOOM
or, on Windows
$ /path/to/my_new_cordova_project/cordova/BOOM.bat
Make sure you have an emulator or a device connected.
BlackBerry
The BlackBerry command-line tools are built upon shell scripts.
Create a project
Run the create
command with the following parameters:
- Path to your new Cordova BlackBerry project
- Application name
$ /path/to/cordova-blackberry-webworks/bin/create /path/to/my_new_cordova_project CordovaProjectName
or, on Windows
$ /path/to/cordova-blackberry-webworks/bin/create.bat /path/to/my_new_cordova_project CordovaProjectName
Build a project
For BlackBerry projects, please make sure you customize the
project.properties
file in the root of your Cordova project folder.
This is necessary for things like supplying your BlackBerry signing key
password, location of the BlackBerry WebWorks SDK, and location of
BlackBerry simulator executables.
$ /path/to/my_new_cordova_project/cordova/debug
or, on Windows
$ /path/to/my_new_cordova_project/cordova/debug.bat
Launch emulator
For BlackBerry projects, please make sure you customize the
project.properties
file in the root of your Cordova project folder.
This is necessary for things like supplying your BlackBerry signing key
password, location of the BlackBerry WebWorks SDK, and location of
BlackBerry simulator executables.
$ /path/to/my_new_cordova_project/cordova/emulate
or, on Windows
$ /path/to/my_new_cordova_project/cordova/emulate.bat
Logging
Unfortunately streaming logs directly from the device is not
supported at this time. However, BlackBerry offers built-in Web
Inspector support for Playbook and BlackBerry smartphone devices running
BlackBerry OS 7.0 and above. Additionally, you can access your
application's logs (including any calls to console.log
) on your device
by holding down the ALT key from the home screen and hitting "lglg"
keys.