Справочник по командной строке Cordova (CLI)

Синтаксис

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

Список глобальных команд

Эти команды доступны всегда.

Список команд для проекта

Эти команды поддерживаются, когда текущий рабочий каталог является корректным проектом Cordova.

Общие параметры

Эти параметры применяются ко всем командам cordova-cli.

Параметры, специфичные для платформы

У определенных команд есть параметры (platformOpts), специфичные для конкретной платформы. Они могут быть переданы в cordova-cli с разделителем '--', который останавливает разбор команды внутри модуля cordova-lib и передает оставшиеся параметры для обработки платформами.

Примеры

• В этом примере показано, как cordova-cli можно использовать для создания проекта с плагином camera и запуском его на платформе android. В частности, можно использовать параметры, специфичные для платформы, такие как --keystore.

  # 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 camera plugin to the project and remember that in config.xml and 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

Краткое описание

Создаёт структуру каталогов для проекта Cordova в указанном пути.

Синтаксис

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

Параметры

Структура каталогов

Cordova CLI работает со следующей структурой каталогов:

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

config.xml

Настраивает ваше приложение и позволяет настроить поведение вашего проекта. См. также документацию по config.xml

www/

Содержит веб-артефакты проекта, такие как файлы .html, .css и .js. Как разработчик Cordova, большая часть вашего кода и ресурсов будет здесь. Они будут скопированы при каждой cordova prepare в директорию www каждой платформы. Исходный каталог www воспроизведён внутри каждого подкаталога платформы, например, в platforms/ios/www или platforms/android/assets/www. Поскольку CLI постоянно копирует файлы из исходной папки www, вам следует редактировать только эти файлы, а не файлы, расположенные в подкаталогах платформ. Если вы используете систему контроля версий, вы должны добавить этот исходный каталог www, а также каталог merges, в систему контроля версий.

platforms/

Содержит весь исходный код и скрипты сборки для платформ, которые вы добавляете в свой проект.

ПРЕДУПРЕЖДЕНИЕ: При использовании CLI для сборки приложения, не следует изменять файлы в каталоге /platforms/, если вы не знаете, что делаете, или если документация не указывает иного. Файлы в этом каталоге регулярно перезаписываются при подготовке приложений к сборке или при повторной установке плагинов.

plugins/

Все добавленные плагины будут извлечены или скопированы в этот каталог.

hooks/

Этот каталог может содержать скрипты, используемые для настройки команд cordova-cli. Любые скрипты, которые вы добавите в эти каталоги, будут выполнены до и после команд, соответствующих имени каталога. Полезно для интеграции собственных систем сборки или интеграции с системами контроля версий.

Для получения дополнительной информации обратитесь к Руководству по хукам.

merges/

Платформо-специфические веб-ресурсы (файлы HTML, CSS и JavaScript) содержатся в соответствующих подкаталогах в этом каталоге. Они развертываются во время prepare в соответствующий каталог нативной платформы. Файлы, размещённые в merges/, перекроют соответствующие файлы в каталоге www/ для соответствующей платформы. Пример, предполагая структуру проекта:

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

После сборки Android и iOS проектов, Android приложение будет содержать как app.js, так и android.js. Однако iOS приложение будет содержать только app.js, и это будет тот, что из merges/ios/app.js, перекрывая "общий" app.js, расположенный внутри www/.

Система контроля версий

Не рекомендуется включать каталоги platforms/ и plugins/ в систему контроля версий, так как они считаются артефактами сборки. Ваши платформы и плагины будут сохранены в config.xml и package.json автоматически. Эти платформы/плагины будут загружены при вызове cordova prepare.

Примеры

• Создайте проект Cordova в директории myapp с указанным идентификатором и именем для отображения:

  cordova create myapp com.mycompany.myteam.myapp MyApp
  

• Создайте проект Cordova с символической ссылкой на существующую www директорию. Это может быть полезно, если у вас есть собственный процесс сборки или существующие веб-ресурсы, которые вы хотите использовать в приложении Cordova:

  cordova create myapp --link-to=../www
  

Команда cordova platform

Краткое описание

Управление платформами Cordova — добавление, удаление, обновление, просмотр и проверка обновлений. Выполнение команд по добавлению или удалению платформ влияет на содержимое каталога platforms проекта.

Синтаксис

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

Спецификация платформы

Существует несколько способов указать платформу:

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

Поддерживаемые платформы

• Android
• iOS
• Windows (8.1, Phone 8.1, UWP — Windows 10)
• Blackberry10
• Ubuntu
• Browser

Устаревшие платформы

• Amazon-fireos (используйте платформу Android вместо этого)
• WP8 (используйте платформу Windows вместо этого)
• Windows 8.0 (используйте более старые версии cordova)
• Firefox OS (используйте более старые версии cordova)

Примеры

• Добавьте закреплённую версию платформы android и ios и сохраните загруженную версию в config.xml и package.json:

  cordova platform add android ios
  

• Добавьте платформу android с версией semver ^5.0.0 и сохраните её в config.xml и package.json:

  cordova platform add android@^5.0.0
  

• Добавьте платформу, клонировав указанный git репозиторий и переключив ветку на тэг 4.0.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
  

• Удалите платформу android из проекта и удалите её из config.xml и package.json:

  cordova platform rm android
  

• Удалите платформу android из проекта, но не удаляйте её из config.xml и package.json:

  cordova platform rm android --nosave
  

• Отобразить доступные и установленные платформы с номерами версий. Это полезно для поиска номеров версий при сообщении об ошибках:

  cordova platform ls
  

• Сохраните версии всех платформ, в настоящее время добавленных в проект, в config.xml и package.json

  cordova platform save
  

команда cordova plugin

Краткое описание

Управление плагинами проекта

Синтаксис

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

Описание плагина

Существует несколько способов указать плагин:

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

Алгоритм разрешения плагинов

При добавлении плагина в проект, CLI разрешит плагин, основываясь на следующих критериях (в порядке убывания приоритета):

1. Указанный plugin-spec в команде (например, cordova plugin add pluginID@version)
2. Сохранённая plugin-spec в config.xml и package.json (т.е. если плагин был ранее добавлен без --nosave)
3. Начиная с версии Cordova 6.1, последняя опубликованная версия плагина в npm, которую может поддерживать текущий проект (применимо только к плагинам, которые перечисляют свои зависимости Cordova в своём package.json)
4. Последняя опубликованная версия плагина в npm

Примеры

• Добавьте cordova-plugin-camera и cordova-plugin-file в проект и сохраните его в config.xml и package.json. Используйте директорию ../plugins для поиска плагинов.

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

• Добавьте cordova-plugin-camera с версией semver ^2.0.0 и сохраните её в config.xml и package.json:

  cordova plugin add cordova-plugin-camera@^2.0.0
  

• Добавьте плагин из указанной локальной директории:

  cordova plugin add ../cordova-plugin-camera
  

• Добавьте плагин из указанного файла tarball:

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

• Удалите плагин из проекта и config.xml и package.json:

  cordova plugin rm camera
  

• Удалите плагин из проекта, но не удаляйте его из config.xml или package.json:

  cordova plugin rm camera --nosave
  

• Отобразить все установленные в проекте плагины:

  cordova plugin ls
  

Конфликтующие плагины

Конфликтующие плагины могут возникнуть при добавлении плагинов, которые используют теги edit-config в файле plugin.xml. edit-config позволяет плагинам добавлять или заменять атрибуты XML элементов.

Эта функция может вызвать проблемы с приложением, если более одного плагина пытается изменить один и тот же XML элемент. Введена проверка на конфликты, чтобы предотвратить добавление плагинов, если один плагин пытается перезаписать изменения другого плагина в edit-config. При обнаружении конфликта в edit-config будет выброшено исключение, и плагин не будет добавлен. В сообщении об ошибке будет указано, что все конфликты необходимо разрешить, прежде чем плагин можно будет добавить. Одним из способов разрешения конфликта edit-config является внесение изменений в plugin.xml соответствующих плагинов, чтобы они не изменяли один и тот же XML элемент. Другой вариант - использовать флаг --force для принудительного добавления плагина. Этот вариант следует использовать с осторожностью, поскольку он игнорирует проверку на конфликты и перезапишет все конфликты с другими плагинами, тем самым может оставить другие плагины в плохом состоянии.

Обратитесь к руководству plugin.xml для управления edit-config, разрешения конфликтов и примеров.

команда cordova prepare

Краткое описание

Преобразует метаданные config.xml в платформенно-специфичные файлы манифеста, копирует значки и splash экраны, копирует файлы плагинов для указанных платформ, чтобы проект был готов к сборке с каждой нативной SDK.

Синтаксис

cordova prepare [<platform> [..]]
     [--browserify]

Опции

команда cordova compile

Краткое описание

cordova compile - это подмножество команды cordova build. Она выполняет только этап компиляции без подготовки. Обычно вызывается cordova build вместо этой команды - однако, эта стадия полезна для расширения с помощью плагинов.

Синтаксис

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

Для подробной документации см. документацию по команде cordova build ниже.

команда cordova build

Краткое описание

Сокращение для cordova prepare + cordova compile для всех/указанных платформ. Позволяет собрать приложение для указанной платформы.

Синтаксис

cordova build [<platform> [...]]
    [--debug|--release]
    [--device|--emulator]
    [--buildConfig=<configfile>]
    [--browserify]
    [-- <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
  

команда cordova run

Краткое описание

Подготавливает, собирает и развёртывает приложение на указанных платформах устройствах/эмуляторах. Если подключено устройство, оно будет использовано, если не запущен подходящий эмулятор.

Синтаксис

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

Примеры

• Запуск релизной сборки текущего проекта cordova на эмуляторе платформы android с именем Nexus_5_API_23_x86. Используйте указанную конфигурацию сборки при выполнении:

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

• Запуск отладочной сборки текущего проекта cordova на платформе android с использованием устройства или эмулятора (если устройство не подключено). Пропустить сборку:

  cordova run android --nobuild
  

• Запуск отладочной сборки текущего проекта cordova на устройстве ios.

  cordova run ios --device
  

• Перечислить имена всех подключенных устройств и доступных эмуляторов, которые могут быть использованы для запуска этого приложения:

  cordova run ios --list
  

Команда cordova emulate

Синтаксис

Псевдоним для cordova run --emulator. Запускает эмулятор вместо устройства. Для получения дополнительной информации см. документацию по команде cordova run.

Команда cordova clean

Синтаксис

Очищает артефакты сборки для всех платформ или для указанной платформы, выполняя очистку сборки конкретной платформы.

Синтаксис

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

Пример

• Очистка артефактов сборки платформы android.

  cordova clean android
  

Команда cordova requirements

Синтаксис

Проверяет и выводит все требования для указанных платформ (или для всех платформ, добавленных в проект, если не указано ничего) . Если все требования для каждой платформы выполнены, завершается с кодом 0, в противном случае завершается с ненулевым кодом.

Это может быть полезно при настройке машины для сборки конкретной платформы.

Синтаксис

cordova requirements android

Команда cordova info

Синтаксис

Выводит полезную информацию, которая полезна для отправки отчетов об ошибках и получения помощи. Создает файл info.txt в корне вашего проекта.

Синтаксис

cordova info

Команда cordova serve

Синтаксис

Запускает локальный веб-сервер для ресурсов www/ с использованием указанного port или значения по умолчанию 8000. Доступ к проектам по адресу: http://HOST_IP:PORT/PLATFORM/www.

Синтаксис

cordova serve [port]

Команда cordova telemetry

Синтаксис

Включает или отключает сборку телеметрии.

Синтаксис

cordova telemetry [STATE]

Детали

При первом запуске cordova отображается временный запрос к пользователю, предлагающий выбрать включение или отключение телеметрии. Он длится 30 секунд, после чего пользователь автоматически отключается от телеметрии, если не предоставит ответа. В средах непрерывной интеграции (CI) переменная среды CI может быть установлена, что предотвратит показ запроса. Сбор телеметрии также можно отключить для отдельной команды, используя флаг --no-telemetry.

Примеры

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

Для получения более подробной информации ознакомьтесь с нашим уведомлением о конфиденциальности: https://cordova.apache.org/privacy

Команда cordova help

Синтаксис

Показать сводку синтаксиса или справку по определённой команде.

Синтаксис

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

Команда cordova config

Синтаксис

Установить, получить, удалить, изменить и перечислить глобальные опции cordova.

Синтаксис

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

Примеры

cordova config set autosave false
cordova config set browserify false