|
| 1 | +--- |
| 2 | +pcx_content_type: concept |
| 3 | +title: Developing with multiple Workers |
| 4 | +sidebar: |
| 5 | + order: 3 |
| 6 | +head: [] |
| 7 | +description: Learn how to develop with multiple Workers using different approaches and configurations. |
| 8 | +--- |
| 9 | + |
| 10 | +import { Aside, PackageManagers, Steps, WranglerConfig } from "~/components"; |
| 11 | + |
| 12 | +When building complex applications, you may want to run multiple Workers during development. This guide covers the different approaches for running multiple Workers locally and when to use each approach. |
| 13 | + |
| 14 | +## Single dev command |
| 15 | + |
| 16 | +You can run multiple Workers in a single dev command by passing multiple configuration files to your dev server: |
| 17 | + |
| 18 | +**Using Wrangler** |
| 19 | + |
| 20 | +<PackageManagers |
| 21 | + type="exec" |
| 22 | + pkg="wrangler" |
| 23 | + args="dev -c ./app/wrangler.jsonc -c ./api/wrangler.jsonc" |
| 24 | +/> |
| 25 | + |
| 26 | +The first config (`./app/wrangler.jsonc`) is treated as the primary Worker, exposed at `http://localhost:8787`. Additional configs (e.g. `./api/wrangler.jsonc`) run as auxiliary Workers, available via service bindings or tail consumers from the primary Worker. |
| 27 | + |
| 28 | +**Using the Vite plugin** |
| 29 | + |
| 30 | +Configure `auxiliaryWorkers` in your Vite configuration: |
| 31 | + |
| 32 | +```js title="vite.config.js" |
| 33 | +import { defineConfig } from "vite"; |
| 34 | +import { cloudflare } from "@cloudflare/vite-plugin"; |
| 35 | + |
| 36 | +export default defineConfig({ |
| 37 | + plugins: [ |
| 38 | + cloudflare({ |
| 39 | + configPath: "./app/wrangler.jsonc", |
| 40 | + auxiliaryWorkers: [ |
| 41 | + { |
| 42 | + configPath: "./api/wrangler.jsonc", |
| 43 | + }, |
| 44 | + ], |
| 45 | + }), |
| 46 | + ], |
| 47 | +}); |
| 48 | +``` |
| 49 | + |
| 50 | +Then run: |
| 51 | + |
| 52 | +<PackageManagers type="exec" pkg="vite" args="dev" /> |
| 53 | + |
| 54 | +<Aside type="tip"> |
| 55 | + |
| 56 | +We recommend this approach as the default for most development workflows as it ensures the best compatibility with bindings. |
| 57 | + |
| 58 | +</Aside> |
| 59 | + |
| 60 | +**Use this approach when:** |
| 61 | + |
| 62 | +- You want the simplest setup for development |
| 63 | +- Workers are part of the same application or codebase |
| 64 | +- You need to access a Durable Object namespace from another Worker using `script_name`, or setup Queues where the producer and consumer Workers are seperated. |
| 65 | + |
| 66 | +## Multiple dev commands |
| 67 | + |
| 68 | +You can also run each Worker in a separate dev commands, each with its own terminal and configuration. |
| 69 | + |
| 70 | +<PackageManagers |
| 71 | + comment="Terminal 1" |
| 72 | + type="exec" |
| 73 | + pkg="wrangler" |
| 74 | + args="dev -c ./app/wrangler.jsonc" |
| 75 | +/> |
| 76 | + |
| 77 | +<PackageManagers |
| 78 | + comment="Terminal 2" |
| 79 | + type="exec" |
| 80 | + pkg="wrangler" |
| 81 | + args="dev -c ./api/wrangler.jsonc" |
| 82 | +/> |
| 83 | + |
| 84 | +These Workers run in different dev commands but can still communicate with each other via service bindings or tail consumers **regardless of whether they are started with `wrangler dev` or `vite dev`**. |
| 85 | + |
| 86 | +<Aside type="caution"> |
| 87 | + |
| 88 | +Running `wrangler dev` with multiple configuration files (e.g. `wrangler dev -c ./app/wrangler.jsonc -c ./api/wrangler.jsonc`) does **not** support cross-process bindings at the moment. |
| 89 | + |
| 90 | +</Aside> |
| 91 | + |
| 92 | +**Use this approach when:** |
| 93 | + |
| 94 | +- You want each Worker to be accessible on its own local URL during development, since only the primary Worker is exposed when using a single dev command |
| 95 | +- Each Worker has its own build setup or tooling — for example, one uses Vite with custom plugins while another is a vanilla Wrangler project |
| 96 | +- You need the flexibility to run and develop Workers independently without restructuring your project or consolidating configs |
| 97 | + |
| 98 | +This setup is especially useful in larger projects where each team maintains a subset of Workers. Running everything in a single dev command might require significant restructuring or build integration that isn't always practical. |
| 99 | + |
| 100 | +## Hybrid approach |
| 101 | + |
| 102 | +You can also combine both approaches — for example, run a group of Workers together through `vite dev` using `auxiliaryWorkers`, while running another Worker separately with `wrangler dev`. This allows you to keep tightly coupled Workers running under a single dev command, while keeping independent or shared Workers in separate ones. |
| 103 | + |
| 104 | +Hybrid setups are useful when combining Workers maintained by different teams or projects. Rather than restructuring everything to run in a single dev command, you can run what makes sense together and leave others isolated |
| 105 | + |
| 106 | +<Aside type="caution"> |
| 107 | + |
| 108 | +The same limitations for bindings apply when Workers are run across multiple dev commands, which limits to service bindings or tail consumers at the moment. |
| 109 | + |
| 110 | +</Aside> |
| 111 | + |
| 112 | +**Use this approach when:** |
| 113 | + |
| 114 | +- You want the convenience of developing related Workers together, while keeping others separate |
| 115 | +- You are working with a shared or legacy Worker that doesn't fit into your main dev setup |
| 116 | +- You are gradually migrating multiple Workers into a unified setup but need flexibility during transition |
0 commit comments