A framework for building JavaScript APIs with AWS API Gateway and Lambda
Amazon Web Services API gateway and Lambda are great tools for building and deploying "serverless" applications. But using them to deploy more than a couple functions/endpoints involves an excessive amount of manual work such as zipping files, uploading via the web UI, configuring paths and function names, etc. Shep is built to automate as many of these tasks as possible, giving you the ability to deploy an entire API and suite of lambda functions with one CLI command.
It will be helpful to have some existing experience with API gateway and Lambda. If you have never used either of these tools before, it is recommended to setup a function manually to see how things are done. Please refer to Amazon's own getting started guide
Shep will require your amazon credentials and will load them using the same methods as the AWS CLI tool. Consult Amazon's CLI documentation for instructions.
npm install -g shep
npm install --save-dev shep // the global shep will run the local shepAdd a few lines to your package.json. Your account id,
{
"name": "my-great-package",
"shep": {
"accountId": "XXXXX",
"region": "us-east-1"
}
}Coming soon!
Coming soon!
Usage: shep <command> [options]
Commands:
build [env] [functions] Builds functions and writes them to disk
deploy [env] [functions] Deploy both functions and APIs to AWS. Will create a new API if the ID is not specified
generate Run `shep generate --help` for additional information
new [path] Create a new shep project
pull Pulls a swagger JSON representation of an existing API and writes it to a local file
push Create a new shep project
run [name] Run a function in your local environemnt
Options:
--version Show version number [boolean]
--help Show help [boolean]
shep new [path]
Options:
--version Show version number [boolean]
--help Show help [boolean]
--path Location to create the new shep project
--skip-config Skips configuring shep project [boolean]
--region Region for new shep project
--rolename Name of IAM Role which will be used to execute Lambda functions
Examples:
shep new Launch an interactive CLI
shep new my-api Generates a project at `my-api`
shep pull
Options:
--version Show version number [boolean]
--help Show help [boolean]
--region, -r AWS region [required]
--stage, -s AWS API Gateway stage. Read from the shep config in project.json if not provided [required]
--api-id, -a AWS API Gateway ID. Read from the shep config in project.json if not provided [required]
--output, -o Path of the file to output [default: "api.json"]
Examples:
shep pull Download a JSON swagger file for `apiId` in package.json and prompts for stage via
interactive CLI
shep pull --api-id foo --stage bar Downloads a JSON swagger file for stage `bar` of API id `foo`
shep pull --output other-path.json Writes the JSON swagger file to `other-path.json`
shep push
Options:
--version Show version number [boolean]
--help Show help [boolean]
--api-id API Gateway resource id. Read from package.json if not provided [required]
--region AWS region. Read from package.json if not provided [required]
Examples:
shep push Pushes the api.json swagger configuration to API Gateway. Does not deploy
the API.
shep push --api-id foo --region us-east-1
shep run [name]
Options:
--version Show version number [boolean]
--help Show help [boolean]
--environment Environment variables to use [default: "development"]
--event Event to use
-v Responses from functions aren't truncated
--build Build functions before running. Use --no-build to skip this step [default: true]
Examples:
shep run Launch an interactive CLI
shep run foo Runs the `foo` function for all events
shep run foo --no-build Run the already built `foo` function in the dist folder
shep run foo --event default Runs the `foo` function for just the `default` event
shep run foo --environment production Runs the `foo` function with production environment
shep deploy [env] [functions]
Options:
--version Show version number [boolean]
--help Show help [boolean]
--build Build functions before deployment. Use --no-build to skip this step [default: true]
Examples:
shep deploy Launch an interactive CLI
shep deploy production Deploy all functions with production env variables
shep deploy beta --no-build Deploy all functions as currently built in the dist folder
shep deploy production create-user Deploy only the create-user function
shep deploy beta *-user Deploy only functions matching the pattern *-user
shep build [env] [functions]
Options:
--version Show version number [boolean]
--help Show help [boolean]
Examples:
shep build Launch an interactive CLI
shep build beta Build all functions with beta environment variables
shep build beta create-user Build only the create-user function
shep build beta *-user Build functions matching the pattern *-user
shep generate function [name]
Options:
--version Show version number [boolean]
--help Show help [boolean]
--name Function name
Examples:
shep generate function Launch an interactive CLI
shep generate function foo Genereate a new functon called "foo"
shep generate endpoint [path]
Options:
--version Show version number [boolean]
--help Show help [boolean]
--method HTTP Method [choices: "get", "post", "put", "delete", "options", "any"]
shep generate webpack
Options:
--version Show version number [boolean]
--help Show help [boolean]
--output, -o Output file [default: "webpack.config.js"]
Examples:
shep generate webpack -o foo.js Writes default webpack configuration to foo.js
More details to come, but check out the AWS docs about setting up the proper IAM role for lambda: http://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html http://docs.aws.amazon.com/lambda/latest/dg/with-s3-example-create-iam-role.html
It was called 'shepherd' at first because it was helpful for dealing with lambda but everyone kept shortening it to 'shep' so we changed the name
Serverless Apex Gordon DEEP Claudia.js
Pull requests welcome!
Test: npm test
Rebuild on file change: npm run compile -- -w
Publish: npm run pub "publish" is reserved by npm