This version of the documentation is outdated! Click here for the latest released version.

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.

Windows Phone

The Windows Phone command line tools support creating, building and running new projects.

Create a project

Run the create command with the following parameters:

Path to your new Cordova Windows Phone project
Package Name, following reverse-domain style convention ( this becomes the default Namespace )
Project name

$ C:\path\to\cordova-wp8\bin\create C:\path\to\my_new_cordova_project com.example.cordova_project_name CordovaProjectName

Building your project (cleans then builds)

Debug

$ C:\path\to\my_new_cordova_project\cordova\build --debug

Release

$ C:\path\to\my_new_cordova_project\cordova\build --release

Running your application

Run the 'run' command with the following optional parameters

Target specification. This includes --emulator, --device, or --target=<targetID>.
Build specification. This includes --debug, --release, or --nobuild.

$ C:\path\to\my_new_cordova_project\cordova\run [Target] [Build]

By default the run command will look for a connected device, if no device is found it will look for any started emulators. If you have multiple emulators, you can specify a target ID.

Cleaning

$ C:\path\to\my_new_cordova_project\cordova\clean

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/build

Run app on emulator

$ /path/to/my_new_cordova_project/cordova/run

Releasing

$ /path/to/my_new_cordova_project/cordova/release

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

$ C:\path\to\cordova-android\bin\create.bat C:\path\to\my_new_cordova_project com.example.cordova_project_name CordovaProjectName

Building your project (cleans then builds)

Debug

$ /path/to/my_new_cordova_project/cordova/build --debug

or, on Windows

$ C:\path\to\my_new_cordova_project\cordova\build.bat --debug

Release

$ /path/to/my_new_cordova_project/cordova/build --release

or, on Windows

$ C:\path\to\my_new_cordova_project\cordova\build.bat --release

Running your application

Run the 'run' command with the following optional parameters

Target specification. This includes --emulator, --device, or --target=<targetID>.
Build specification. This includes --debug, --release, or --nobuild.

$ /path/to/my_new_cordova_project/cordova/run [Target] [Build]

or, on Windows

$ C:\path\to\my_new_cordova_project\cordova\run.bat [Target] [Build]

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. By default the run command will look for a connected device, if no device is found it will look for any started emulators. If you have multiple AVDs, you can specify a target ID.

Logging

$ /path/to/my_new_cordova_project/cordova/log

or, on Windows

$ C:\path\to\my_new_cordova_project\cordova\log.bat

Cleaning

$ /path/to/my_new_cordova_project/cordova/clean

or, on Windows

$ C:\path\to\my_new_cordova_project\cordova\clean.bat

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
Placeholder package name
Application name

$ /path/to/cordova-blackberry-webworks/bin/create /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName

or, on Windows

$ /path/to/cordova-blackberry-webworks/bin/create.bat /path/to/my_new_cordova_project com.example.cordova_project_name CordovaProjectName

Note: the package name placeholder (com.example.cordova_project_name) is ignored on the BlackBerry platform, but is required for use of the crossplatform tools

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/build <platform>

or, on Windows

$ /path/to/my_new_cordova_project/cordova/build.bat <platform>

Launch simulator

$ /path/to/my_new_cordova_project/cordova/run <platform>

and then choose 'no' when prompted with:

Do you have a BlackBerry device connected to your computer? (y/n)

or, on Windows

$ /path/to/my_new_cordova_project/cordova/run <platform>

and then choose 'no' when prompted with:

Do you have a BlackBerry device connected to your computer? (y/n)

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.