electron/docs/tutorial/debugging-main-process.md
2015-08-31 19:12:57 -07:00

50 lines
1.3 KiB
Markdown

# Debugging the Main Process
The browser window devtools can only debug the renderer process scripts (i.e.
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.
## Command Line Switches
Use the following command line switches to debug Electron's main process:
### `--debug=[port]`
When this switch is used Electron will listen for V8 debugger protocol
messages on `port`. The default `port` is `5858`.
### `--debug-brk=[port]`
Like `--debug` but pauses the script on the first line.
## Use node-inspector for Debugging
__Note:__ Electron uses node v0.11.13, which currently doesn't work very well
with node-inspector, and the main process will crash if you inspect the
`process` object under node-inspector's console.
### 1. Start the [node-inspector][node-inspector] server
```bash
$ node-inspector
```
### 2. Enable debug mode for Electron
You can either start Electron with a debug flag like:
```bash
$ electron --debug=5858 your/app
```
or, to pause your script on the first line:
```bash
$ electron --debug-brk=5858 your/app
```
### 3. Load the debugger UI
Open http://127.0.0.1:8080/debug?ws=127.0.0.1:8080&port=5858 in the Chrome browser.
[node-inspector]: https://github.com/node-inspector/node-inspector