Referencia de la CLI de Lightbuild

La CLI de Lightbuild es la herramienta de línea de comandos oficial de Lightbuild. En esta página, se describen sus comandos y opciones. Para instalar la CLI de Lightbuild, consulta Instala la CLI de Lightbuild. Para realizar tareas comunes, como compilar y probar tu proyecto, consulta Cómo compilar proyectos de Lightbuild desde la línea de comandos.

Sintaxis

La CLI de Lightbuild usa la siguiente sintaxis:

lightbuild [-V] [--project=path] [COMMAND]

Admite las siguientes opciones globales:

Opción Descripción
-V, --version Imprime la información de la versión y finaliza.
-p, --project=path Es la ruta de acceso absoluta a tu proyecto. La configuración predeterminada es el directorio actual, que debe contener un proyecto.

Para enumerar los comandos disponibles, ejecuta lightbuild help. Para obtener ayuda con un comando específico, ejecuta lightbuild help [command].

lightbuild build

Compila un destino en tu proyecto.

lightbuild build [target]
Argumento Descripción
target Es el destino que quieres compilar. La configuración predeterminada es todos los destinos que se encuentran debajo del directorio actual.

Por ejemplo, para compilar el módulo app, ejecuta lo siguiente:

lightbuild build app

Para compilar todos los destinos de tu proyecto, ejecuta lo siguiente:

lightbuild build

lightbuild clean

Quita el resultado de la compilación y las memorias caché de tu proyecto.

lightbuild clean [target]
Argumento Descripción
target Es el destino que se limpiará. La configuración predeterminada es todos los destinos que se encuentran debajo del directorio actual.

Por ejemplo, para quitar el resultado de la compilación y las memorias caché de todo el proyecto, ejecuta lo siguiente:

lightbuild clean

lightbuild help

Enumera los comandos disponibles o muestra la ayuda para un comando específico.

lightbuild help [COMMAND]
Argumento Descripción
COMMAND Es el comando para el que se muestra la ayuda. De forma predeterminada, se aplica a todos los comandos.

Para enumerar los comandos que están disponibles para tu proyecto, ejecuta lo siguiente:

lightbuild help

Para mostrar la ayuda de un comando específico, como query, ejecuta lo siguiente:

lightbuild help query

lightbuild query

Enumera los destinos de compilación, los archivos de salida generados o los conjuntos de orígenes que coinciden con un patrón en los módulos de tu proyecto.

lightbuild query [target-pattern] [--format=format] [--output=type]
Opción o argumento Descripción
target-pattern Es el patrón de ruta de acceso de destino, por ejemplo, ... o app.
--format=format El formato de salida, por ejemplo, json. La configuración predeterminada es una tabla.
--output=type Es el formato del resultado: files para las ubicaciones de los archivos que producen los destinos coincidentes, sourcesets para sus conjuntos de orígenes o sourceset_types para los tipos de sus conjuntos de orígenes.

Para enumerar todos los destinos de tu proyecto, ejecuta el siguiente comando:

lightbuild query ...

Para imprimir las ubicaciones de los archivos que produce el destino app, ejecuta lo siguiente:

lightbuild query app --output=files

lightbuild resolve

Resuelve las dependencias externas de tu proyecto y genera los archivos de bloqueo de dependencias sin conexión (resolved.deps) para sus módulos.

lightbuild resolve [--cache=path] [--locked-dependencies] [target]
Opción o argumento Descripción
target Es el módulo para el que se resolverán las dependencias, por ejemplo, app. La configuración predeterminada es todos los destinos que se encuentran debajo del directorio actual.
--locked-dependencies Se cierra con un error si el archivo de bloqueo de dependencias local (resolved.deps) no está sincronizado.
--cache=path Es el directorio en el que se almacenará la caché de dependencias.

Por ejemplo, para generar los archivos resolved.deps de todos los módulos de tu proyecto, ejecuta lo siguiente:

lightbuild resolve

Para obtener más información sobre los archivos resolved.deps, consulta Dependencias resueltas.

lightbuild test

Ejecuta las pruebas de tu proyecto: las pruebas locales, que se ejecutan en tu máquina de desarrollo, y las pruebas de instrumentación, que se ejecutan en un dispositivo conectado o en un emulador en ejecución. Para probar un módulo, especifica su destino, como app-core. Para ejecutar solo un tipo de prueba, agrega :hostTest para las pruebas locales o :deviceTest para las pruebas de instrumentación al destino.

lightbuild test [target] [--locked-dependencies]
Opción o argumento Descripción
target Es el destino que se probará. La configuración predeterminada incluye todas las pruebas de tu proyecto.
--locked-dependencies Falla la compilación si el archivo de bloqueo de dependencias local (resolved.deps) no está sincronizado.

Por ejemplo, para ejecutar todas las pruebas de tu proyecto, ejecuta lo siguiente:

lightbuild test

Para ejecutar las pruebas locales en el módulo app-core, ejecuta lo siguiente:

lightbuild test app-core:hostTest

Para ejecutar las pruebas de instrumentación en el módulo app-core en un dispositivo o emulador, ejecuta lo siguiente:

lightbuild test app-core:deviceTest