Cordova Command-line-interface (CLI) Reference

Syntax

cordova <command> [options] -- [platformOpts]

Global Command List

These commands are available at all times.

Project Command List

These commands are supported when the current working directory is a valid Cordova project.

Common options

These options apply to all cordova-cli commands.

Platform-specific options

Certain commands have options (platformOpts) that are specific to a particular platform. They can be provided to the cordova-cli with a '--' separator that stops the command parsing within the cordova-lib module and passes through rest of the options for platforms to parse.

Examples

• This example demonstrates how cordova-cli can be used to create a project with the camera plugin and run it for android platform. In particular, platform specific options like --keystore can be provided:

   # Create a cordova project
   cordova create myApp com.myCompany.myApp myApp
   cd myApp
   # Add camera plugin to the project and remember that in config.xml & package.json.
   cordova plugin add cordova-plugin-camera
   # Add android platform to the project and remember that in config.xml & package.json.
   cordova platform add android
   # Check to see if your system is configured for building android platform.
   cordova requirements android
   # Build the android and emit verbose logs.
   cordova build android --verbose
   # Run the project on the android platform.
   cordova run android
   # Build for android platform in release mode with specified signing parameters.
   cordova build android --release -- --keystore="..\android.keystore" --storePassword=android --alias=mykey
  

cordova create command

Synopsis

Create the directory structure for the Cordova project in the specified path.

Syntax

cordova create path [id [name]] [options]

Options

Directory structure

Cordova CLI works with the following directory structure:

myapp/
|-- config.xml
|-- merges/
| | |-- android/
| | |-- windows/
| | |-- ios/
|-- www/
|-- platforms/
| |-- android/
| |-- windows/
| |-- ios/
|-- plugins/
  |--cordova-plugin-camera/

config.xml

Configures your application and allows you to customize the behavior of your project. See also config.xml reference documentation

www/

Contains the project's web artifacts, such as .html, .css and .js files. As a cordova application developer, most of your code and assets will go here. They will be copied on a cordova prepare to each platform's www directory. The www source directory is reproduced within each platform's subdirectory, appearing for example in platforms/ios/www or platforms/android/assets/www. Because the CLI constantly copies over files from the source www folder, you should only edit these files and not the ones located under the platforms subdirectories. If you use version control software, you should add this source www folder, along with the merges folder, to your version control system.

platforms/

Contains all the source code and build scripts for the platforms that you add to your project.

WARNING: When using the CLI to build your application, you should not edit any files in the /platforms/ directory unless you know what you are doing, or if documentation specifies otherwise. The files in this directory are routinely overwritten when preparing applications for building, or when plugins are re-installed.

plugins/

Any added plugins will be extracted or copied into this directory.

merges/

Platform-specific web assets (HTML, CSS and JavaScript files) are contained within appropriate subfolders in this directory. These are deployed during a prepare to the appropriate native directory. Files placed under merges/ will override matching files in the www/ folder for the relevant platform. A quick example, assuming a project structure of:

merges/
|-- ios/
| -- app.js
|-- android/
| -- android.js
www/
-- app.js

After building the Android and iOS projects, the Android application will contain both app.js and android.js. However, the iOS application will only contain an app.js, and it will be the one from merges/ios/app.js, overriding the "common" app.js located inside www/.

Version control

It is recommended not to check in platforms/ and plugins/ directories into version control as they are considered a build artifact. Your platforms and plugins will be saved in config.xml & package.json automatically. These platforms/plugins will be downloaded when cordova prepare is invoked.

Examples

• Create a Cordova project in myapp directory using the specified ID and display name:

    cordova create myapp com.mycompany.myteam.myapp MyApp
  

cordova platform command

Synopsis

Manage cordova platforms - allowing you to add, remove, update and list platforms. Running commands to add or remove platforms affects the contents of the project's platforms directory.

Syntax

cordova {platform | platforms} [
    add <platform-spec> [...] {--save | link=<path> } |
    {remove | rm}  platform [...] {--save}|
    {list | ls}  |
    update ]

Platform-spec

There are a number of ways to specify a platform:

<platform-spec> : platform[@version] | path | url[#commit-ish]

Supported Platforms

• android
• ios
• windows
• browser
• electron

Examples

• Add pinned version of the android and ios platform and save the downloaded version to config.xml & package.json:

    cordova platform add android ios
  

• Add android platform with semver version ^5.0.0 and save it to config.xml & package.json:

    cordova platform add android@^5.0.0
  

• Add platform by cloning the specified git repo and checkout to the 4.0.0 tag:

    cordova platform add https://github.com/myfork/cordova-android.git#4.0.0
  

• Add platform using a local directory named android:

    cordova platform add ../android
  

• Add platform using the specified tarball:

    cordova platform add ../cordova-android.tgz
  

• Remove android platform from the project and remove from config.xml & package.json:

    cordova platform rm android
  

• Remove android platform from the project and do NOT remove from config.xml & package.json:

    cordova platform rm android --nosave
  

• List available and installed platforms with version numbers. This is useful to find version numbers when reporting issues:

    cordova platform ls
  

cordova plugin command

Synopsis

Manage project plugins

Syntax

cordova {plugin | plugins} [
    add <plugin-spec> [..] {--searchpath=<directory> | --noregistry | --link | --save | --force} |
    {remove | rm} {<pluginid> | <name>} --save |
    {list | ls}
]

Plugin-spec

There are a number of ways to specify a plugin:

<plugin-spec> : [@scope/]pluginID[@version]|directory|url[#commit-ish][:subdir]

Algorithm for resolving plugins

When adding a plugin to a project, the CLI will resolve the plugin based on the following criteria (listed in order of precedence):

1. The plugin-spec given in the command (e.g. cordova plugin add pluginID@version)
2. The plugin-spec saved in config.xml & package.json (i.e. if the plugin was previously added without --nosave)
3. As of Cordova version 6.1, the latest plugin version published to npm that the current project can support (only applies to plugins that list their Cordova dependencies in their package.json)
4. The latest plugin version published to npm

Examples

• Add cordova-plugin-camera and cordova-plugin-file to the project and save it to config.xml & package.json. Use ../plugins directory to search for the plugins.

    cordova plugin add cordova-plugin-camera cordova-plugin-file --save --searchpath ../plugins
  

• Add cordova-plugin-camera with semver version ^2.0.0 and save it to config.xml & package.json:

    cordova plugin add cordova-plugin-camera@^2.0.0
  

• Add the plugin from the specified local directory:

    cordova plugin add ../cordova-plugin-camera
  

• Add the plugin from the specified tarball file:

    cordova plugin add ../cordova-plugin-camera.tgz
  

• Remove the plugin from the project and the config.xml & package.json:

    cordova plugin rm camera
  

• Remove the plugin from the project, but not the config.xml or package.json:

    cordova plugin rm camera --nosave
  

• List all plugins installed in the project:

    cordova plugin ls
  

Conflicting plugins

Conflicting plugins may occur when adding plugins that use edit-config tags in their plugin.xml file. edit-config allows plugins to add or replace attributes of XML elements.

This feature can cause issues with the application if more than one plugin tries to modify the same XML element. Conflict detection has been implemented to prevent plugins from being added so one plugin doesn't try to overwrite another plugin's edit-config changes. An error will be thrown when a conflict in edit-config has been found and the plugin won't be added. The error message will mention that all conflicts must be resolved before the plugin can be added. One option to resolving the edit-config conflict is to make changes to the affected plugins' plugin.xml so that they do not modify the same XML element. The other option is to use the --force flag to force add the plugin. This option should be used with caution as it ignores the conflict detection and will overwrite all conflicts it has with other plugins, thus may leave the other plugins in a bad state.

Refer to the plugin.xml guide for managing edit-config, resolving conflicts, and examples.

cordova prepare command

Synopsis

Transforms config.xml metadata to platform-specific manifest files, copies icons & splashscreens, copies plugin files for specified platforms so that the project is ready to build with each native SDK.

Syntax

cordova prepare [<platform> [..]]

Options

cordova compile command

Synopsis

cordova compile is a subset of the cordova build command. It only performs the compilation step without doing prepare. It's common to invoke cordova build instead of this command - however, this stage is useful to allow extending using hooks.

Syntax

cordova compile [<platform> [...]]
    [--debug | --release]
    [--device | --emulator | --target=<targetName>]
    [--buildConfig=<configfile>]
    [-- <platformOpts>]

For detailed documentation see cordova build command docs below.

cordova build command

Synopsis

Shortcut for cordova prepare + cordova compile for all/the specified platforms. Allows you to build the app for the specified platform.

Syntax

cordova build [<platform> [...]]
    [--debug | --release]
    [--device | --emulator]
    [--buildConfig=<configfile>]
    [-- <platformOpts>]

Examples

• Build for android and windows platform in debug mode for deployment to device:

    cordova build android windows --debug --device
  

• Build for android platform in release mode and use the specified build configuration:

    cordova build android --release --buildConfig=..\myBuildConfig.json
  

• Build for android platform in release mode and pass custom platform options to android build process:

    cordova build android --release -- --keystore="..\android.keystore" --storePassword=android --alias=mykey
  

cordova run command

Synopsis

Prepares, builds, and deploys app on specified platform devices/emulators. If a device is connected it will be used, unless an eligible emulator is already running.

Syntax

cordova run [<platform> [...]]
    [--list | --debug | --release]
    [--noprepare]
    [--nobuild]
    [--device | --emulator | --target=<targetName>]
    [--buildConfig=<configfile>]
    [-- <platformOpts>]

Examples

• Run a release build of current cordova project on android platform emulator named Nexus_5_API_23_x86. Use the spcified build configuration when running:

    cordova run android --release --buildConfig=..\myBuildConfig.json --target=Nexus_5_API_23_x86
  

• Run a debug build of current cordova project on android platform using a device or emulator (if no device is connected). Skip doing the build:

    cordova run android --nobuild
  

• Run a debug build of current cordova project on an ios device:

    cordova run ios --device
  

• Enumerate names of all the connected devices and available emulators that can be used to run this app:

    cordova run ios --list
  

cordova emulate command

Synopsis

Alias for cordova run --emulator. Launches the emulator instead of device. See cordova run command docs for more details.

cordova clean command

Synopsis

Cleans the build artifacts for all the platforms, or the specified platform by running platform-specific build cleanup.

Syntax

cordova clean [<platform> [...]]

Example

• Clean android platform build artifacts:

    cordova clean android
  

cordova requirements command

Synopsis

Checks and print out all the requirements for platforms specified (or all platforms added to project if none specified). If all requirements for each platform are met, exits with code 0 otherwise exits with non-zero code.

This can be useful when setting up a machine for building a particular platform.

Syntax

cordova requirements android

cordova info command

Synopsis

Print out useful information helpful for submitting bug reports and getting help.

Syntax

cordova info

cordova serve command

Synopsis

Run a local web server for www/ assets using specified port or default of 8000. Access projects at: http://HOST_IP:PORT/PLATFORM/www

Syntax

cordova serve [port]

cordova telemetry command

Synopsis

Turns telemetry collection on or off.

Syntax

cordova telemetry [STATE]

Details

A timed prompt asking the user to opt-in or out is displayed the first time cordova is run. It lasts for 30 seconds, after which the user is automatically opted-out if he doesn't provide any answer. In CI environments, the CI environment variable can be set, which will prevent the prompt from showing up. Telemetry collection can also be turned off on a single command by using the --no-telemetry flag.

Examples

cordova telemetry on
cordova telemetry off
cordova build --no-telemetry

For details, see our privacy notice: https://cordova.apache.org/privacy

cordova help command

Synopsis

Show syntax summary, or the help for a specific command.

Syntax

cordova help [command]
cordova [command] -h
cordova -h [command]

cordova config command

Synopsis

Set, get, delete, edit, and list global cordova options.

Syntax

cordova config ls
cordova config edit
cordova config set <key> <value>
cordova config get <key>
cordova config delete <key>

Examples

cordova config set save-exact true