Skip to content
Tiny command line tool to create, run, and deploy AWS Lambda.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
global-cli
template
test
.eslintignore
.eslintrc.json
.gitignore
LICENSE
README.md
package.json

README.md

instant-lambda

License: MIT
Tiny command line tool to create, run, and deploy AWS Lambda functions.

$ instant-lambda create your-awesome-lambda

Installation

$ npm install -g instant-lambda

Usage/Commands

Invoke 4 commands using either instalam or instant-lambda.

$ instalam create your-awesome-lambda
$ cd your-awesome-lambda
$ instalam run
$ instalam pack
$ instalam deploy

create

$ instalam create <your-lambda-name>

Creates a new directory with your AWS Lambda name and sets up template files in the directory. The template files include app.js, lambda-config.json, deploy-config.json, event.json, and package.json.

app.js

This is where you write your actuall Lambda function handler. Default handler method name is set to main. However, this can be configured in lambda-config.json as well as handler file name, which is app by default.

lambda-config.json

This file is used to configure details of your Lambda. The JSON should look like

{
  "runtime": "nodejs6.10",
  "role": "arn:aws:iam::XXXXXXXXXXXX:my/iam/role",
  "handlerFile": "app",
  "handlerMethod": "main",
  "description": "My AWS Lambda function.",
  "timeout": "3",
  "memorySize": "128",
  "environment:": {
    "variables": {}
  },
  "functionName": "your-lambda-name"
}

See also AWS.Lambda.createFunction - AWS SDK for JavaScript.

deploy-config.json

This file contains information which instalam deploy command uses to upload your Lambda to AWS. Currently deploy command retrieves only your AWS region from this JSON file.

event.json

If you wish to pass an event to your Lambda when you run it locally with instalam run command, you can do so by defining your event in this JSON file.

package.json

Of course you can use node packages in your Lambda!

run

$ instalam run

Runs your Lambda locally. Passes an event defined in event.json to your Lambda.

pack

$ instalam pack

Packages necessary files and all the dependencies in a zip file.

deploy

$ instalam deploy

Uploads your packaged Lambda function to AWS. You need to run instalam pack before deploying.
Currently instant-lambda does not automatically retrieve your authentication credentials. Before running this command, you need to set your AWS credentials as environment variables.
To set your authentication credentials, you can do something like

$ export AWS_ACCESS_KEY_ID='XXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
$ export AWS_SECRET_ACCESS_KEY='XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'

Test

Currently not configured.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Author

Tatsuro Ide

License

MIT License

You can’t perform that action at this time.