Lightbuild CLI 参考文档

Lightbuild CLI 是 Lightbuild 的官方命令行工具。本页面介绍了其命令和选项。如需安装 Lightbuild CLI，请参阅安装 Lightbuild CLI。如需了解常见任务（例如构建和测试项目），请参阅从命令行构建 Lightbuild 项目。

语法

Lightbuild CLI 使用以下语法：

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

它支持以下全局选项：

选项 说明
-V、--version 输出版本信息并退出。
-p、--project=path 项目的绝对路径。默认为当前目录，该目录必须包含一个项目。

如需列出可用命令，请运行 lightbuild help。如需获取有关特定命令的帮助，请运行 lightbuild help [command]。

lightbuild build

在项目中构建目标。

lightbuild build [target]
参数值 说明
target 要构建的目标。默认为当前目录下的所有目标。

例如，如需构建 app 模块，请运行以下命令：

lightbuild build app

如需构建项目中的所有目标，请运行以下命令：

lightbuild build

lightbuild clean

移除项目的 build 输出和缓存。

lightbuild clean [target]
参数值 说明
target 要清理的目标。默认为当前目录下的所有目标。

例如，如需移除整个项目的 build 输出和缓存，请运行以下命令：

lightbuild clean

lightbuild help

列出可用命令，或显示特定命令的帮助信息。

lightbuild help [COMMAND]
参数值 说明
COMMAND 要显示其帮助信息的命令。默认为所有命令。

如需列出可用于项目的命令，请运行以下命令：

lightbuild help

如需显示特定命令（例如 query）的帮助，请运行以下命令：

lightbuild help query

lightbuild query

列出与项目模块中的模式匹配的 build 目标、生成的输出文件或源代码集。

lightbuild query [target-pattern] [--format=format] [--output=type]
选项或实参 说明
target-pattern 目标路径模式，例如 ... 或 app。
--format=format 输出格式，例如 json。默认值为表。
--output=type 输出的格式：files 表示匹配目标生成的文件所在的位置，sourcesets 表示其源代码集，sourceset_types 表示其源代码集的类型。

如需列出项目中的所有目标，请运行以下命令：

lightbuild query ...

如需输出 app 目标生成的文件所在的位置，请运行以下命令：

lightbuild query app --output=files

lightbuild resolve

解析项目的外部依赖项，并为其模块生成离线依赖项锁定文件 (resolved.deps)。

lightbuild resolve [--cache=path] [--locked-dependencies] [target]
选项或实参 说明
target 要解析其依赖项的模块，例如 app。默认为当前目录下的所有目标。
--locked-dependencies 如果本地依赖项锁定文件 (resolved.deps) 不同步，则会退出并显示错误。
--cache=path 用于存储依赖项缓存的目录。

例如，如需为项目中的所有模块生成 resolved.deps 文件，请运行以下命令：

lightbuild resolve

如需详细了解 resolved.deps 文件，请参阅已解析的依赖项。

lightbuild test

运行项目中的测试：在开发机器上运行的本地测试，以及在已连接的设备或正在运行的模拟器上运行的插桩测试。如需测试一个模块，请指定其目标，例如 app-core。如需仅运行一种类型的测试，请向目标添加 :hostTest（对于本地测试）或 :deviceTest（对于插桩测试）。

lightbuild test [target] [--locked-dependencies]
选项或实参 说明
target 要测试的目标。默认为项目中的所有测试。
--locked-dependencies 如果本地依赖项锁定文件 (resolved.deps) 不同步，则构建失败。

例如，如需运行项目中的所有测试，请运行以下命令：

lightbuild test

如需在 app-core 模块中运行本地测试，请运行以下命令：

lightbuild test app-core:hostTest

如需在设备或模拟器上运行 app-core 模块中的插桩测试，请运行以下命令：

lightbuild test app-core:deviceTest