# Local Electron Plugin

{% hint style="info" %}
This plugin should only be used by people who are building Electron locally themselves. If you want to use a fork of Electron, check out the [environment variables](https://github.com/electron/get#usage) you can use to configure `@electron/get`.
{% endhint %}

This plugin allows you to both run and build your app using a **local** build of Electron. This can be incredibly useful if you want to test a feature or a bug fix in your app before making a PR up to the Electron repository.

If you want to set up a local build of Electron, you should check out [Electron Build Tools](https://github.com/electron/build-tools).

### Installation

```bash
npm install --save-dev @electron-forge/plugin-local-electron
```

### Usage

Once you have a working build of Electron, point the plugin's `electronPath` config option to the folder containing the built Electron binary.

All possible configuration options are documented in [`LocalElectronPluginConfig`](https://js.electronforge.io/interfaces/_electron_forge_plugin_local_electron.LocalElectronPluginConfig.html).

{% code title="forge.config.js" %}

```javascript
{
  plugins: [
    {
      name: '@electron-forge/plugin-local-electron',
      config: {
        electronPath: '/Users/me/projects/electron/out/Testing'
      }
    }
  ]
}
```

{% endcode %}

{% hint style="info" %}
Please note that the plugin only accepts **absolute paths**. You should use Node's [`path.resolve()`](https://nodejs.org/api/path.html#pathresolvepaths) to make things deterministic.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://www.electronforge.io/config/plugins/local-electron.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.