Vega SDK CLI参考
Vega SDK具有命令行界面 (CLI),让您可以在终端中构建应用和运行虚拟设备。运行命令时,将所有占位符替换为实际值以防止错误。例如,将<应用名称>、<公司名称.应用名称>和<项目根目录>替换为您的应用名称、公司名称和项目目录路径。请勿使用amazon作为您的公司名称或程序包ID。
本页介绍Vega CLI命令和示例。
帮助选项
要浏览所有Vega命令的选项,可运行以下命令:
kepler --help
要获取有关特定命令的帮助,可运行以下命令:
kepler <命令> --help
例如,要查看kepler build命令的所有选项,可运行以下命令:
kepler build --help
常用命令
npx react-native build-kepler
使用npx react-native build-kepler命令来编译您的应用并生成vpkg。
要构建应用,可运行以下命令:
npm install
npx react-native build-kepler
kepler clean
要移除<项目根目录>/build文件夹中生成的工件,可运行以下命令:
kepler clean
kepler project list-templates
要查看可用于创建示例应用的可用JavaScript和Turbo模块模板,可运行以下命令:
kepler project list-templates
输出示例:
kepler project list-templates
Available templates:
idl-turbo-module: 与所有支持的React Native版本兼容并使用原生IDL API的Turbo模块
hello-world: 一个依赖于React Native v0.72的Vega应用
basic-turbo-module: 一个与所有支持的React Native版本兼容的Turbo模块
kepler project generate
要创建Vega项目,可使用带所需参数的kepler project generate命令。
要创建新应用,可运行以下命令:
kepler project generate --template hello-world --name "<应用名称>" --packageId "com.<公司名称>.<应用名称>" --outputDir "<应用名称>"
以下是命令中不同组件的明细:
-
kepler project generate- 使用此命令来生成Vega应用。 -
--template- Vega应用或Turbo模块模板的名称,您可以用kepler project list-templates命令找到该模板。在示例中,它使用了hello-world模板。 -
--name- 您的新应用或Turbo模块的名称。名称不能包含空格或特殊字符。将<应用名称>替换为所需的新应用名称。 -
--packageId- 适用于Vega的React Native应用中(而非Turbo模块中)所需manifest.toml的程序包ID。将<公司名称>替换为您的公司的名称,将<应用名称>替换为您的应用的名称。这将为新应用设置程序包ID。 -
--outputDir(可选)- 指定新应用文件的输出目录。将<应用名称>替换为您的应用的实际名称。
当您遵循此格式时,该命令会显示新项目的路径。
kepler run-kepler
要安装和运行您的应用,可运行以下命令:
kepler run-kepler <VPKG路径> <应用ID> -d <设备>
以下命令结合了kepler device install-app和kepler device launch-app。
对于VVD:
kepler run-kepler <VPKG路径> <应用ID> -d VirtualDevice
对于Fire TV:
kepler run-kepler <vpkg路径> <应用ID> -d <DSN>
例如,要在Mac M系列计算机上运行名为keplersampleapp的应用,可运行以下命令:
kepler run-kepler build/x86_64-release/keplersampleapp_aarch64.vpkg com.amazondeveloper.keplersampleapp.main -d VirtualDevice
设备命令
Vega CLI设备命令接口为您提供了一种与物理设备和Vega虚拟设备进行交互的方式。必须在路径上安装VDA并使其可用,设备命令才能起作用。
一般命令格式为:
kepler device <命令> [参数]
要查看所有可用的设备命令,可运行以下命令:
kepler device --help
kepler device copy-from
要将设备文件复制到主机计算机,可运行以下命令:
kepler device copy-from --device <设备名称> --source <文件或目录> --destination <文件或目录>
kepler device copy-logs
要从设备检索工件文件,可运行以下命令:
kepler device copy-logs --device <设备名称> --artifact <工件名称> --directory <文件的目录>
kepler device copy-to
要将主机文件复制到设备,可运行以下命令:
kepler device copy-to --device <设备名称> --source <文件或目录> --destination <文件或目录>
kepler device get-log-info
要从设备检索日志信息,可运行以下命令:
kepler device get-log-info --device <设备名称>
kepler device install
要在设备和模拟器上安装应用,可在应用程序包中添加路径参数 (-p)。The path follows this syntax: build/<架构>-<构建类型>/<应用名称>_<架构>.vpkg.
例如,如果keplersampleapp在Mac x86计算机上运行,可运行以下命令:
kepler device install-app -p build/x86_64-release/keplersampleapp_x86_64.vpkg --device <设备名称>
要自动在目录中找到正确的.vpkg并安装它,可运行以下命令:
kepler device install-app --dir .
要指定debug构建类型,可运行以下命令:
kepler device install-app --dir . -b Debug
要指定release构建类型,可运行以下命令:
kepler device install-app --dir . -b Release
kepler device installed-apps
要列出设备上安装的应用,可运行以下命令:
kepler device installed-apps --device <设备名称>
例如,要查看虚拟设备上安装的所有应用的列表,可运行以下命令:
kepler device installed-apps --device VirtualDevice
kepler device installed-packages
要列出设备上安装的所有程序包,可运行以下命令:
kepler device installed-packages --device <设备名称>
例如,要查看虚拟设备上安装的所有程序包的列表,可运行以下命令:
kepler device installed-packages --device VirtualDevice
kepler device is-app-installed
要使用应用名称检查应用是否已安装,可运行以下命令:
kepler device is-app-installed --device <设备名称> --appName <应用名称>
要使用项目目录检查应用是否已安装,可运行以下命令:
kepler device is-app-installed --device <设备名称> --directory <项目目录>
kepler device is-app-running
要使用应用名称检查应用是否在设备上运行,可运行以下命令:
kepler device is-app-running --device <设备名称> --appName <应用名称>
要使用项目目录检查应用是否在设备上运行,可运行以下命令:
kepler device is-app-running --device <设备名称> --directory <项目目录>
kepler device is-connected
要检查特定设备的连接状态,可运行以下命令:
kepler device is-connected --device <设备名称>
示例:
kepler device is-connected --device GXX2A1234567890A
连接时的输出:
Device GXX2A1234567890A is connected
未连接时的输出:
Device GXX2A1234567890A is not connected
kepler device launch-app
要使用应用名称在设备上启动应用,可运行以下命令:
kepler device launch-app --device <设备名称> --appName <应用名称>
要使用项目目录在设备上启动应用,可运行以下命令:
kepler device launch-app --device <设备名称> --directory <项目目录>
kepler device list
要列出连接的设备(Fire TV Stick和Vega虚拟设备),可运行以下命令:
kepler device list
Vega虚拟设备显示为: VirtualDevice : tv - architecture - OS type - hostname
连接Fire TV Stick (GXX2A1234567890A) 并运行虚拟设备时的输出示例:
GXX2A1234567890A : A1ZZ32RVTQ796E
VirtualDevice : tv - x86_64 - OS - amazon-ab123456cd789012
kepler device reboot
要重启给定设备,可运行以下命令:
kepler device reboot --device <设备名称>
kepler device run-cmd
要在特定设备上运行命令,可运行以下命令:
kepler device run-cmd --device <设备名称> --command '<要运行的命令>'
kepler device running-apps
要列出正在设备上运行的所有应用,可运行以下命令:
kepler device running-apps --device <设备名称>
例如,要查看在虚拟设备上运行的所有应用的列表,可运行以下命令:
kepler device running-apps --device VirtualDevice
kepler device shell
要在设备上启动shell会话,可运行以下命令:
kepler device shell --device <设备名称>
kepler device start-log-stream
要开始从设备流式传输日志,可运行以下命令:
kepler device start-log-stream --device <设备名称>
kepler device stop-log-stream
要停止从设备流式传输日志,可运行以下命令:
kepler device stop-log-stream --device <设备名称>
kepler device start-port-forwarding
要启动设备的正向或反向端口转发,可运行以下命令:
kepler device start-port-forwarding --device <设备名称> --port <端口号> --forward <true|false>
kepler device stop-port-forwarding
要停止设备的正向或反向端口转发,可运行以下命令:
kepler device stop-port-forwarding --device <设备名称> --port <端口号> --forward <true|false>
kepler device terminate-app
要使用应用名称终止设备上的应用,可运行以下命令:
kepler device terminate-app --device <设备名称> --appName <应用名称>
要使用项目目录终止设备上的应用,可运行以下命令:
kepler device terminate-app --device <设备名称> --directory <项目目录>
示例:
kepler device terminate-app --appName com.amazondeveloper.keplersampleapp.main --device VirtualDevice
// 输出
强制停止pkg: com.amazondeveloper.keplersampleapp
kepler device uninstall-app
要使用应用名称从设备上卸载应用,可运行以下命令:
kepler device uninstall-app --device <设备名称> --appName <应用名称>
要使用项目目录在设备上卸载应用,可运行以下命令:
kepler device uninstall-app --device <设备名称> --appName <应用名称> --directory <项目目录>
示例:
kepler device uninstall-app --appName com.amazondeveloper.keplersampleapp.main --device VirtualDevice
// 输出
Uninstalling 'com.amazondeveloper.keplersampleapp' ...success
Vega虚拟设备命令
kepler virtual-device status
要查找虚拟设备的状态,可运行以下命令:
kepler virtual-device status
kepler virtual-device start
要启动模拟器,可运行以下命令:
kepler virtual-device start
终端显示以下消息:
Launching default instance.
Waiting for virtual device to boot.
Launch process complete.
Virtual device shell available.
Virtual device ready.
kepler virtual-device stop
要停止模拟器,可运行以下命令:
kepler virtual-device stop
相关主题
Last updated: 2025年11月11日

