Skip to content
This repository has been archived by the owner on May 1, 2023. It is now read-only.

Latest commit

 

History

History
95 lines (63 loc) · 5.31 KB

7-cli.md

File metadata and controls

95 lines (63 loc) · 5.31 KB
Raw

Build An Alexa City Guide 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

Installation

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

    $ npm update -g ask-cli

  2. Clone the repository.

    $ git clone https://github.com/alexa/skill-sample-nodejs-city-guide/

  3. If it's your first time using it, configure the ASK CLI by navigating into the repository and running npm command: ask configure. Follow the prompts.

    $ cd skill-sample-nodejs-city-guide
$ ask configure

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

    $ 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 folder named 'skill-package' it contains a file called 'skill.json'.

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

    $ ask deploy

Testing

  1. To test, you need to login to Alexa Developer Console, and enable the "Test" switch on your skill from the "Test" Tab.

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

     $ ask dialog -l en-GB 
 
 ========================================== Welcome to ASK Dialog 
 ========================================== In interactive mode, type your utterance text onto the console and hit enter 
 ========================================== Alexa will then evaluate your input and give a response!
 ========================================== Use ".record <fileName>" or ".record <fileName> --append-quit" to save list of utterances to a file. 
 ========================================== You can exit the interactive mode by entering ".quit" or "ctrl + c". 
 User  > start city guide
 ...

  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 city guide

Customization

  1. .skill-package/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 (en-GB and en-US)

    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.