| 
									
										
										
										
											2019-05-06 08:29:01 -07:00
										 |  |  | ## Class: CommandLine
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | > Manipulate the command line arguments for your app that Chromium reads
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-06-15 13:50:31 -07:00
										 |  |  | Process: [Main](../glossary.md#main-process)<br /> | 
					
						
							|  |  |  | _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._ | 
					
						
							| 
									
										
										
										
											2019-05-06 08:29:01 -07:00
										 |  |  | 
 | 
					
						
							|  |  |  | The following example shows how to check if the `--disable-gpu` flag is set. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-11-20 23:50:08 -08:00
										 |  |  | ```js | 
					
						
							| 
									
										
										
										
											2019-05-06 08:29:01 -07:00
										 |  |  | const { app } = require('electron') | 
					
						
							|  |  |  | app.commandLine.hasSwitch('disable-gpu') | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | For more information on what kinds of flags and switches you can use, check | 
					
						
							| 
									
										
										
										
											2019-10-04 19:49:09 +02:00
										 |  |  | out the [Command Line Switches](./command-line-switches.md) | 
					
						
							| 
									
										
										
										
											2019-05-06 08:29:01 -07:00
										 |  |  | document. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ### Instance Methods
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | #### `commandLine.appendSwitch(switch[, value])`
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-04-04 08:02:14 -05:00
										 |  |  | * `switch` string - A command-line switch, without the leading `--`. | 
					
						
							|  |  |  | * `value` string (optional) - A value for the given switch. | 
					
						
							| 
									
										
										
										
											2019-05-06 08:29:01 -07:00
										 |  |  | 
 | 
					
						
							|  |  |  | Append a switch (with optional `value`) to Chromium's command line. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | **Note:** This will not affect `process.argv`. The intended usage of this function is to | 
					
						
							|  |  |  | control Chromium's behavior. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-04-04 08:02:14 -05:00
										 |  |  | ```js | 
					
						
							|  |  |  | const { app } = require('electron') | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | app.commandLine.appendSwitch('remote-debugging-port', '8315') | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2019-05-06 08:29:01 -07:00
										 |  |  | #### `commandLine.appendArgument(value)`
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-04-04 08:02:14 -05:00
										 |  |  | * `value` string - The argument to append to the command line. | 
					
						
							| 
									
										
										
										
											2019-05-06 08:29:01 -07:00
										 |  |  | 
 | 
					
						
							|  |  |  | Append an argument to Chromium's command line. The argument will be quoted | 
					
						
							|  |  |  | correctly. Switches will precede arguments regardless of appending order. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | If you're appending an argument like `--switch=value`, consider using `appendSwitch('switch', 'value')` instead. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-04-04 08:02:14 -05:00
										 |  |  | ```js | 
					
						
							|  |  |  | const { app } = require('electron') | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | app.commandLine.appendArgument('--enable-experimental-web-platform-features') | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2019-05-06 08:29:01 -07:00
										 |  |  | **Note:** This will not affect `process.argv`. The intended usage of this function is to | 
					
						
							|  |  |  | control Chromium's behavior. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | #### `commandLine.hasSwitch(switch)`
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-04-04 08:02:14 -05:00
										 |  |  | * `switch` string - A command-line switch. | 
					
						
							| 
									
										
										
										
											2019-05-06 08:29:01 -07:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-11-16 05:13:18 +01:00
										 |  |  | Returns `boolean` - Whether the command-line switch is present. | 
					
						
							| 
									
										
										
										
											2019-05-06 08:29:01 -07:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-04-04 08:02:14 -05:00
										 |  |  | ```js | 
					
						
							|  |  |  | const { app } = require('electron') | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | app.commandLine.appendSwitch('remote-debugging-port', '8315') | 
					
						
							|  |  |  | const hasPort = app.commandLine.hasSwitch('remote-debugging-port') | 
					
						
							|  |  |  | console.log(hasPort) // true | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2019-05-06 08:29:01 -07:00
										 |  |  | #### `commandLine.getSwitchValue(switch)`
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-04-04 08:02:14 -05:00
										 |  |  | * `switch` string - A command-line switch. | 
					
						
							| 
									
										
										
										
											2019-05-06 08:29:01 -07:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-11-16 05:13:18 +01:00
										 |  |  | Returns `string` - The command-line switch value. | 
					
						
							| 
									
										
										
										
											2019-05-06 08:29:01 -07:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-04-04 08:02:14 -05:00
										 |  |  | This function is meant to obtain Chromium command line switches. It is not | 
					
						
							|  |  |  | meant to be used for application-specific command line arguments. For the | 
					
						
							|  |  |  | latter, please use `process.argv`. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```js | 
					
						
							|  |  |  | const { app } = require('electron') | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | app.commandLine.appendSwitch('remote-debugging-port', '8315') | 
					
						
							|  |  |  | const portValue = app.commandLine.getSwitchValue('remote-debugging-port') | 
					
						
							|  |  |  | console.log(portValue) // '8315' | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2019-05-06 08:29:01 -07:00
										 |  |  | **Note:** When the switch is not present or has no value, it returns empty string. | 
					
						
							| 
									
										
										
										
											2021-10-06 13:45:58 -07:00
										 |  |  | 
 | 
					
						
							|  |  |  | #### `commandLine.removeSwitch(switch)`
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-04-04 08:02:14 -05:00
										 |  |  | * `switch` string - A command-line switch. | 
					
						
							| 
									
										
										
										
											2021-10-06 13:45:58 -07:00
										 |  |  | 
 | 
					
						
							|  |  |  | Removes the specified switch from Chromium's command line. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-04-04 08:02:14 -05:00
										 |  |  | ```js | 
					
						
							|  |  |  | const { app } = require('electron') | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | app.commandLine.appendSwitch('remote-debugging-port', '8315') | 
					
						
							|  |  |  | console.log(app.commandLine.hasSwitch('remote-debugging-port')) // true | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | app.commandLine.removeSwitch('remote-debugging-port') | 
					
						
							|  |  |  | console.log(app.commandLine.hasSwitch('remote-debugging-port')) // false | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-10-06 13:45:58 -07:00
										 |  |  | **Note:** This will not affect `process.argv`. The intended usage of this function is to | 
					
						
							|  |  |  | control Chromium's behavior. |