Справочник по интерфейсу командной строки 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. Do not use npm install to fetch.
  cordova plugin add cordova-plugin-camera --nofetch
  # Add camera plugin to the project and remember that in config.xml and package.json. Uses pre cordova@7 fetching methods instead of cordova-fetch which uses npm install under the hood.
  cordova plugin add cordova-plugin-camera --nofetch
  # Add android platform to the project and remember that in config.xml & package.json. Uses pre cordova@7 fetching methods instead of cordova-fetch which uses npm install under the hood
  cordova platform add android --nofetch
  # 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 с указанным 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> | --fetch } |
    {remove | rm}  platform [...] {--save | --fetch}|
    {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
• Браузер

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

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

Примеры

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

  cordova platform add android ios
  

• Добавить привязанную версию платформы android и ios и сохранить загруженную версию в config.xml и package.json. Не устанавливать в проект с помощью npm install и не хранить в каталоге приложений node_modules.

  cordova platform add android ios --nofetch
  

• Добавить платформу android с версией ^5.0.0 по semver и сохранить её в 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
  

• Удалить платформу android из проекта, не удаляя из config.xml и 'package.json. Не запускайте npm uninstall для удаления.

  cordova platform rm android --nosave --nofetch
  

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

  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 | --nofetch} |
    {remove | rm} {<pluginid> | <name>} --save --nofetch |
    {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. Сохранённый в config.xml и package.json plugin-spec, (т. е., если плагин был ранее добавлен без --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 с версией ^2.0.0 по semver и сохранить его в config.xml и package.json.

  cordova plugin add cordova-plugin-camera@^2.0.0
  

• Добавить cordova-plugin-camera с версией ^2.0.0 по semver и не npm install его. Он не будет сохранён в каталоге node_modules.

  cordova plugin add cordova-plugin-camera@^2.0.0 --nofetch
  

• Добавить плагин из указанного локального каталога.

  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
  

• Удалить плагин из проекта. Не удалять его из каталога node_modules и не запускать npm uninstall в скрытом режиме.

  cordova plugin rm camera --nofetch
  

• Вывести список всех установленных в проекте плагинов.

  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 экраны, копирует файлы плагинов для указанных платформ, чтобы проект был готов к сборке с помощью каждого native SDK.

Синтаксис

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

Опции

Команда 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
cordova config set fetch true