UNPKG

serverless

Version:

Serverless Framework - Build web, mobile and IoT applications with serverless architectures using AWS Lambda, Azure Functions, Google CloudFunctions & more

serverless.com/framework/docs/

serverless/serverless

66 lines (43 loc) • 2.07 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<!-- title: Serverless Framework Commands - Apache OpenWhisk - Install menuText: install menuOrder: 3 description: Install pre-written Apache OpenWhisk Functions, Events and Resources with the Serverless Framework layout: Doc --> <!-- DOCS-SITE-LINK:START automatically generated --> ### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/openwhisk/cli-reference/install) <!-- DOCS-SITE-LINK:END --> # OpenWhisk - Install Installs a service from a GitHub URL in the current working directory. ```bash 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 ```bash serverless install --url https://github.com/jthomas/serverless-openwhisk-boilerplate ``` This example will download the .zip file of the `serverless-openwhisk-boilerplate` service from GitHub, create a new directory with the name `serverless-openwhisk-boilerplate` in the current working directory and unzips the files in this directory. ### Installing a service from a GitHub URL with a new service name ```bash serverless install --url https://github.com/jthomas/serverless-openwhisk-boilerplate --name my-app ``` This example will download the .zip file of the `serverless-openwhisk-boilerplate` service from GitHub, create a new directory with the name `my-app` in the current working directory and unzips the files in this directory and renames the service to `my-app` if `serverless.yml` exists in the service root. ### Installing a service from a directory in a GitHub URL ```bash serverless install --url https://github.com/serverless/examples/tree/master/openwhisk-node-simple ``` This example will download the `openwhisk-node-simple` service from GitHub.