kewbish/workers-sdk

⛅️ Home to Wrangler, the CLI for Cloudflare Workers®

⛅️ Home to wrangler, the CLI for Cloudflare Workers®, as well as other tools for interacting with Workers

This monorepo contains:

• wrangler-devtools Cloudflare's fork of Chrome DevTools for inspecting your local or remote Workers
• templates Templates & examples for writing Cloudflare Workers
• wrangler A command line tool for building Cloudflare Workers.
• pages-shared Used internally to power Wrangler and Cloudflare Pages. It contains all the code that is shared between these clients.

Wrangler and the workers-sdk is developed in the open on GitHub, and you can see what we're working on in GitHub Issues, as well as in our workers-sdk GitHub Project board. If you've found a bug or would like to request a feature, please file an issue!

Quick Start

# Make a javascript file
echo "export default { fetch() { return new Response('hello world') } }" > index.js
# try it out
npx wrangler dev index.js
# and then deploy it
npx wrangler deploy index.js --name my-worker --latest
# visit https://my-worker.<your workers subdomain>.workers.dev

Create a Project

# Generate a new project
npx wrangler init my-worker
# try it out
cd my-worker && npm run start
# and then deploy it
npm run deploy

Installation:

$ npm install wrangler --save-dev

Commands

wrangler init [name]

Creates a Worker project. For details on configuration keys and values, refer to the documentation.

wrangler dev

Start a local development server, with live reloading and devtools.

wrangler deploy

Deploys the given script to the worldwide Cloudflare network.

For more commands and options, refer to the documentation.

Pages

wrangler pages dev [directory] [-- command]

Either serves a static build asset directory, or proxies itself in front of a command.

Builds and runs functions from a ./functions directory or uses a _worker.js file inside the static build asset directory.

For more commands and options, refer to the documentation or run wrangler pages dev --help.

Documentation

For the latest Wrangler documentation, click here.

Contributing

Refer to the CONTRIBUTING.md guide for details.