| Synopsis |
| |
| cordova command [options] |
| |
| Global Commands |
| |
| create <PATH> [ID [NAME [CONFIG]]] ....... creates a Cordova project in the specified PATH, with |
| ID reverse-domain-style package name - used in <widget id> |
| NAME is a human readable field |
| CONFIG is a json string whose key/values will be included |
| in [PATH]/.cordova/config.json |
| [--copy-from|src=<PATH>] ... use custom www assets instead of the stock Cordova hello-world. |
| [--link-to=<PATH>] ......... symlink to custom www assets without creating a copy. |
| |
| help ..................................... shows this syntax summary |
| |
| info ..................................... print out useful information helpful for submitting bug |
| reports and getting help. Creates an info.txt file at the |
| base of your project |
| |
| Project-Level Commands |
| |
| platform(s) [{add|remove|rm} <PLATFORM>] .. add or remove a specified PLATFORM, OR |
| [{list|ls}] ................... list all installed and available platforms |
| [{update|up} <PLATFORM>] ...... update the version of Cordova used for a specific |
| PLATFORM; use after updating the CLI. |
| [check] ....................... list platforms which can be updated by `platform update` |
| |
| plugin add <SPEC1> [<SPEC2> ...] .......... SPEC can be a plugin ID, a local path, or a git URL. |
| [--searchpath <directory>] ..... When looking up plugins by ID, look in this directory and |
| each of its subdirectories for the plugin before hitting the registry. |
| Multiple search paths can be used by either specifying the flag multiple |
| times, or by separating paths with a delimiter (: on 'nix, ; on Windows). |
| |
| plugin(s) rm <plugin_id1> [<plugin_id2>] .. remove a plugin with the given IDs. |
| |
| [{ls|list}] ..................... list all currently installed plugins |
| [search <keyword1 keyword2...>] . search the plugin registry for plugins matching the keywords |
| |
| prepare [PLATFORM..] ...................... copies files for specified platforms, or all platforms, |
| so that the project is ready to build in each SDK |
| |
| compile [PLATFORM..] ...................... builds the app for specified platforms, or all platforms |
| |
| build [PLATFORM...] ....................... shortcut for prepare, then compile |
| |
| run [--debug|--release] |
| [--device|--emulator|--target=FOO] |
| [PLATFORM] ............................ deploys app on specified platform devices / emulators |
| |
| emulate [PLATFORM...] ..................... alias for "run --emulator" |
| |
| serve [PORT] .............................. runs a local web server for www/ assets. Port defaults to 8000. |
| Access projects at: http://HOST_IP:PORT/PLATFORM/www |
| |
| Command-line Flags/Options |
| |
| -v, --version ............................. prints out this utility's version |
| -d, --verbose ............................. debug mode produces verbose log output for all activity, |
| including output of sub-commands cordova invokes |
| |
| Example usage |
| |
| $ cordova create Baz |
| $ cd Baz |
| $ cordova platform add android |
| $ cordova build |
| $ cordova serve android |
| |