<APPNAME>``com.<COMPANY NAME>.<APPNAME>、和<projectroot>替换为您的应用程序名称、软件包 ID 和项目目录路径。请勿使用amazon作为您的公司名称或程序包ID。
本页阐述了Vega CLI命令和示例。
帮助和版本选项
要打印已安装的Vega CLI版本:vega -v。报告问题时需包含此版本,并在CI管道中通过此版本确认构建所用的CLI。要查看项目构建时所用的SDK版本,请参阅管理SDK版本。
要浏览所有Vega命令的选项:
vega build命令的所有选项,请执行以下操作:
安装命令
vega setup-studio
当你在 SDK 安装过程中跳过 Vega Studio 扩展时,使用vega setup-studio它来安装它,或者重新安装它。此命令目前未在中列出vega --help,因此可以在此参考中找到它。
kepler setup-studio表格是等效的。
要在 SDK 安装过程中跳过 Vega Studio 之后再进行安装,请执行以下操作:
退出代码和错误输出
Vega CLI命令成功时返回退出代码00,失败时返回非零退出代码。错误消息会写入stderrstderr。
常用命令
以下命令涵盖构建、清理、创建和运行应用程序。npx react-native build-vega
使用该npx react-native build-vega命令编译您的应用程序并生成.vpkg文件。
要构建应用,可运行以下命令:
vega clean
要移除在<projectroot>/build文件夹中生成的构件,请执行以下操作:
vega project list-templates
要查看可用于创建示例应用的可用JavaScript和Turbo模块模板,可运行以下命令:vega project generate
要创建 Vega 项目,请使用带有所需参数的vega project generate命令。
要创建新应用,可运行以下命令:
-
vega project generate-生成 Vega 应用程序。 -
--template-设置 Vega 应用程序或 Turbo 模块模板,您可以从vega project list-templates命令中找到该模板。在示例中,它使用helloWorld模板。 -
--name- 您的新应用或Turbo模块的名称。名称不能包含空格或特殊字符。将<APPNAME>替换为所需的新应用名称。 -
--packageId-在中设置软件包 IDmanifest.toml。Vega 应用程序的 React Native 是必需的,而不是 Turbo 模块。<COMPANY NAME>替换为贵公司的名称<APPNAME>和应用程序的名称。 -
--outputDir(可选)-为新应用文件设置输出目录。将<APPNAME>替换为您的应用的实际名称。
vega run-app
要安装和运行您的应用,可运行以下命令:-d是… 的缩写形式--deviceId。这些vega device命令--device用于相同的值。
该vega run-app命令将vega device install-app和vega device launch-app命令组合在一起。应用程序 ID 是可选的。如果你省略它,该命令会安装应用程序,但不会启动它。
对于VVD:
sampleappsampleapp的应用,可运行以下命令:
项目兼容性命令
vega projectvega project兼容性命令负责管理应用支持的操作系统版本。这些命令可解析兼容的程序包版本、将项目重新对齐到操作系统版本目标、验证配置,[os.version]并重新生成清单模块条目。有关这些命令背后的概念,请参阅操作系统目标版本。有关每个 SDK 版本支持的 React Native、操作系统和主机组合,请参阅版本兼容性矩阵。
vega project install
要将与操作系统版本兼容的软件包版本@amazon-devices/*解析为:package.json
install既不install --fix下载软件包也不要更改node_modules文件夹。两者均能解析兼容版本并将其写入package.jsonpackage.json。两者的作用域不同:
-
vega project install <packages..>-如果所有兼容性检查均通过,则将命名@amazon-devices/*包package.json作为依赖项添加到中。只有此形式可新增依赖项。 -
vega project install --fix-将所有现有@amazon-devices/*版本重新调整package.json到兼容性清单配置文件中。此形式不会新增程序包。
--os-version和时--rn-version,该命令将从项目的manifest.toml和package.json中读取它们。两者兼--fix而有之,--dry-run默认为关闭。
--os-min是写入manifest.toml而不是写入的一个选项package.json,而且它比其他选项更窄:
-
仅在搭配
--fix—fix使用时生效。既不是空写vega project install --fix也不是install <package>跑着写min。 -
把它传递给我
--os-version。在一个没有[os.version]分区的项目上,install无法解析目标,因此它会失败Missing OS Version并且什么也没写入。 -
使用
--fix``--os-min、并在没有[os.version]分区的项目--os-version上install创建分区、设置min和target进行确认📝 Set [os.version] min = "<v>" in manifest.toml。 -
如果
[os.version]已经存在,则此表单min仅写入并target保持不变。旧版[os][os] 部分可用作现有部分。要更改targettarget,请运行vega project update-manifest。
vega project doctor之后运行是可选的,但建议使用。install --fix解析版本,doctor验证结果并运行源代码级操作系统版本 lint。有关详细信息,请参阅vega project doctor。
使用--dry-run,该命令无需写入更改即可预览解析的内容,标题变成。🔍 Dry run — no changes will be made
vega project update
要将项目中的npm程序包与清单重新对齐到操作系统版本目标:updateupdate仅重新对齐您应用当前依赖的程序包版本。此操作会将这些程序包逐一升级到可兼容操作系统目标的版本,其余程序包则保持不变。要新增依赖项,请执行vega project install。
两者均为可选项。当你省略它们时,该命令会读--os-min取--os-version和读--rn-version出你的项目package.json,--dry-run默认为关闭。manifest.toml
两者都
update``install --fix将现有@amazon-devices/*版本重新调整package.json到兼容性清单配置文件中,并且都接受--os-version和--os-min。install --fix用于正常设置和重新调整流程,以及创建尚不存在的[os.version]部分。如果想在写入更改项之前先预览更改计划,可使用updateupdate,因为--dry-run—dry-run会逐一报告程序包的版本变化。
例如,要预览针对manifest.tomlmanifest.toml中目标版本的重新对齐效果:
🔄🔄图标表示程序包已更改,✓✓图标则表示程序包未更改。当没有任何需要更改时,该命令会报告✅ All packages are up to date。
vega project doctor
要验证项目操作系统版本的兼容性,包括配置、依赖项和lint规则:doctordoctor会运行以下检查项:
- SDK兼容性清单已存在。
- 项目配置已解析。
-
[os.version].min并且[os.version].target都是有效的铸造操作系统版本。 -
[os.version].min小于或等于[os.version].target。 -
您的
@amazon-devices/*依赖项版本与兼容性清单配置文件相匹配。 -
源级操作系统版本 lint 规则通过:
no-unguarded-os-api、no-removed-api和。warn-deprecated-api
no-unguarded-os-api规则都会报告错误[os.version].min。当引用位于isPresentOnOS()警卫内部或在导入之前的行中带有// @os-version-ok注释时,引用就会通过。该规则报告的是使用位置,而非import行。该no-removed-api规则会报告错误,以供参考在当天或之前删除的 API min。该warn-deprecated-api规则会报告警告,提及之前[os.version].target已弃用的 API。
输出示例:
min是1.2、target是2.0。lint No OS version issues 之所以报告,是因为之后引入的每个 API 都min受到保护。如果你的代码引用了在min没有保护的情况下引入的 API,lint 会标记所有这样的引用。它像下面缩进file:line:column rule-id的消息一样报告每一个,摘要变为非零❌ 1 check(s) failed.,然后doctor退出。
在结果中,✅✅图标表示检查通过,⚠️⚠️表示警告,❌❌则表示失败。如有任何严重级别为“失败”的检查项未通过,vega project doctorvega project doctor会以非零状态退出,因此可将其用作CI管道中的门禁。有关更多信息,请参阅将Vega SDK集成到CI管道中。
vega project update-manifest
要在中设置[os.version]值,请执行manifest.toml以下操作:
[os.version]部分,即min和target值。它不写入模块条目。该版本从中生成操作系统版本模块条目 (/com.amazon.vega.os@IVega_<v>) [os.version]。它将它们连同您的@amazon-devices/*软件包条目一起写入验证、暂存和打包清单。
每次运行时,该命令还会从您的源代码中移除工具拥有的模块条目。manifest.toml其中包括保留/com.amazon.vega.os@IVega_*系列中的操作系统版本模块条目。它们还包括版本标识@amzn/<pkg>@<version>和@amazon-devices/<pkg>@<version>模块 ID。您为其他系统模块声明的模块条目会被保留。在使用较早版本的 SDK 创建的项目上,第一次运行会将这些行从源代码控制的清单中删除。这种差异是预料之中的。提交,不要手动恢复条目。
当你通过命令行传递操作系统版本时,将两者
--os-min``--os-version一起传递。同时省略两者时,命令会从manifest.toml中读取这两个参数。
例如,要为目标和需要 OS 2.0 的项目添加分[os.version]区,这是 SDK 2.0 的推荐设置:
min和target版本,并列出它从清单中删除的所有工具拥有的模块条目。
--os-min 1.2。有关选择的帮助,请参阅 Ch oose min 。
如果该命令删除了工具拥有的条目,它还会报告 🧹 Removed tool-owned [[needs.module]]/[[wants.module]] entries from manifest.toml. With--dry-run,它会报告它将写入和删除的内容,并且不做任何更改。有关清单字段定义以及编译版本如何生成模块条目,请参阅清单 [os.version] 部分。有关needs和wants的更多信息,请参阅清单 [needs] 部分和清单 [wants] 部分。
设备命令
Vega CLI设备命令接口为您提供了一种与物理设备和Vega虚拟设备进行交互的方式。要使设备命令起作用,请安装 V ega 设备适配器 (VDA) 并将其添加到您的路径中。 一般命令格式为:vega device copy-from
要将设备文件复制到主机计算机,可运行以下命令:vega device copy-logs
要从设备检索工件文件,可运行以下命令:--artifact值使用表单artifact/provider``system/var_log。该--dir值是主机计算机上要将文件复制到的目录。
vega device copy-to
要将主机文件复制到设备,可运行以下命令:vega device get-log-info
要从设备检索日志信息,可运行以下命令:vega设备信息
要检索 JSON 格式的设备元数据,请执行以下操作:vega device install-app
要在设备或 VVD 上安装应用程序,请传递.vpkg路径和-p。路径遵循以下模式:build/<ARCH>-<BUILD_TYPE>/<APP_NAME>_<ARCH>.vpkg
例如,要在 Mac x86 计算机sampleapp上安装:
.vpkg.vpkg并安装它,可运行以下命令:
debug编译类型,请执行以下操作:
release编译类型,请执行以下操作:
vega device installed-apps
要列出设备上安装的应用,可运行以下命令:vega device installed-packages
要列出设备上安装的所有程序包,可运行以下命令:vega device is-app-installed
要使用应用名称检查应用是否已安装,可运行以下命令:vega device is-app-running
要使用应用程序名称检查应用程序是否正在设备上运行,请执行以下操作:vega device is-connected
要检查特定设备的连接状态,可运行以下命令:vega device launch-app
要使用应用名称在设备上启动应用,可运行以下命令:vega device list
要列出已连接的设备(Fire TV Stick和VVD):VirtualDevice : tv - architecture - OS type - hostname
以下示例显示了连接的 Fire TV Stick (GXXXXXXXXXXXXXX) 和正在运行的 VVD。
输出示例:

