Skip to content

install.md

Latest commit

 

History

History
52 lines (36 loc) · 1.76 KB

install.md

File metadata and controls

52 lines (36 loc) · 1.76 KB

Read this on the main serverless docs site

AWS - Install

Installs a service from a GitHub URL in the current working directory.

serverless install --url https://github.com/some/service

Options

  • --url or -u The services GitHub URL. Required.
  • --name or -n Name for the service.

Provided lifecycle events

  • install:install

Examples

Installing a service from a GitHub URL

serverless install --url https://github.com/pmuens/serverless-crud

This example will download the .zip file of the serverless-crud service from GitHub, create a new directory with the name serverless-crud in the current working directory and unzips the files in this directory.

Installing a service from a GitHub URL with a new service name

serverless install --url https://github.com/pmuens/serverless-crud --name my-crud

This example will download the .zip file of the serverless-crud service from GitHub, create a new directory with the name my-crud in the current working directory and unzips the files in this directory and renames the service to my-crud if serverless.yml exists in the service root.

Installing a service from a directory in a GitHub URL

serverless install --url https://github.com/serverless/examples/tree/master/rest-api-with-dynamodb

This example will download the rest-api-with-dynamodb service from GitHub.