electron/docs/tutorial/debugging-main-process.md

# Debugging the Main Process

The DevTools in an Electron browser window can only debug JavaScript that's
executed in that window (i.e. the web pages). To debug JavaScript that's
executed in the main process you will need to use an external debugger and
launch Electron with the `--inspect` or `--inspect-brk` switch.

## Command Line Switches

Use one of the following command line switches to enable debugging of the main
process:

### `--inspect=[port]`

Electron will listen for V8 inspector protocol messages on the specified `port`,
an external debugger will need to connect on this port. The default `port` is
`5858`.

```shell
electron --inspect=5858 your/app
```

### `--inspect-brk=[port]`

Like `--inspect` but pauses execution on the first line of JavaScript.

## External Debuggers

You will need to use a debugger that supports the V8 inspector protocol.

- Connect Chrome by visiting `chrome://inspect` and selecting to inspect the
  launched Electron app present there.
- [Debugging in VSCode](debugging-vscode.md)
Standardize debug main process 2015-09-01 02:12:57 +00:00			`# Debugging the Main Process`
Add "Debugging browser process" chapter. 2014-08-20 02:01:43 +00:00
Split up debugging-main-process.md, add electron-inspector guide - Move the debugging guides for VSCode and node-inspector into separate files. - Add instructions for using electron-inspector to the node-inspector guide. - Remove note in node-inspector guide about crashing when inspecting `process` (it was fixed a long time ago: https://github.com/nodejs/node-v0.x-archive/issues/8205) 2016-09-21 09:39:15 +00:00			`The DevTools in an Electron browser window can only debug JavaScript that's`
			`executed in that window (i.e. the web pages). To debug JavaScript that's`
			`executed in the main process you will need to use an external debugger and`
:memo: Fixed typo [ci skip] 2017-06-06 21:30:45 +00:00			launch Electron with the `--inspect` or `--inspect-brk` switch.
Add "Debugging browser process" chapter. 2014-08-20 02:01:43 +00:00
Standardize debug main process 2015-09-01 02:12:57 +00:00			`## Command Line Switches`

Split up debugging-main-process.md, add electron-inspector guide - Move the debugging guides for VSCode and node-inspector into separate files. - Add instructions for using electron-inspector to the node-inspector guide. - Remove note in node-inspector guide about crashing when inspecting `process` (it was fixed a long time ago: https://github.com/nodejs/node-v0.x-archive/issues/8205) 2016-09-21 09:39:15 +00:00			`Use one of the following command line switches to enable debugging of the main`
			`process:`
docs: Add chapter on debugging with node-inspector. 2014-08-20 02:43:41 +00:00
Update docs for new --inspect support 2017-05-15 16:34:55 +00:00			### `--inspect=[port]`
Add "Debugging browser process" chapter. 2014-08-20 02:01:43 +00:00
Update docs for new --inspect support 2017-05-15 16:34:55 +00:00			Electron will listen for V8 inspector protocol messages on the specified `port`,
Split up debugging-main-process.md, add electron-inspector guide - Move the debugging guides for VSCode and node-inspector into separate files. - Add instructions for using electron-inspector to the node-inspector guide. - Remove note in node-inspector guide about crashing when inspecting `process` (it was fixed a long time ago: https://github.com/nodejs/node-v0.x-archive/issues/8205) 2016-09-21 09:39:15 +00:00			an external debugger will need to connect on this port. The default `port` is
			`5858`.
Add "Debugging browser process" chapter. 2014-08-20 02:01:43 +00:00
Match example to node inspector doc 2016-10-31 16:27:42 +00:00			```shell
Update docs for new --inspect support 2017-05-15 16:34:55 +00:00			`electron --inspect=5858 your/app`
Added example usage for the default port According to Issue ##7756 I added the example usage. 2016-10-28 15:04:51 +00:00			```
Match example to node inspector doc 2016-10-31 16:27:42 +00:00
Update docs for new --inspect support 2017-05-15 16:34:55 +00:00			### `--inspect-brk=[port]`
Add "Debugging browser process" chapter. 2014-08-20 02:01:43 +00:00
Fix typo inspector to inspect 2017-11-06 00:23:18 +00:00			Like `--inspect` but pauses execution on the first line of JavaScript.
docs: Add chapter on debugging with node-inspector. 2014-08-20 02:43:41 +00:00
Split up debugging-main-process.md, add electron-inspector guide - Move the debugging guides for VSCode and node-inspector into separate files. - Add instructions for using electron-inspector to the node-inspector guide. - Remove note in node-inspector guide about crashing when inspecting `process` (it was fixed a long time ago: https://github.com/nodejs/node-v0.x-archive/issues/8205) 2016-09-21 09:39:15 +00:00			`## External Debuggers`
Add instruction for debugging main process in VSCode I hope you don't mind me putting the VSCode part before `node-inspector`, because VSCode seems easier to setup, and VSCode could inspect `process` without crashing. 2016-09-20 05:43:05 +00:00
Update docs for new --inspect support 2017-05-15 16:34:55 +00:00			`You will need to use a debugger that supports the V8 inspector protocol.`
Add instruction for debugging main process in VSCode I hope you don't mind me putting the VSCode part before `node-inspector`, because VSCode seems easier to setup, and VSCode could inspect `process` without crashing. 2016-09-20 05:43:05 +00:00
Make chrome instructions a list item 2017-05-15 16:40:00 +00:00			- Connect Chrome by visiting `chrome://inspect` and selecting to inspect the
			`launched Electron app present there.`
docs: add native c++ windows debugging method (#26286) 2020-11-07 00:55:55 +00:00			`- [Debugging in VSCode](debugging-vscode.md)`