Cordova-Befehlszeilentool (CLI) – Referenzhandbuch - Cordova-Tutorial

Dieses Kapitel dient als Referenzhandbuch. Sie müssen es nicht vollständig durcharbeiten, schlagen Sie einfach nach, wenn Sie etwas benötigen.

CLI-Syntax

cordova <command> [Optionen] -- [plattformspezifische Parameter]Code-Sprache: CSS (css)

Liste der globalen Befehle

Können ohne Wechsel in das Cordova-Projektverzeichnis ausgeführt werden

Befehl	Beschreibung
create	Neues Projekt erstellen
help	Hilfedokumentation für einen bestimmten Befehl anzeigen
config	Globale Cordova-Einstellungen festlegen, abfragen, löschen, bearbeiten oder auflisten

Liste der Projektbefehle

Müssen im Stammverzeichnis eines gültigen Cordova-Projekts ausgeführt werden

Befehl	Beschreibung
info	Umgebungsinformationen des Projekts ausgeben
requirements	Alle benötigten Abhängigkeiten einer Plattform prüfen und anzeigen
platform	Projektplattformen verwalten (Android/iOS/Browser usw.)
plugin	Projektplugins verwalten
prepare	Ressourcendateien in die Plattformverzeichnisse kopieren, Vorbereitung für die Kompilierung
compile	Projekt für die angegebene Plattform kompilieren
build	Anwendung erstellen (entspricht prepare + compile)
clean	Zwischendateien bereinigen, die bei der Plattformkompilierung entstehen
run	Anwendung starten (interner Ablauf: prepare + compile + Bereitstellung und Start)
serve	Lokalen Webserver starten zur Vorschau der Web-Ressourcen (führt intern prepare aus)

Allgemeine Optionen (unterstützt von allen CLI-Befehlen)

Parameter	Beschreibung
-d / –verbose	Detaillierte Protokolle ausgeben. Wenn Sie cordova-cli aus Node-Code aufrufen, können Sie die Ereignisse `log` und `warn` abhören, um Logs zu empfangen: `cordova.on('log', ()=>{})`
-v / –version	Aktuelle Version der Cordova CLI anzeigen
–nohooks	Ausführung von Hook-Skripten unterbinden; Filterung von Hooks per regulärem Ausdruck möglich

Erläuterung zu plattformspezifischen Parametern

Einige Befehle unterstützen individuelle Plattformparameter (platformOpts).
Verwenden Sie -- als Trennzeichen: Alles vor -- wird von der Cordova CLI ausgewertet, sämtliche Parameter nach -- werden unverändert an die nativen Build-Tools der jeweiligen Plattform weitergereicht.

Beispiele für die CLI-Nutzung

Demonstration eines vollständigen Arbeitsablaufs:

Projekt erstellen
Kamera-Plugin installieren
Android-Plattform hinzufügen
Android kompilieren und ausführen
Erstellungsversion mit Android-Signaturparametern bauen

# Projekt erstellen
cordova create myApp com.foxdevelop.myApp myApp
cd myApp

# Kamera-Plugin hinzufügen
cordova plugin add cordova-plugin-camera

# Android-Plattform hinzufügen
cordova platform add android

# Abhängigkeiten für die Android-Kompilierung prüfen
cordova requirements android

# Android kompilieren (detaillierte Logausgabe)
cordova build android --verbose

# App auf Gerät oder Emulator starten
cordova run android

# Release-Version erstellen und Signaturparameter übergeben
cordova build android --release -- --keystore="..\android.keystore" --storePassword=android --alias=mykeyCode-Sprache: PHP (php)

Detaillierte Beschreibung aller Befehle

cordova create

Erstellt die Verzeichnisstruktur eines Cordova-Projekts.
Syntax:

cordova create Pfad [Paket-ID [App-Name]] [Optionen]Code-Sprache: CSS (css)

Parameter

Wert	Beschreibung
path	Projektordner (der Ordner darf nicht bereits existieren, die CLI erstellt ihn automatisch)
id	Paketkennung, Standardwert: `org.apache.cordova.hellocordova` Format umgekehrter Domainname, entspricht der widget-id aus `config.xml`; wird zur Generierung des Java-Paketnamens verwendet, sinnvolle Einstellung empfohlen
name	Angezeigter App-Name, Standardwert: `Hello Cordova` Entspricht dem Namensfeld in config.xml, wird zum Erstellen des Klassennamens des nativen Projekts genutzt

Optionen

--template: Projekt anhand einer lokalen, auf NPM oder GitHub gehosteten Vorlage erstellen

cordova create myapp com.mycompany.myteam.myapp MyAppCode-Sprache: CSS (css)

cordova platform

Verwaltet Plattformen: Hinzufügen, Entfernen, Aktualisieren und Auflisten. Das Hinzufügen oder Löschen einer Plattform verändert das Projektverzeichnis platforms.

cordova {platform | platforms} [
    add <Plattformangabe> [...] {--save | link=<Pfad> } |
    {remove | rm}  Plattform [...] {--save}|
    {list | ls}  |
    update ]Code-Sprache: HTML, XML (xml)

Unterbefehle und Parameter

Unterbefehl	Parameter	Beschreibung
add <Plattformangabe>		Plattform hinzufügen
	–nosave	Plattforminformationen nach der Installation nicht in config.xml / package.json schreiben
	–link=	Bei Nutzung lokaler Plattform-Quelltexte einen symbolischen Link erstellen statt Dateien zu kopieren (für Entwicklung und Debugging von Plattformen)
remove <Plattform>		Plattform entfernen
	–nosave	Plattform entfernen, Einträge in config.xml / package.json jedoch behalten
update <Plattform>		Plattformversion aktualisieren
	–save	Die in config.xml hinterlegte Plattformversion aktualisieren
list / ls		Alle installierten und verfügbaren Plattformen auflisten

Format der Plattformangabe `<platform-spec>`

Plattform[@Versionsnummer] | Lokaler Pfad | Git-Adresse[#Branch/Tag/Commit]Code-Sprache: PHP (php)

platform: Plattformname android / ios / browser / electron
version: Semantische Version semver, Beispiel ^13.0.0
path: Lokales Quellverzeichnis der Plattform oder tar-Archiv
url: Adresse eines Git-Repositories
commit-ish: Angabe von Branch, Tag oder Commit-Hash; Standardwert ist master, wenn nichts angegeben wird

Unterstützte Plattformen

android、browser、electron、ios

# Android und iOS hinzufügen und in Konfigurationsdateien speichern
cordova platform add android ios

# Android-Plattform mit festgelegter Version hinzufügen
cordova platform add android@^13.0.0

# Plattform aus Git-Repository anhand eines Tags installieren
cordova platform add https://github.com/myfork/cordova-android.git#13.0.0

# Plattform aus lokalem Verzeichnis installieren
cordova platform add ../android

# Android-Plattform entfernen
cordova platform rm android

# Alle Plattformen anzeigen
cordova platform lsCode-Sprache: PHP (php)

cordova plugin

Verwaltet die Plugins des Projekts

cordova {plugin | plugins} [
    add <Pluginangabe> [..] {--searchpath=<Verzeichnis> | --noregistry | --link | --save | --force} |
    {remove | rm} {<Plugin-ID> | <Name>} --save |
    {list | ls}
]Code-Sprache: HTML, XML (xml)

Parameter der Unterbefehle

Unterbefehl	Parameter	Beschreibung
add <Pluginangabe>		Plugin hinzufügen
	–searchpath <Verzeichnis>	Zuerst in diesem Ordner nach Plugins suchen; Pfadtrennzeichen: `;` unter Windows, `:` unter Linux/Mac
	–noregistry	Plugin nicht aus dem offiziellen npm-Repository laden
	–link	Beim Installieren aus einem lokalen Pluginordner einen symbolischen Link erstellen (Entwicklung und Debugging von Plugins)
	–nosave	Keine Einträge in config.xml / package.json erstellen
	–force	Konfliktierende Dateien zwangsweise überschreiben (neu ab Version 6.1)
remove		Plugin entfernen
	–nosave	Plugin entfernen, Eintrag in Konfigurationsdateien aber beibehalten
list / ls		Installierte Plugins auflisten

Format der Pluginangabe `<plugin-spec>`

[@scope/]Plugin-ID[@Version] | Lokales Verzeichnis | Git-Adresse[#commit][:Unterverzeichnis]Code-Sprache: PHP (php)

Priorität bei der Pluginauflösung (absteigend)

Auf der Befehlszeile explizit festgelegtes Plugin mit Version
In config.xml / package.json gespeicherte Plugin-Informationen
Neueste auf npm verfügbare Version, die mit dem Projekt kompatibel ist (Plugin-package.json deklariert Cordova-Abhängigkeit)
Neueste veröffentlichte Version des Plugins auf npm

# Kamera- und Datei-Plugin installieren, Suche zuerst in ../plugins
cordova plugin add cordova-plugin-camera cordova-plugin-file --searchpath ../plugins

# Mit festgelegter Version installieren
cordova plugin add cordova-plugin-camera@^2.0.0

# Plugin aus lokalem Ordner installieren
cordova plugin add ../cordova-plugin-camera

# Plugin entfernen
cordova plugin rm cordova-plugin-camera

# Pluginliste anzeigen
cordova plugin lsCode-Sprache: PHP (php)

Hinweise zu Plugin-Konflikten

Einige Plugins ändern native Konfigurationsdateien mittels edit-config aus der Datei plugin.xml.
Wenn mehrere Plugins denselben XML-Knoten bearbeiten wollen, entsteht ein Konflikt. Die CLI blockiert die Installation standardmäßig.
Mögliche Lösungen:

plugin.xml der Plugins anpassen, damit nicht derselbe Knoten verändert wird (empfohlen)
Installation mit --force erzwingen (⚠️ Risiko: Änderungen anderer Plugins werden überschrieben, diese können dadurch ausfallen)

cordova prepare

Synchronisiert die Einstellungen aus config.xml in die nativen Manifestdateien jeder Plattform; kopiert Icons, Splash-Screens und Plugin-Ressourcen, damit das Projekt den Voraussetzungen für die Kompilierung mit dem nativen SDK genügt.

cordova prepare [Plattformnamen...]Code-Sprache: CSS (css)

Wird keine Plattform angegeben, werden alle verarbeitet.

cordova compile

Führt ausschließlich die Kompilierung aus, prepare wird nicht ausgeführt. Üblicherweise nutzt man direkt build, dieser Befehl ist vor allem für Erweiterungen mittels Hooks gedacht.

cordova compile [Plattformen...]
    [--debug | --release]
    [--device | --emulator | --target=<Name>]
    [--buildConfig=<Datei>]
    [-- Plattformparameter]Code-Sprache: CSS (css)

cordova build

Entspricht prepare + compile und erstellt das App-Paket.

cordova build [Plattformen...]
    [--debug | --release]
    [--device | --emulator]
    [--buildConfig=<Konfigurationsdatei>]
    [-- Plattformparameter]Code-Sprache: CSS (css)

Parameter	Beschreibung
–debug	Debug-Version erstellen
–release	Erstellungsversion für den Vertrieb erstellen
–device	Paket für ein physisches Gerät erstellen
–emulator	Paket für Emulator-Architekturen erstellen
–buildConfig	Angabe einer Build-Konfigurationsdatei, Standard ist `build.json` im Projektstamm; häufig für Signatureinstellungen genutzt

cordova build android --release --buildConfig=build.json
cordova build android --release -- --keystore="app.keystore" --alias=key0Code-Sprache: JavaScript (javascript)

cordova run

Führt prepare → build aus, stellt die Anwendung auf Gerät oder Emulator bereit und startet sie anschließend.

cordova run [Plattformen...]
    [--list | --debug | --release]
    [--noprepare]
    [--nobuild]
    [--device | --emulator | --target=<Name>]
    [--buildConfig=<Datei>]
    [-- Plattformparameter]Code-Sprache: CSS (css)

Parameter	Beschreibung
–list	Alle verfügbaren Geräte und Emulatoren auflisten
–noprepare	Schritt prepare überspringen (ab Version 6.2)
–nobuild	Kompilierung überspringen, vorhandenes Installationspaket direkt bereitstellen
–target	Name eines Emulators oder Geräts festlegen, Namen lassen sich mit `--list` abfragen

Beispiele:

# Geräte auflisten
cordova run android --list
# Auf einem bestimmten Emulator starten
cordova run android --target=Nexus_5_API_23_x86
# Ohne erneute Kompilierung starten
cordova run android --nobuildCode-Sprache: PHP (php)

cordova emulate

Alias für cordova run --emulator, startet die Anwendung ausschließlich auf einem Emulator.

cordova clean

Bereinigt alle Zwischendateien, die bei der Kompilierung der Plattformen erstellt werden

cordova clean android

cordova requirements

Prüft alle benötigten Umgebungsabhängigkeiten einer Plattform (JDK, Android SDK, Xcode usw.)

cordova requirements android

Bei vorhandenen Abhängigkeiten wird Exit-Code 0 zurückgegeben, fehlende Abhängigkeiten ergeben einen anderen Wert. Wird häufig zur Umgebungsprüfung in automatisierten Builds eingesetzt.

cordova info

Gibt vollständige Informationen zur Umgebung, den Plattformen und Plugins aus; unverzichtbar für das Einreichen von Fehlerberichten.

cordova info

cordova serve

Startet einen lokalen Webserver zur Vorschau der Web-Ressourcen im www-Ordner, Standardport ist 8000

cordova serve 8080
# Aufrufadresse: http://127.0.0.1:8080/android/wwwCode-Sprache: PHP (php)

cordova help

Hilfe zu einem Befehl anzeigen

cordova help build
cordova build -h

cordova config

Verwaltet die globalen Einstellungen von Cordova

cordova config ls                # Alle Einstellungen auflisten
cordova config set save-exact true
cordova config get save-exact
cordova config delete save-exact
cordova config editCode-Sprache: PHP (php)

Cordova-Befehlszeilentool (CLI) – Referenzhandbuch

Previous: Verzeichnisstruktur

Next: Beispiel für Oberfläche einer Vietnamesisch‑Lern‑App