1.语法:
cordova <command> [options] -- [platformOpts]
2.全局命令列表
命令 | 描述 |
---|---|
create | 创建一个项目 |
help | 获取命令的帮助 |
3.项目命令列表
当前工作目录是有效的Cordova项目时,支持这些命令。(cordova <command> [option])
命令 | 描述 |
---|---|
info | 生成项目信息 |
requirements | 检查并打印出指定平台的所有安装要求 |
platform | 管理项目平台 |
plugin | 管理项目插件 |
prepare | 将文件复制到平台上进行构建 |
compile | 建立平台 |
clean | 从构建工件清理项目 |
run | 运行项目(包括准备&&编译) |
serve | 用本地网络服务器运行项目(包括准备) |
这些选项适用于所有cordova-cli命令。
选项 | 描述 |
---|---|
d or --verbose
| 将更详细的输出发送到您的shell。如果您正在通过调用或作为节点模块使用,您还可以订阅
|
-v or --version | 打印出你的
|
--no-update-notifier | 将禁用更新检查。或者 设置
|
--nohooks | 禁止执行钩子(以RegExp钩子模式作为参数)
|
这个例子演示了如何使用cordova-cli来创建一个camera
插件项目并运行它的android
平台。具体而言,--keystore
可以提供特定于平台的选项:
# 创建一个科尔多瓦项目
cordova create myApp com.myCompany.myApp myApp
cd myApp
# 将相机插件添加到项目中,并记在config.xml中
cordova plugin add cordova-plugin-camera --save
#将android平台添加到项目中,并记在config.xml中
cordova platform add android --save
#检查您的系统是否配置为构建android平台
cordova requirements android
# 构建android并发出详细的日志
cordova build android --verbose
# 在android平台上运行项目
cordova run android
# 使用指定的签名参数在发布模式下构建android平台。
cordova build android --release -- --keystore="..\android.keystore" --storePassword=android --alias=mykey
目录结构
myapp/
|-- config.xml
|-- hooks/
|-- www/
|-- platforms/
| |-- android/
| |-- windows/
| |-- ios/
|-- plugins/
|--cordova-plugin-camera/
5.创建命令
管理cordova平台 - 允许您添加,删除,更新,列出和检查更新。运行命令来添加或删除平台会影响项目的平台目录的内容。
cordova {platform | platforms} [
add <platform-spec> [...] {--save | link=<path> } |
{remove | rm} platform [...] |
{list | ls} |
check |
save ]
例子:
-
添加的固定版本
android
和ios
平台,并保存下载的版本到config.xml
:cordova platform add android ios --save
-
使用android 5.0.0版本 添加平台并将其保存到
config.xml
:cordova platform add android@^5.0.0 --save
-
通过克隆指定的git仓库添加平台cordova-android4.0版本
cordova platform add https://github.com/myfork/cordova-android.git#4.0.0
-
使用本地目录名为android添加平台:
cordova platform add ../android
-
使用指定的tarball添加平台:
cordova platform add ../cordova-android.tgz
-
从项目及config.xml中删除android平台:
cordova platform rm android --save
-
列出安装的可用平台版本号。报告问题时,查找版本号很有用:
cordova platform ls
-
保存当前添加到项目中的所有平台的版本
config.xml
。cordova platform save
cordova {plugin | plugins} [
add <plugin-spec> [..] {--searchpath=<directory> | --noregistry | --link | --save | --browserify | --force} |
{remove | rm} {<pluginid> | <name>} --save |
{list | ls} |
search [<keyword>] |
save |
]
例子:
-
添加
cordova-plugin-camera
和
cordova-plugin-file
保存到项目及config.xml中
。使用../plugins
目录搜索插件。cordova plugin add cordova-plugin-camera cordova-plugin-file --save --searchpath ../plugins
-
添加cordova-plugin-camera^2.0.0
版本并保存到config.xml
:cordova plugin add cordova-plugin-camera@^2.0.0 --save
-
克隆指定的git仓库,检出版本
2.1.0
,在plugin
目录中查找plugin.xml ,并将其添加到项目中。保存plugin-spec
到config.xml
:cordova plugin add https://github.com/apache/cordova-plugin-camera.git#2.1.0:plugin --save
-
从指定的本地目录添加插件:
cordova plugin add ../cordova-plugin-camera
-
从指定的tarball文件添加插件:
cordova plugin add ../cordova-plugin-camera.tgz --save
-
从项目及config.xml中删除该插件:
cordova plugin rm camera --save
-
列出安装在项目中的所有插件:
cordova plugin ls
7.cordova 构建命令
cordova build [<platform> [...]]
[--debug|--release]
[--device|--emulator]
[--buildConfig=<configfile>]
[--browserify]
[-- <platformOpts>]
选项 | 描述 |
---|---|
<platform> [..] | 要构建的平台名称。如果没有指定,所有的平台都建立了。 |
--debug | 执行调试版本。这通常转换为正在构建的底层平台的调试模式。 |
- release | 执行发布版本。这通常转换为正在构建的底层平台的发布模式。 |
- device | 建立一个设备 |
--emulator | 建立一个模拟器。特别注意:平台体系结构可能与设备Vs仿真器不同。 |
--buildConfig =<configFile> | 默认:cordova根目录下的build.json。 使用指定的构建配置文件。 build.json 文件用于指定参数,以自定义与签署软件包相关的应用程序生成过程。 |
--browserify | 在编译时使用browserify而不是运行时编译插件JS |
<platformOpts> | 要提供平台特定的选项,您必须在-- 分隔符后包含它们。查看平台指南文档了解更多详情。 |
例子:
-
为设备部署
android
和windows
平台搭建debug调试模式
:cordova build android windows --debug --device
-
android
在release
模式下为平台构建并使用指定的构建配置:cordova build android --release --buildConfig=..\myBuildConfig.json
-
构建android平台的发布模式,并将自定义平台选项参数传递给android构建过程:
cordova build android --release -- --keystore="..\android.keystore" --storePassword=android --alias=mykey
8.cordova 运行命令
选项 | 描述 |
---|---|
<platform> [..] | 要运行的平台名称。如果未指定,则运行所有平台。 |
--list | 列出可用的目标。除非指定,否则显示设备和仿真器部署目标 |
--debug | 部署一个调试版本。这是默认的行为,除非--release 被指定。 |
- release | 部署发布版本 |
--noprepare | 跳过准备(可用于Cordova v6.2或更高版本) |
--nobuild | 跳过建设 |
- device | 部署到设备 |
--emulator | 部署到模拟器 |
- target | 部署到特定的目标模拟器/设备。使用--list 可显示目标选项 |
--buildConfig =<configFile> | 默认:cordova根目录下的build.json。 使用指定的构建配置文件。 build.json 文件用于指定参数,以自定义与签署软件包相关的应用程序生成过程。 |
--browserify | 在编译时使用browserify而不是运行时编译插件JS |
<platformOpts> | 要提供平台特定的选项,您必须在-- 分隔符后包含它们。查看平台指南文档了解更多详情。 |
-
在
android
平台模拟器上运行当前cordova项目的发布版本Nexus_5_API_23_x86
。运行时使用特定版本配置:cordova run android --release --buildConfig=..\myBuildConfig.json --target=Nexus_5_API_23_x86
-
使用设备或仿真器在平台上运行当前cordova项目的调试版本(如果没有设备连接)。跳过构建:
cordova run android --nobuild
-
在
ios
设备上运行当前cordova项目的调试版本:cordova run ios --device
-
枚举可用于运行此应用程序的所有连接设备和可用模拟器的名称:
cordova run ios --list
cordova help [command] 帮助信息
cordova info 打印出有用的信息有助于提交错误报告并获得帮助。在项目的底部创建一个info.txt文件
cordova run --emulator 启动模拟器而不是设备、
检查并打印出指定平台的所有需求(如果没有指定,则将所有平台添加到项目中)。如果满足每个平台的所有要求,则以代码0退出,否则以非零代码退出。这在设置用于构建特定平台的机器时非常有用。
cordova requirements android
cordova clean [<platform> [...]] 通过运行特定于平台的构建清理,清除指定平台或所有平台的构建工件。