Skip to content

Latest commit

 

History

History
97 lines (62 loc) · 4.86 KB

cli.md

File metadata and controls

97 lines (62 loc) · 4.86 KB
Raw

Build An Alexa Hello World Skill

Setup w/ ASK CLI

About

This readme assumes you have your developer environment ready to go and that you have some familiarity with CLI (Command Line Interface) Tools, AWS, and the ASK Developer Portal. If not, click here for a more detailed walkthrough.

Pre-requisites

Note: If you would like to setup the ASK CLI using AWS Cloud9 (a cloud-based IDE with pay-as-you-go pricing and is eligible for AWS Free Tier pricing), step-by-step instructions can be found here.

Installation

  1. Make sure you are running the latest version of the CLI

    npm update -g ask-cli

  2. Clone the repository and navigate into the skill's root directory.

    ask new --url https://github.com/alexa/skill-sample-nodejs-hello-world.git --skill-name hello-world
cd hello-world

  3. Install npm dependencies by navigating into the /lambda/custom directory and running the npm command: npm install.

    cd lambda/custom
npm install

Deployment

ASK CLI will create the skill and the Lambda function for you. The Lambda function will be created in us-east-1 (Northern Virginia) by default.

  1. Navigate to the project's root directory. you should see a file named 'skill.json' there.

  2. Deploy the skill and the Lambda function in one step by running the following command:

    ask deploy

Testing

  1. To test, the skill needs to be enabled. From the developer console, open your skill and click the Test tab. Ensure the skill is available for testing in Development.

  2. Simulate verbal interaction with your skill through the command line (this might take a few moments) using the following example:

     ask simulate -l en-US -t "start Hello World"

 ✓ Simulation created for simulation id: 4a7a9ed8-94b2-40c0-b3bd-fb63d9887fa7
◡ Waiting for simulation response{
  "status": "SUCCESSFUL",
  ...

  3. Once the "Test" switch is enabled, your skill can be tested on devices associated with the developer account as well. Speak to Alexa from any enabled device, from your browser at echosim.io, or through your Amazon Mobile App and say :

    Alexa, start hello world

Customization

  1. ./skill.json

    Change the skill name, example phrase, icons, testing instructions etc ...

    Remember than many information are locale-specific and must be changed for each locale (e.g. en-US, en-GB, de-DE, etc.)

    See the Skill Manifest Documentation for more information.

  2. ./lambda/custom/index.js

    Modify messages, and data from the source code to customize the skill.

  3. ./models/*.json

    Change the model definition to replace the invocation name and the sample phrase for each intent. Repeat the operation for each locale you are planning to support.

  4. Remember to re-deploy your skill and Lambda function for your changes to take effect.

    ask deploy

Additional Testing Options

Next