Skip to content

create.md

Latest commit

 

History

History
77 lines (59 loc) · 2.89 KB

create.md

File metadata and controls

77 lines (59 loc) · 2.89 KB
Raw

Read this on the main serverless docs site

Cloudflare Workers - Create

Creates a new Serverless service in the current working directory based on the provided template.

Create service in current working directory:

serverless create --template cloudflare-workers

Or for Enterprise Cloudflare accounts:

serverless create --template cloudflare-workers-enterprise

Create service in new folder:

serverless create --template cloudflare-workers --path my-service

Or for Enterprise Cloudflare accounts:

serverless create --template cloudflare-workers-enterprise --path my-service

Options

  • --template or -t The name of one of the available templates. Required if --template-url and --template-path are not present.
  • --template-url or -u The name of one of the available templates. Required if --template and --template-path are not present.
  • --template-path The local path of your template. Required if --template and --template-url are not present.
  • --path or -p The path where the service should be created.
  • --name or -n the name of the service in serverless.yml.

Provided lifecycle events

  • create:create

Available Templates for Cloudflare Workers

To see a list of available templates run serverless create --help These are the current available templates for Cloudflare Workers:

  • cloudflare-workers
  • cloudflare-workers-enterprise
  • cloudflare-workers-rust

Examples

Creating a new service

serverless create --template cloudflare-workers --name my-special-service

This example will generate scaffolding for a service with Cloudflare as a provider. The scaffolding will be generated in the current working directory.

Creating a named service in a (new) directory

serverless create --template cloudflare-workers --path my-new-service

This example will generate scaffolding for a service with Cloudflare as a provider. The scaffolding will be generated in the my-new-service directory. This directory will be created if not present. Otherwise, Serverless will use the already present directory. Additionally, Serverless will rename the service according to the path you provide. In this example, the service will be renamed to my-new-service.

Creating a new service using a local template

serverless create --template-path path/to/my/template/folder --path path/to/my/service --name my-new-service

This will copy the path/to/my/template/folder folder into path/to/my/service and rename the service to my-new-service.