クイックスタート: Alexa Skills Kitコマンドラインインターフェース(ASK CLI)



クイックスタート: Alexa Skills Kitコマンドラインインターフェース(ASK CLI)

Alexa Skills Kitコマンドラインインターフェース(ASK CLI)は、Alexaスキル、および連携するAWS Lambda関数を管理するためのツールです。ASK CLIを使ってスキル管理APIにアクセスすると、コマンドラインからコードベースでAlexaスキルの管理ができるようになります。

ASK CLIの概要ビデオ

ステップ1: ASK CLIの使用要件

ASK CLIをインストールする前に、次の前提条件を満たしていることを確認してください。

  1. Amazon開発者アカウント。サインアップは無料です。
  2. Node.jsおよびnpm。Node.jsに付属しています。ASK CLIが要求するのはNode.jsバージョン6以上ですが、Node.jsの現行リリースまたはアクティブなLTSバージョンを使用することをお勧めします。Node.jsをインストールまたは更新する方法については、Node.jsのダウンロードページを参照してください。Node.jsの使用バージョンを確認するには、コマンドプロンプトからnode --versionと入力します。
  3. Git。Gitリポジトリのテンプレートからスキルをクローンします。GitのドキュメントでGitのインストールを参照してください。

ステップ2: AWS IAMユーザーのセットアップ

スキルのバックエンドロジックのホスティングにAWS Lambdaを使用する場合は、AWSの認証情報が必要です。AWS認証情報がセットアップされており、ASK CLIをインストールするコンピューターに適切な権限があることを確認します。詳細については、 AWS認証情報を作成するを参照してください。

AWS Lambdaを使用していない場合は、スキルで独自のエンドポイントを指定できます。ASK CLIは引き続きスキルのモデルの管理に使用できます。

ステップ3: ASK CLIのインストールと初期化

npmを使用してASK CLIをインストールします。

ASK CLIをインストールするには以下の手順を実行します。

  • インストールは、管理者またはスーパーユーザーとして実行する必要がある場合があります。Windowsでは、管理者として実行オプションを使用してPowerShellを開きます。LinuxまたはmacOSでは、sudoを使用します。
  • コマンドプロンプトを開いて、npm install -g ask-cliと入力します。

既にASK CLIがインストールされており、最新のバージョンに更新する場合は、新規ユーザーと同じ方法でインストールします。

ASK CLIの初回使用時には、AmazonおよびAWS認証情報でask initコマンドを使ってASK CLIを初期化する必要があります。詳細については、initコマンドを参照してください。ask initコマンドはASKプロファイルに名前を付け、使用するAWSプロファイルを選択するようユーザーに指示します。その後ブラウザが開き、Amazon開発者アカウントにサインインできます。ブラウザがインストールされていないコンピューターを使用している場合は、ask init --no-browserコマンドを使用して初期化を完了できます。初期化が完了すると、スキルの管理にASK CLIを使用できるようになります。

ステップ4: ASK CLIコマンドを使ったスキル管理

次のコマンドを実行すると、スキルを管理する基本機能が使えるようになります。ASK CLIで利用可能なすべてのコマンドを確認するには、ASK CLIリファレンスを参照してください。

ASK CLIを使用してスキルプロジェクトを設定するには、新しいスキルプロジェクトを作成するを参照してください。

スキル内課金を管理するコマンドについては、スキル内商品コマンドリファレンスを参照してください。

ask new
このコマンドを使用して、テンプレートから新しいスキルプロジェクトを作成できます。新しく作成されたスキルプロジェクトのフォルダには必要なファイルがすべて含まれており、最小限の変更でデプロイが可能です。詳細については、新しいスキルプロジェクトを作成するを参照してください。
ask deploy
スキルプロジェクトのディレクトリでこのコマンドを使用すると、スキルが開発者アカウントにデプロイされます。AWS認証情報が既にセットアップされており、スキルがAWS Lambdaを使用するよう設定されている場合、このコマンドでスキルコードも自動的にデプロイされます。詳細については、スキルプロジェクトを開発中ステージにデプロイするを参照してください。
ask clone
このコマンドを使用して、ローカルスキルプロジェクトのディレクトリを作成します。次に、開発ステージからローカルディレクトリに既存のスキルをクローンします。このコマンドは、スキルのマニフェスト、対話モデル、スキルコード(AWS Lambdaを使用する場合)を含むスキルのすべての部分をダウンロードします。クローン作成後、ローカルで変更を加えてからask deployコマンドを使用して簡単にデプロイできます。詳細については、cloneコマンドを参照してください。

ステップ5: スキルのテスト

ask deployコマンドは、デプロイしたスキルを自動的に有効にします。これにより、デバイスですぐにテストを開始したり、ask simulateコマンドの使用を開始したりできます。開発者コンソールのテストページにあるAlexaシミュレーターを使うこともできます。

スキルのデプロイ後、スキルの作成を続けるにつれてローカルバージョンやリモートバージョンができることがあります。プロジェクトのローカルバージョンとリモートバージョンを比較するには、ask diffコマンドを使用します。ローカルでの変更をリモートバージョンにプッシュするには、ask deployを使用します。