https://github.com/marcy-terui/serverless-alexa-skills
Manage your Alexa Skills with Serverless Framework
https://github.com/marcy-terui/serverless-alexa-skills
alexa alexa-skill alexa-skills-kit serverless serverless-framework serverless-plugin
Last synced: 4 months ago
JSON representation
Manage your Alexa Skills with Serverless Framework
- Host: GitHub
- URL: https://github.com/marcy-terui/serverless-alexa-skills
- Owner: marcy-terui
- License: mit
- Created: 2017-11-22T13:05:10.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-08-20T19:53:34.000Z (about 4 years ago)
- Last Synced: 2025-05-14T17:17:45.355Z (5 months ago)
- Topics: alexa, alexa-skill, alexa-skills-kit, serverless, serverless-framework, serverless-plugin
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/serverless-alexa-skills
- Size: 313 KB
- Stars: 71
- Watchers: 3
- Forks: 12
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Serverless Alexa Skills Plugin
=======
[](http://www.serverless.com)
[](https://travis-ci.org/marcy-terui/serverless-alexa-skills)
# Description
Manage your Alexa Skills with Serverless Framework.
# Requirements
- [Serverless Framework](https://github.com/serverless/serverless) 1.0 or higher
# Installation
```sh
serverless plugin install --name serverless-alexa-skills
```
or
```sh
npm install serverless-alexa-skills
```
# Setup
See: [the step-by-step guide](https://github.com/marcy-terui/serverless-alexa-skills/wiki/How-to-get-your-%22Login-with-Amazon%22-credentials)
# Configuration
### serverless.yml
```yaml
provider:
name: aws
runtime: nodejs6.10
plugins:
- serverless-alexa-skills
custom:
alexa:
skills:
- id: ${env:YOUR_ALEXA_SKILL_ID}
skillManifest:
publishingInformation:
locales:
en-US:
name: test2
apis:
custom: {}
manifestVersion: '1.0'
models:
en-US:
interactionModel:
languageModel:
invocationName: hello
intents:
- name: AMAZON.CancelIntent
samples: []
- name: AMAZON.HelpIntent
samples: []
- name: AMAZON.StopIntent
samples: []
- name: HelloWorldIntent
samples:
- hello
- say hello
- hello world
```
# Commands
## alexa auth
Authenticate with Amazon OAuth2.
- This command creates a local web server to receive OAuth2 authentication redirects. The default port is `9090`. If you want to change the port, please change `custom.alexa.localServerPort` setting.
**Note: You must use the 9090 port if use the default security profile. If you want to use another port number, you have to create a custom security profile with "http://127.0.0.0:$YOUR_PORT_NUMBER/cb" as Allow Return URLs.**
```shell
$ serverless alexa auth -h
Plugin: AlexaSkills
alexa auth .................... Authenticate with Amazon OAuth2
```
## alexa create
Create an Alexa Skill.
```shell
$ serverless alexa create -h
Plugin: AlexaSkills
alexa create .................. Create an Alexa Skill
--name / -n (required) ............. Name of the skill
--locale / -l (required) ........... First locale of the skill (e.g. "ja-JP", "en-US")
--type / -t (required) ............. Type of the skill (e.g. "custom", "smartHome", "video")
```
## alexa delete
Delete an Alexa Skill.
```shell
$ serverless alexa delete -h
Plugin: AlexaSkills
alexa delete .................. Delete an Alexa Skill
--id / -i (required) ............... Skill ID
```
## alexa manifests
List your Alexa Skill Manifests.
```shell
$ serverless alexa manifests -h
Plugin: AlexaSkills
alexa manifests ............... List your Alexa Skill Manifests
```
## alexa update
Update your Alexa Skill Manifests.
```shell
$ serverless alexa update -h
Plugin: AlexaSkills
alexa update .................. Update your Alexa Skill Manifests
--dryRun / -d ...................... Dry run (Only output the diff)
```
## alexa models
List your Alexa Interaction Models.
```shell
$ serverless alexa models -h
Plugin: AlexaSkills
alexa models .................. List your Alexa Interaction Models
```
## alexa build
Update and buid your Alexa Interaction Models.
```shell
$ serverless alexa build -h
Plugin: AlexaSkills
alexa build ................... Update and buid your Alexa Interaction Models
--dryRun / -d ...................... Dry run (Only output the diff)
```
# How to use
See: [the post of Serverless Blog](https://serverless.com/blog/how-to-manage-your-alexa-skills-with-serverless/)
Development
-----------
- Source hosted at [GitHub](https://github.com/marcy-terui/serverless-alexa-skills)
- Report issues/questions/feature requests on [GitHub
Issues](https://github.com/marcy-terui/serverless-alexa-skills/issues)
Pull requests are very welcome! Make sure your patches are well tested.
Ideally create a topic branch for every separate change you make. For
example:
1. Fork the repo
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
Authors
-------
Created and maintained by [Masashi Terui](https://github.com/marcy-terui) ()
License
-------
MIT License (see [LICENSE](https://github.com/marcy-terui/serverless-alexa-skills/blob/master/LICENSE.txt))