# @nora-soderlund/wrangler

> Command-line interface for all things Cloudflare Workers

Latest version **3.26.4** (published 2024-02-01) · MIT OR Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @nora-soderlund/wrangler
pnpm add @nora-soderlund/wrangler
yarn add @nora-soderlund/wrangler
bun add @nora-soderlund/wrangler
```

Provides the commands `wrangler`, `wrangler2`.

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.26.4 |
| Published | 2024-02-01 |
| First published | 2024-01-06 |
| Weekly downloads | 0 |
| License | MIT OR Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=16.17.0 |
| Dependencies | 14 |
| Unpacked size | 7.4 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4599 |
| Author | wrangler@cloudflare.com |
| Maintainers | nora-soderlund |
| Keywords | wrangler, cloudflare, workers, cloudflare workers, edge, compute, serverless, serverless application, serverless module, wasm, web, assembly, webassembly, rust, emscripten, typescript, graphql, router, http, cli |

## Links

- npm: https://www.npmjs.com/package/@nora-soderlund/wrangler
- Repository: https://github.com/cloudflare/workers-sdk
- Homepage: https://github.com/cloudflare/workers-sdk#readme
- Issues: https://github.com/cloudflare/workers-sdk/issues
- npm.io page: https://npm.io/package/@nora-soderlund/wrangler

## Dependencies (14)

- [nanoid](https://npm.io/package/nanoid.md) ^3.3.3
- [esbuild](https://npm.io/package/esbuild.md) 0.17.19
- [resolve](https://npm.io/package/resolve.md) ^1.22.8
- [chokidar](https://npm.io/package/chokidar.md) ^3.5.3
- [miniflare](https://npm.io/package/miniflare.md) workspace:*
- [selfsigned](https://npm.io/package/selfsigned.md) ^2.0.1
- [source-map](https://npm.io/package/source-map.md) 0.6.1
- [blake3-wasm](https://npm.io/package/blake3-wasm.md) ^2.1.5
- [xxhash-wasm](https://npm.io/package/xxhash-wasm.md) ^1.0.1
- [path-to-regexp](https://npm.io/package/path-to-regexp.md) ^6.2.0
- [resolve.exports](https://npm.io/package/resolve.exports.md) ^2.0.2
- [@cloudflare/kv-asset-handler](https://npm.io/package/@cloudflare/kv-asset-handler.md) ^0.2.0
- [@esbuild-plugins/node-globals-polyfill](https://npm.io/package/@esbuild-plugins/node-globals-polyfill.md) ^0.2.3
- [@esbuild-plugins/node-modules-polyfill](https://npm.io/package/@esbuild-plugins/node-modules-polyfill.md) ^0.2.2

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 3.26.4 (latest) — 2024-02-01
- 3.26.2 — 2024-02-01
- 3.26.1 — 2024-02-01
- 3.26.0 — 2024-02-01
- 3.22.3 — 2024-01-06

## README

<h1 align="center"> ⛅️ wrangler </h1>
<section align="center" id="shieldio-badges">
<a href="https://www.npmjs.com/package/wrangler"><img alt="npm"  src="https://img.shields.io/npm/dw/wrangler?style=flat-square"></a>
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/cloudflare/workers-sdk?style=flat-square">
<img alt="GitHub commit activity (branch)" src="https://img.shields.io/github/commit-activity/w/cloudflare/workers-sdk/main?style=flat-square">
<a href="https://discord.gg/CloudflareDev"><img alt="Discord" src="https://img.shields.io/discord/595317990191398933?color=%23F48120&style=flat-square"></a>
</section>

`wrangler` is a command line tool for building [Cloudflare Workers](https://workers.cloudflare.com/).

## Quick Start

```bash
# 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
# visit https://my-worker.<your workers subdomain>.workers.dev
```

## Create a Project

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

## Installation:

```bash
$ 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:

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

For more detailed information about configuration, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/configuration/).

## Commands

### `wrangler init [name]`

Creates a Worker project. For details on configuration keys and values, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/commands/#init).

### `wrangler dev`

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

### `wrangler deploy`

Publish the given script to the worldwide Cloudflare network.

For more commands and options, refer to the [documentation](https://developers.cloudflare.com/workers/wrangler/commands/).

## 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](https://developers.cloudflare.com/pages/platform/functions#develop-and-preview-locally) or run `wrangler pages dev --help`.

## Documentation

For the latest Wrangler documentation, [click here](https://developers.cloudflare.com/workers/wrangler/).

---
_Source: https://npm.io/package/@nora-soderlund/wrangler · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
