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 authentication service from GitHub, create a new directory with the name authentication 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/johndoe/authentication --name my-authentication

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

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 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.

2.0 KiB Raw Blame History

Read this on the main serverless docs site