開発者コンソール

CLIツールリファレンス


CLIツールリファレンス

Alexa Video Infrastructure 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アクセストークンとリフレッシュトークンが生成されます。このトークンは、API呼び出しでAlexa開発者アカウントを認証するために使用します。最終的にはトークンの有効期限が切れるため、有効期限が切れた際は、新しいトークンの作成を促されます。
  • Vendor Id:ASKアカウントに複数のベンダーIDが関連付けられている場合は、適用するベンダーIDの選択を求めるプロンプトが追加で表示されます。このデータは、開発者コンソールのこのページでいつでも確認できます。

CLIツールは、ローカルコンピューターに情報を格納することに注意してください。

  • ~/.awsには、AWSの認証情報が格納されているファイルがあります。
  • ~/.askには、ASK OAuthトークンが格納されているファイルがあります。
  • <CLIの実行ディレクトリ>/.project-config.jsonには、プロジェクトレベルの情報と、ASKクライアントIDおよびASKクライアントシークレットが格納されます。

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

このコマンドは、スキルを初めて作成するときに1度実行してください。特定のProject Nameに対して、--deployコマンドは一度しか実行できません。コマンドが失敗した場合は、--deleteコマンドを実行すると、--deployコマンドを再度実行できますが、これによってスキルが削除されることに注意してください。--update --web-playerコマンドまたは--update --lambdaコマンドを実行すると、ウェブプレーヤーまたはLambda関数をそれぞれ更新できます。

スキルのデプロイまたは更新では、以下の処理が実行されます。

  • アーティファクトスタックを作成する
  • バックグラウンドでサンプルビデオコンテンツのコピーを開始する
  • ローカルで参照Lambda関数および参照ウェブプレーヤーのパッケージをビルドする
  • 新しくビルドされたLambda関数とウェブプレーヤーをS3にアップロードする
  • Lambda CloudFormationスタックを作成する
  • スキルマニフェストをアップロードしてAlexaスキルを作成する
  • アカウントリンクとスキルトリガーを構成する

新しく作成したスキルを表示するには、以下の手順に従います。

  1. Alexa開発者コンソールを開きます。
  2. 作成したスキルをクリックして、設定を表示または更新します。

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

スキル全体のほか、すべてのデータ、S3バケットなどを削除します。

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

Lambda関数だけを以下のように更新します。

  • Lambda関数をローカルでビルドする
  • ビルドされたLambda関数をS3にアップロードする
  • Lambda関数のソースコードを更新する

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

ウェブプレーヤーだけを更新します。ウェブプレーヤーをローカルでビルドし、S3バケットにアップロードします。

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

ウェブプレーヤーによるログの生成はデバイス上で実行されるため、生成されたログに直接アクセスすることはできません。このコマンドを実行すると、ウェブプレーヤーはログをAWS CloudWatch Logsに書き込みます。これらのログは、AWSコンソールのCloudWatch Logsのセクションで確認できます。ログは、Project Nameに基づく名前が付けられたロググループにあります。

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

ウェブプレーヤーがAWS CloudWatch Logsにログを書き込めないようにします。

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

デプロイされたリソースのステータスを取得します。

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

CLIツールのバージョンを表示します。

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

使用可能なすべてのコマンドと説明を表示します。

開発

Alexa Video Infrastructure CLIツールを使用して開発する場合は、以下のガイドラインに従ってください。

  • <プロジェクトのルート>/infrastructureフォルダを使用します。
  • npm run watchを実行します。
  • 変更を加えると、Alexa Video Infrastructure CLIツールのコードが自動的にビルドされます。
  • ./dist/bin/alexa-video-infrastructure-cliで変更内容をテストします。