Skip to content

Commit c48df1d

Browse files
committed
docs: multi workers development
1 parent 728882a commit c48df1d

File tree

1 file changed

+118
-0
lines changed

1 file changed

+118
-0
lines changed
Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
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 { 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 wrangler.app.jsonc -c wrangler.api.jsonc"
24+
/>
25+
26+
The first config (`wrangler.app.jsonc`) is treated as the primary Worker, exposed at `http://localhost:8787`. Additional configs (e.g. `wrangler.api.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: "./wrangler.app.jsonc",
40+
auxiliaryWorkers: [
41+
{
42+
configPath: "./wrangler.api.jsonc",
43+
},
44+
],
45+
}),
46+
],
47+
});
48+
```
49+
50+
Then run:
51+
52+
<PackageManagers type="exec" pkg="vite" args="dev" />
53+
54+
**Use this approach when:**
55+
56+
- Workers are part of the same application or codebase
57+
- You want the simplest setup without the full binding support
58+
- You need to access a Durable Object namespace from another Worker using `script_name`, or you are testing Queues where the producer and consumer Workers are seperated.
59+
60+
We recommend this approach as the default for most development workflows. Running multiple Workers in a single dev command ensures the best compatibility with features like service bindings, Durable Objects, and Queues.
61+
62+
## Multiple dev commands
63+
64+
You can also run each Worker in a separate dev commands, each with its own terminal and configuration.
65+
66+
<PackageManagers
67+
comment="Terminal 1"
68+
type="exec"
69+
pkg="wrangler"
70+
args="dev -c wrangler.app.jsonc"
71+
/>
72+
73+
<PackageManagers
74+
comment="Terminal 2"
75+
type="exec"
76+
pkg="wrangler"
77+
args="dev -c wrangler.api.jsonc"
78+
/>
79+
80+
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`**.
81+
82+
**Limitations**
83+
84+
While this setup offers flexibility, some bindings are not available when Workers are started in separate dev commands instead of being run together:
85+
86+
| Bindings | Wrangler (single config) | Wrangler (multi config) | Vite (all setup) |
87+
|------------------|:-------------------------:|:-----------------------:|:-----------------:|
88+
| Service Bindings || 🔜 ||
89+
| Durable Objects | ⚠️ |||
90+
| Tail Consumers || 🔜 ||
91+
92+
✅ = Full support.<br />
93+
⚠️ = Fetch only. RPC is not supported.<br />
94+
🔜 = No support yet. Coming soon.<br />
95+
❌ = Not supported.<br />
96+
97+
**Use this approach when:**
98+
99+
- Each Worker has its own build setup or tooling — for example, one uses Vite with custom plugins while another is a vanilla Wrangler project
100+
- You need the flexibility to run and develop Workers independently without restructuring your project or consolidating configs
101+
- Your Workers live in different repositories or are maintained by separate teams
102+
103+
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.
104+
105+
## Hybrid approach
106+
107+
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`.
108+
109+
This allows you to keep tightly coupled Workers running under a single dev command, while keeping independent or shared Workers in separate ones. However, the same limitations for bindings apply when Workers are run across multiple dev commands. Refer to the table above for what's supported when Workers aren't started in the same dev command.
110+
111+
**Use this approach when:**
112+
113+
- You want the convenience of developing related Workers together, while keeping others separate
114+
- You are working with a shared or legacy Worker that doesn't fit into your main dev setup
115+
- You are gradually migrating multiple Workers into a unified setup but need flexibility during transition
116+
117+
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.
118+

0 commit comments

Comments
 (0)