Skip to content

Commit

Permalink
docs: provide two cases into FAQ.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RonWang committed Apr 15, 2020
1 parent cbda3ef commit 03439ad
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,13 @@
</p>


The Alexa Skills Kit Command Line Interface (ask-cli) is used to create, manage, and deploy Alexa skills from the command line.
The Alexa Skills Kit Command Line Interface (ask-cli) is used to create, manage, and deploy Alexa skills from the command line. Please see the full documentation from [ASK CLI quick start guide](https://developer.amazon.com/docs/smapi/quick-start-alexa-skills-kit-command-line-interface.html).

<p align="center">
<img align="center" src="https://ask-cli-static-content.s3-us-west-2.amazonaws.com/document-assets/v2-ask-cli-intro.gif" height="350" />
</p>

*NOTE:* This source is currently for a beta version of the ask-cli. For the latest stable version of the ask-cli, see the [ASK CLI quick start guide](https://developer.amazon.com/docs/smapi/quick-start-alexa-skills-kit-command-line-interface.html).

*Note:* To use ask-cli for `Alexa-Hosted skill`, please check our [instructions](https://github.com/alexa/ask-cli/blob/develop/docs/concepts/Alexa-Hosted-Skill-Commands.md) for the usage.

### Getting Started

Expand Down
24 changes: 24 additions & 0 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Frequent Asked Questions


### Q: Since v2 ask-cli removes "ask clone" command, what should I do to download my skill project?

- If you have used v1 ask-cli, please use command `ask util upgrade-project` to update your existing v1 project to v2 format.
- If you want to clone an Alexa-Hosted skill, please use command `ask init --hosted-skill-id {skillId}`.
- If you want to develop skill in local project from web console, please use command `ask init` to flexibly link your resources in the ask-resources.json. More in details:
1. Create a new folder as your local Alexa skill project, run `ask api export-package -s {skillId} -g {stage}` to download your skill-package.
2. Retrieve your Lambda source code. This step really depends on how you source control your code, it can be the code downloaded from existing Lambda function, or S3, or from "git clone".
3. Run `ask init` wizard, where you will be asked to fill your skill-id, file path for skill-package and Lambda source code, and how do you want to deploy the skill infrastructures (backend).
- If you want to get your latest change after updating skill in ASK console, please run `ask api export-package` command once you make sure local changes towards skill-package won't be overwritten by the command.

Our reason to remove the clone command is to define ask-cli as a deployment tool for Alexa skill, not source control tool. The data flow in CLI will be user-driven and unidirectional. We highly encourage our skill developers to use their own source version control tools to manage their projects.

---

### Q: For Windows users, if your skill return empty response, and log shows "Module not found: GenericErrorMapper" or "Cannot find module './dispatcher/error/mapper/GenericErrorMapper'", how to resolve?

This issue is related to CLI's deploy command to build code using Powershell script, caused by Powershell 6.2 shipping a broken *Compress-Archive* command. CLI zips your codebase using this PS command and then upload to Lambda. If you happen to use that version, please run the following command to update the command with the fix, and re-deploy your skill project.
```
Install-Module Microsoft.PowerShell.Archive -MinimumVersion 1.2.3.0 -Repository PSGallery -Force
```
Related issues: https://github.com/alexa/ask-cli/issues/38, https://github.com/alexa/ask-cli/issues/59, https://github.com/alexa/ask-cli/issues/117. Thanks for your effort for reporting this issue.

0 comments on commit 03439ad

Please sign in to comment.