2015-09-01 02:12:57 +00:00
|
|
|
# Debugging the Main Process
|
2014-08-20 02:01:43 +00:00
|
|
|
|
2015-09-09 21:11:06 +00:00
|
|
|
The browser window DevTools can only debug the renderer process scripts (i.e.
|
2015-09-01 02:12:57 +00:00
|
|
|
the web pages). In order to provide a way to debug the scripts from the main
|
|
|
|
process, Electron has provided the `--debug` and `--debug-brk` switches.
|
2014-08-20 02:01:43 +00:00
|
|
|
|
2015-09-01 02:12:57 +00:00
|
|
|
## Command Line Switches
|
|
|
|
|
|
|
|
Use the following command line switches to debug Electron's main process:
|
2014-08-20 02:43:41 +00:00
|
|
|
|
|
|
|
### `--debug=[port]`
|
2014-08-20 02:01:43 +00:00
|
|
|
|
2015-09-01 02:12:57 +00:00
|
|
|
When this switch is used Electron will listen for V8 debugger protocol
|
|
|
|
messages on `port`. The default `port` is `5858`.
|
2014-08-20 02:01:43 +00:00
|
|
|
|
2014-08-20 02:53:20 +00:00
|
|
|
### `--debug-brk=[port]`
|
2014-08-20 02:01:43 +00:00
|
|
|
|
|
|
|
Like `--debug` but pauses the script on the first line.
|
2014-08-20 02:43:41 +00:00
|
|
|
|
2015-09-01 02:12:57 +00:00
|
|
|
## Use node-inspector for Debugging
|
2014-08-20 02:43:41 +00:00
|
|
|
|
2015-12-02 10:23:21 +00:00
|
|
|
__Note:__ Electron doesn't currently work very well
|
2015-09-01 02:12:57 +00:00
|
|
|
with node-inspector, and the main process will crash if you inspect the
|
2014-08-20 02:43:41 +00:00
|
|
|
`process` object under node-inspector's console.
|
|
|
|
|
2014-08-20 02:53:20 +00:00
|
|
|
### 1. Start the [node-inspector][node-inspector] server
|
2014-08-20 02:43:41 +00:00
|
|
|
|
|
|
|
```bash
|
|
|
|
$ node-inspector
|
|
|
|
```
|
|
|
|
|
2015-04-16 03:31:12 +00:00
|
|
|
### 2. Enable debug mode for Electron
|
2014-08-20 02:43:41 +00:00
|
|
|
|
2015-04-16 03:31:12 +00:00
|
|
|
You can either start Electron with a debug flag like:
|
2014-08-20 02:43:41 +00:00
|
|
|
|
|
|
|
```bash
|
2015-04-16 03:31:12 +00:00
|
|
|
$ electron --debug=5858 your/app
|
2014-08-20 02:43:41 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
or, to pause your script on the first line:
|
|
|
|
|
|
|
|
```bash
|
2015-04-16 03:31:12 +00:00
|
|
|
$ electron --debug-brk=5858 your/app
|
2014-08-20 02:43:41 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
### 3. Load the debugger UI
|
|
|
|
|
2015-05-12 15:29:00 +00:00
|
|
|
Open http://127.0.0.1:8080/debug?ws=127.0.0.1:8080&port=5858 in the Chrome browser.
|
2014-08-20 02:43:41 +00:00
|
|
|
|
2014-08-20 02:53:20 +00:00
|
|
|
[node-inspector]: https://github.com/node-inspector/node-inspector
|