Skip to content

Add details on how to disable remote binding in wrangler dev, getPlatformProxy and the vite plugin #26265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: production
Choose a base branch
from
Open

Add details on how to disable remote binding in wrangler dev, getPlatformProxy and the vite plugin #26265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f20204d
Add `--local` flag to `wrangler dev` documentation
dario-piotrowicz Nov 4, 2025
d077389
add `localBindingsOnly` option to `getPlatformProxy` documentation (a…
dario-piotrowicz Nov 4, 2025
29b580f
rename `localBindingsOnly` to `remoteBindings`
dario-piotrowicz Nov 4, 2025
a186902
add `remoteBindings` option to vite-plugin documentation
dario-piotrowicz Nov 4, 2025
87ffd35
Update src/content/docs/workers/wrangler/commands.mdx
dario-piotrowicz Nov 10, 2025
dffa4dd
Update src/content/docs/workers/vite-plugin/reference/api.mdx
dario-piotrowicz Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/content/docs/workers/vite-plugin/reference/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,11 @@ It accepts an optional `PluginConfig` parameter.
You can inspect the `dist` directory and then run `wrangler deploy -c dist/<auxiliary-worker>/wrangler.json` for each.
:::

- `remoteBindings` <Type text='boolean' /> <MetaInfo text='optional' />

Whether or not [remote bindings](/workers/development-testing/#remote-bindings) should be enabled. Defaults to `true`.


## `interface AuxiliaryWorkerConfig`

- `configPath` <Type text='string' />
Expand Down
6 changes: 2 additions & 4 deletions src/content/docs/workers/wrangler/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,11 +300,9 @@ const platform = await getPlatformProxy(options);

**Note:** If you use `wrangler`'s `--persist-to` option, note that this option adds a subdirectory called `v3` under the hood while `getPlatformProxy`'s `persist` does not. For example, if you run `wrangler dev --persist-to ./my-directory`, to reuse the same location using `getPlatformProxy`, you will have to specify: `persist: { path: "./my-directory/v3" }`.

- `experimental` `{ remoteBindings: boolean }`
- `remoteBindings` boolean <MetaInfo text="optional (default: `true`)" />

Object used to enable experimental features, no guarantees are made to the stability of this API, use at your own risk.

- `remoteBindings` Enables `getPlatformProxy` to connect to [remote bindings](/workers/development-testing/#remote-bindings).
Whether or not [remote bindings](/workers/development-testing/#remote-bindings) should be enabled.

### Return Type

Expand Down
4 changes: 4 additions & 0 deletions src/content/docs/workers/wrangler/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,10 @@ None of the options for this command are required. Many of these options can be
- Show the interactive dev session.
- `--alias` `Array<string>`
- Specify modules to alias using [module aliasing](/workers/wrangler/configuration/#module-aliasing).
- `--local` <Type text="boolean" /> <MetaInfo text="(default: false) optional" />
Copy link
Contributor

@petebacondarwin petebacondarwin Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also have --remote arg above. How do these two interact?

Copy link
Member Author

@dario-piotrowicz dario-piotrowicz Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when --remote is used we run the worker remotely so --local doesn't have any effect there, shall we add something here to the extent of: This flag ha no effect when `--remote` is specified?

Copy link
Contributor

@petebacondarwin petebacondarwin Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about --remote=false?

- Run in local mode. In this mode:
- the Worker code is running locally on your machine
- all [remote bindings](/workers/development-testing/#remote-bindings) are disabled, which behaves exactly as if there were configured with `remote: false`.

<Render file="wrangler-commands/global-flags" product="workers" />

Expand Down
Loading