Справочник по командной строке 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, большая часть вашего кода и ресурсов будет находиться здесь. Они будут скопированы при каждой сборке на www директории каждой платформы. Директория www исходного кода воспроизводится в каждой поддиректории платформы, например, в platforms/ios/www или platforms/android/assets/www. Поскольку CLI постоянно копирует файлы из исходной папки www, вы должны редактировать только эти файлы, а не файлы, находящиеся в поддиректориях платформ. Если вы используете систему управления версиями, вы должны добавить эту исходную папку www, а также папку merges в систему управления версиями.

platforms/

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

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

plugins/

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

hooks/

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

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

merges/

Платформенно-специфичные веб-активы (файлы HTML, CSS и JavaScript) содержатся в соответствующих подпапках в этом каталоге. Они развертываются во время сборки в соответствующие каталоги родной платформы. Файлы, размещенные в 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 с указанным ID и именем приложения:

  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)
• Браузер
• Electron

Примеры

• Добавить закреплённую версию платформы 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 | --force} |
    {remove | rm} {<pluginid> | <name>} --save |
    {list | ls} |
    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 (т.е. если плагин был ранее добавлен без --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> [..]]

Опции

Команда cordova compile

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

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

Синтаксис

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

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

Команда cordova build

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

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

Синтаксис

cordova build [<platform> [...]]
    [--debug|--release]
    [--device|--emulator]
    [--buildConfig=<configfile>]
    [-- <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>]
    [-- <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/ assets, используя указанный порт 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