Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.51 KB

install.md

File metadata and controls

50 lines (32 loc) · 1.51 KB
Raw

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 Git URL (can be a plain Git or a Code Hosting Platform URL). Required.
  • --name or -n Name for the service.

Provided lifecycle events

  • install:install

Supported Code Hosting Platforms

  • GitHub
  • GitHub Enterprise
  • GitLab
  • BitBucket
  • BitBucket Server

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/aws-node-rest-api-with-dynamodb

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