CLI工具参考 (VSK Echo Show)

警告： 不会将新的合作伙伴引入视频技能工具包 (VSK)。如果对现有集成有疑问，请联系您的亚马逊技术客户经理。

Alexa视频基础架构CLI工具支持一组命令，可加快Echo Show的视频技能开发。

支持的命令

`./dist/bin/alexa-video-infrastructure-cli --init`

初始化项目并提示用户输入以下信息：

Project Name是项目的名称（主要用于命名创建的云资源）
Skill Name是要创建的Alexa技能的名称
Path to project root是包含参考Lambda (./lambda) 和参考网页播放器 (./web-player) 代码的目录的绝对路径。
ASK security profile client id是与您的ASK安全配置文件关联的客户端ID
ASK security profile client secret是与您的ASK安全配置文件关联的客户端密钥
AWS Access Key是与您的AWS IAM用户关联的AWS访问密钥
AWS Secret Access Key是与您的AWS IAM用户关联的AWS访问密钥
Authorization Code访问提示的网站，该网站将要求您登录，然后向您发放一次性授权代码。此代码将生成OAuth访问令牌和刷新令牌。该令牌用于验证您的Alexa开发者账户以进行API调用。它最终会过期，而如果发生该情况，系统将提示您创建新令牌。
Vendor Id如果您的ASK账户关联了多个供应商ID，则系统会额外提示您选择要申请的那一个。您可以随时从开发者控制台上的此页面检索此数据。

请注意，CLI工具会将信息存储在您的本地计算机上：

在~/.aws下有一个文件，其中存储了您的AWS凭证。
在~/.ask下有一个文件，其中存储了您的ASK oauth令牌。
文件<在其中运行cli的目录>/.project-config.json存储项目级信息以及您的ASK客户端ID和ASK客户端密钥。

`./dist/bin/alexa-video-infrastructure-cli --deploy`

运行此命令一次即可首次创建技能。对于给定的Project Name，只能运行--deploy命令一次。如果命令失败，您可以运行--delete命令，然后重新运行--deploy命令，但请注意，这样将删除您的技能。如果您想更新网页播放器或Lambda，您可以分别运行--update --web-player或--update --lambda命令。

通过部署/更新技能可执行以下操作：

创建工件堆栈
开始在后台复制示例视频内容
在本地构建参考Lambda和网页播放器程序包
将新构建的Lambda和网页播放器上传到S3
创建Lambda CloudFormation堆栈
通过上传技能清单创建Alexa技能
配置账户关联和技能触发器

按照以下流程查看您新创建的技能：

打开Alexa开发者控制台。
单击您的技能以查看或更新您的设置。

`./dist/bin/alexa-video-infrastructure-cli --delete`

删除整个技能、所有数据、S3存储桶等。

`./dist/bin/alexa-video-infrastructure-cli --update --lambda`

这只会更新Lambda：

在本地构建Lambda
将其上传到S3
更新Lambda源代码

`./dist/bin/alexa-video-infrastructure-cli --update --web-player`

这只会更新网页播放器。它在本地构建网页播放器并将其上传到S3存储桶。

提示： 您可能需要等待大约5分钟才能看到设备上网页播放器的变化。如果重启设备，则可以更快地看到变化。

`./dist/bin/alexa-video-infrastructure-cli --skill --enable-web-player-logs`

您无权访问网页播放器生成的日志，因为该播放器是在设备上运行。通过运行此命令，您的网页播放器将其日志写入AWS CloudWatch日志。您可以在AWS控制台的CloudWatch日志部分查看您的日志。这些日志位于以您的Project Name命名的日志组中。

提示： 只适合在开发期间启用此日志记录，因为在生产环境中您可能会产生更多成本。对于生产环境，请确保禁用日志记录。

`./dist/bin/alexa-video-infrastructure-cli --skill --disable-web-player-logs`

禁止网页播放器将其日志写入AWS CloudWatch日志。

提示： 建议在生产环境中禁用CloudWatch日志，因为在生产环境中您可能会产生更多成本。

`./dist/bin/alexa-video-infrastructure-cli --status`

获取已部署资源的状态。

`./dist/bin/alexa-video-infrastructure-cli --version`

显示CLI工具的版本。

`./dist/bin/alexa-video-infrastructure-cli --help`

显示所有可用的命令和描述。

开发

使用基础架构CLI工具进行开发时，请遵循以下指南：

使用<项目根目录>/infrastructure文件夹。
运行npm run watch。
当您进行更改时，将自动构建基础架构CLI工具的代码。
在./dist/bin/alexa-video-infrastructure-cli下测试更改。

Last updated: 2020年10月29日