Herramienta de línea de comandos de Cordova (CLI) – Manual de referencia - Tutorial de Cordova

Este capítulo funciona como manual de referencia. No hace falta leerlo completo, solo consulta los apartados que necesites.

Sintaxis de la CLI

cordova <command> [opciones] -- [parámetros específicos de la plataforma]Lenguaje del código: CSS (css)

Lista de comandos globales

Se pueden ejecutar sin entrar al directorio del proyecto Cordova

Comando	Descripción
create	Crear un proyecto nuevo
help	Consultar la documentación de ayuda de un comando específico
config	Establecer, consultar, eliminar, editar y listar las opciones de configuración global de Cordova

Lista de comandos de proyecto

Deben ejecutarse desde el directorio raíz de un proyecto Cordova válido

Comando	Descripción
info	Mostrar información del entorno del proyecto
requirements	Comprobar y mostrar todas las dependencias necesarias para la plataforma seleccionada
platform	Gestionar las plataformas del proyecto (Android/iOS/Browser, etc.)
plugin	Gestionar los complementos del proyecto
prepare	Copiar archivos de recursos a los directorios de cada plataforma, preparando la compilación
compile	Compilar el proyecto para la plataforma indicada
build	Generar la aplicación (equivalente a prepare + compile)
clean	Eliminar archivos temporales generados durante la compilación de la plataforma
run	Ejecutar la aplicación (ejecuta internamente prepare + compile + despliegue y arranque)
serve	Iniciar un servidor web local para previsualizar los recursos web (ejecuta prepare internamente)

Opciones generales (compatibles con todos los comandos CLI)

Parámetro	Descripción
-d / –verbose	Mostrar registros detallados. Si invocas cordova-cli desde código Node, puedes escuchar los eventos `log` y `warn` para recibir los registros: `cordova.on('log', ()=>{})`
-v / –version	Mostrar la versión actual de la CLI de Cordova
–nohooks	Impedir la ejecución de scripts hook; permite filtrar hooks mediante expresiones regulares

Explicación de los parámetros específicos de plataforma

Algunos comandos aceptan parámetros personalizados por plataforma (platformOpts).
Se debe usar -- como separador: todo lo anterior a -- es interpretado por la CLI de Cordova, todos los parámetros después de -- se pasan directamente a las herramientas de compilación nativas de la plataforma correspondiente.

Ejemplos de uso de la CLI

Ejemplo de flujo de trabajo completo:

Crear el proyecto
Instalar el complemento de cámara
Añadir la plataforma Android
Compilar y ejecutar para Android
Generar paquete de lanzamiento con parámetros de firma de Android

# Crear proyecto
cordova create myApp com.foxdevelop.myApp myApp
cd myApp

# Añadir complemento de cámara
cordova plugin add cordova-plugin-camera

# Añadir plataforma Android
cordova platform add android

# Comprobar dependencias del entorno de compilación Android
cordova requirements android

# Compilar para Android (mostrar registros detallados)
cordova build android --verbose

# Ejecutar la app en dispositivo o emulador
cordova run android

# Generar paquete Release y pasar parámetros de firma
cordova build android --release -- --keystore="..\android.keystore" --storePassword=android --alias=mykeyLenguaje del código: PHP (php)

Descripción detallada de cada comando

cordova create

Crea la estructura de directorios de un proyecto Cordova.
Sintaxis:

cordova create path [identificador de paquete [nombre de la aplicación]] [opciones]Lenguaje del código: CSS (css)

Parámetros

Valor	Descripción
path	Carpeta del proyecto (no debe existir previamente, la CLI la crea automáticamente)
id	Identificador de paquete, valor por defecto: `org.apache.cordova.hellocordova` Formato de dominio invertido, coincide con el widget id de `config.xml`; se usa para generar el nombre de paquete Java, se recomienda configurarlo adecuadamente
name	Nombre visible de la aplicación, valor por defecto: `Hello Cordova` Coincide con el campo name de config.xml y se convierte en el nombre de clase del proyecto nativo

Opciones

--template: Crear proyecto usando una plantilla personalizada local, alojada en NPM o GitHub

cordova create myapp com.mycompany.myteam.myapp MyAppLenguaje del código: CSS (css)

cordova platform

Gestionar plataformas: añadir, eliminar, actualizar y listar. Al añadir o borrar plataformas se modifica el directorio platforms del proyecto.

cordova {platform | platforms} [
    add <especificación de plataforma> [...] {--save | link=<ruta> } |
    {remove | rm}  plataforma [...] {--save}|
    {list | ls}  |
    update ]Lenguaje del código: HTML, XML (xml)

Subcomandos y parámetros

Subcomando	Parámetro	Descripción
add <especificación de plataforma>		Añadir plataforma
	–nosave	No guardar la información de la plataforma en config.xml / package.json después de la instalación
	–link=	Crear enlace simbólico en lugar de copiar archivos al usar código fuente local de la plataforma (para desarrollo y depuración de plataformas)
remove <plataforma>		Eliminar plataforma
	–nosave	Eliminar la plataforma, pero no borrar el registro dentro de config.xml / package.json
update <plataforma>		Actualizar versión de la plataforma
	–save	Actualizar la versión registrada de la plataforma en config.xml
list / ls		Listar todas las plataformas instaladas y disponibles

Formato de especificación de plataforma `<platform-spec>`

plataforma[@número-versión] | ruta local | dirección Git[#rama/etiqueta/commit]Lenguaje del código: PHP (php)

platform: nombre de la plataforma android / ios / browser / electron
version: versión semántica semver, ejemplo ^13.0.0
path: directorio local con código fuente de la plataforma o archivo tar comprimido
url: dirección del repositorio Git
commit-ish: especificar rama, etiqueta o hash commit; si se omite se usa master por defecto

Plataformas soportadas

android、browser、electron、ios

# Añadir Android + iOS y guardar en archivos de configuración
cordova platform add android ios

# Añadir plataforma Android con versión específica
cordova platform add android@^13.0.0

# Instalar plataforma desde repositorio Git con una etiqueta determinada
cordova platform add https://github.com/myfork/cordova-android.git#13.0.0

# Instalar plataforma desde directorio local
cordova platform add ../android

# Eliminar plataforma Android
cordova platform rm android

# Consultar todas las plataformas
cordova platform lsLenguaje del código: PHP (php)

cordova plugin

Gestionar los complementos del proyecto

cordova {plugin | plugins} [
    add <especificación de complemento> [..] {--searchpath=<directorio> | --noregistry | --link | --save | --force} |
    {remove | rm} {<ID-complemento> | <nombre>} --save |
    {list | ls}
]Lenguaje del código: HTML, XML (xml)

Parámetros de subcomandos

Subcomando	Parámetro	Descripción
add <especificación de complemento>		Añadir complemento
	–searchpath <directorio>	Buscar complementos prioritariamente en este directorio; separador de múltiples rutas: `;` en Windows, `:` en Linux/Mac
	–noregistry	No descargar complementos desde el repositorio oficial npm
	–link	Crear enlace simbólico al instalar desde un directorio local de complemento (desarrollo y depuración de complementos)
	–nosave	No escribir entradas en config.xml / package.json
	–force	Forzar sobrescritura de archivos en conflicto (incorporado en versión 6.1)
remove		Eliminar complemento
	–nosave	Eliminar el complemento pero conservar el registro en los archivos de configuración
list / ls		Listar complementos instalados

Formato de especificación de complemento `<plugin-spec>`

[@scope/]ID-complemento[@versión] | directorio local | dirección Git[#commit][:subdirectorio]Lenguaje del código: PHP (php)

Orden de prioridad para resolver complementos (de mayor a menor)

Complemento y versión indicados explícitamente en la línea de comandos
Información de complementos guardada en config.xml / package.json
La última versión compatible con el proyecto disponible en npm (el package.json del complemento declara la dependencia de Cordova)
Última versión publicada del complemento en npm

# Instalar complementos de cámara y archivos, buscando primero en ../plugins
cordova plugin add cordova-plugin-camera cordova-plugin-file --searchpath ../plugins

# Instalar con versión específica
cordova plugin add cordova-plugin-camera@^2.0.0

# Instalar complemento desde directorio local
cordova plugin add ../cordova-plugin-camera

# Eliminar complemento
cordova plugin rm cordova-plugin-camera

# Listar complementos
cordova plugin lsLenguaje del código: PHP (php)

Información sobre conflictos de complementos

Algunos complementos modifican archivos de configuración nativos mediante la etiqueta edit-config de plugin.xml.
Si varios complementos intentan modificar el mismo nodo XML se produce un conflicto; la CLI bloquea la instalación por defecto.
Formas de solucionarlo:

Modificar el plugin.xml de los complementos para evitar que alteren el mismo nodo (recomendado)
Forzar la instalación con --force (⚠️ Riesgo: sobrescribe modificaciones de otros complementos y puede hacer que dejen de funcionar)

cordova prepare

Sincroniza la configuración de config.xml con los archivos manifiesto nativos de cada plataforma; copia iconos, pantallas de inicio y recursos de complementos, para que el proyecto cumpla los requisitos de compilación del SDK nativo.

cordova prepare [nombres-de-plataformas...]Lenguaje del código: CSS (css)

Si no se especifica ninguna plataforma, se procesan todas.

cordova compile

Ejecuta únicamente la compilación, no ejecuta prepare. Normalmente se usa directamente build, este comando se emplea principalmente en escenarios de extensión mediante hooks.

cordova compile [plataformas...]
    [--debug | --release]
    [--device | --emulator | --target=<nombre>]
    [--buildConfig=<archivo>]
    [-- parámetros-plataforma]Lenguaje del código: CSS (css)

cordova build

Equivale a prepare + compile y genera el paquete de aplicación.

cordova build [plataformas...]
    [--debug | --release]
    [--device | --emulator]
    [--buildConfig=<archivo-configuración>]
    [-- parámetros-plataforma]Lenguaje del código: CSS (css)

Parámetro	Descripción
–debug	Generar paquete de depuración
–release	Generar paquete de lanzamiento oficial
–device	Compilar paquete para dispositivo físico
–emulator	Compilar paquete adaptado a arquitecturas de emulador
–buildConfig	Especificar archivo de configuración de compilación, por defecto `build.json` en la raíz del proyecto, usado frecuentemente para ajustes de firma

cordova build android --release --buildConfig=build.json
cordova build android --release -- --keystore="app.keystore" --alias=key0Lenguaje del código: JavaScript (javascript)

cordova run

Ejecuta prepare → build, despliega la aplicación en dispositivo físico o emulador y la inicia.

cordova run [plataformas...]
    [--list | --debug | --release]
    [--noprepare]
    [--nobuild]
    [--device | --emulator | --target=<nombre>]
    [--buildConfig=<archivo>]
    [-- parámetros-plataforma]Lenguaje del código: CSS (css)

Parámetro	Descripción
–list	Listar todos los dispositivos físicos y emuladores disponibles
–noprepare	Saltar el paso prepare (versión 6.2 o superior)
–nobuild	Omitir la compilación y desplegar directamente el paquete existente
–target	Definir el nombre del emulador o dispositivo; consulta los nombres con `--list`

Ejemplos:

# Listar dispositivos
cordova run android --list
# Ejecutar en un emulador específico
cordova run android --target=Nexus_5_API_23_x86
# Ejecutar sin volver a compilar
cordova run android --nobuildLenguaje del código: PHP (php)

cordova emulate

Alias de cordova run --emulator, inicia la aplicación únicamente en un emulador.

cordova clean

Elimina todos los archivos temporales generados al compilar cada plataforma

cordova clean android

cordova requirements

Comprueba todas las dependencias de entorno necesarias para la plataforma (JDK, Android SDK, Xcode, etc.)

cordova requirements android

Devuelve el código de salida 0 si todas las dependencias están presentes, y un valor distinto si faltan. Se usa habitualmente para comprobaciones de entorno en compilaciones automáticas.

cordova info

Muestra toda la información del entorno, plataformas y complementos; indispensable al enviar informes de errores.

cordova info

cordova serve

Inicia un servidor web local para previsualizar los recursos web de la carpeta www, puerto por defecto 8000

cordova serve 8080
# Dirección de acceso: http://127.0.0.1:8080/android/wwwLenguaje del código: PHP (php)

cordova help

Consultar la ayuda de un comando

cordova help build
cordova build -h

cordova config

Gestionar la configuración global de Cordova

cordova config ls                # Listar todas las opciones de configuración
cordova config set save-exact true
cordova config get save-exact
cordova config delete save-exact
cordova config editLenguaje del código: PHP (php)

Herramienta de línea de comandos de Cordova (CLI) – Manual de referencia

Previous: Estructura de directorios

Next: Ejemplo de interfaz de app para aprender vietnamita