Nurturing Pluto's Martians

    wrangler
    TypeScript icon, indicating that this package has built-in type declarations

    2.9.0 • Public • Published

    ⛅️ wrangler

    npm GitHub contributors GitHub commit activity (branch) Discord

    This package is for wrangler v2.x, released first in May 2022. If you're looking for v1.x of the @cloudflare/wrangler package, visit https://www.npmjs.com/package/@cloudflare/wrangler / https://github.com/cloudflare/wrangler.

    wrangler is a command line tool for building Cloudflare Workers.

    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 publish it
    npx wrangler publish index.js --name my-worker
    # 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 publish it
    npm run deploy

    Installation:

    $ npm install wrangler --save-dev

    Configuration:

    Wrangler is configured via a wrangler.toml file in the project root. When utilizing the wrangler init command, a wrangler.toml file will be created for you.

    example:

    main = "./src/index.ts" # init w/ TypeScript
    name = "my-worker"
    compatibility_date = "YYY-MM-DD"

    for more detailed information about configuration, see the documentation

    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 publish

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

    Install

    npm i wrangler

    DownloadsWeekly Downloads

    94,947

    Version

    2.9.0

    License

    MIT OR Apache-2.0

    Unpacked Size

    8.35 MB

    Total Files

    294

    Last publish

    Collaborators

    • wrangler-publisher