PyCharm supports debugging client-side applications running on the built-in or an external web server. Debugging can be performed only using Google Chrome and other browsers of the Chrome family. Debugging applications running on the built-in server is supported for Firefox, version 36 an higher, through the Firefox Remote debug configuration. Debugging applications running on external web servers in Firefox is not supported at all.
- Debugging a Dart web application:
In this field, specify the URL address of the HTML file that references the Dart code to debug in the format: http://localhost:<built-in server port>/<project-name>/<relative path to the HTML file>. Make sure the port in this URL address is the same as the Built-in server port on the Debugger page.
From this list, select Chrome or another browser from the Chrome family where your application will be debugged.
| Ensure breakpoints are detected when loading scripts |
Select this checkbox to make sure that the breakpoints in the code executed on the page load are hit immediately. Note that this may slow down initial page load.
|Remote URLs of local files|
PyCharm displays this area only when you create a permanent debug configuration manually. For automatically generated temporary configurations the area is not shown.
In this area, map the local files to be involved in debugging to the URL addresses of their copies on the server.
File/Directory - in this read-only field, select the desired local file or directory in the project tree.
Remote URL - in this field, type the absolute URL address of the corresponding file or folder on the server.
These mappings are required only if the local folder structure under the project root differs from the folder structure on the server. If the structures are identical, PyCharm itself "retrieves" the paths to local files by parsing the URL addresses of their copies on the server.
- Debugging a Dart web application:
PyCharm displays this area only when the port specified in the URL field is different from the port of the built-in Web server specified on the Debugger page of the Preferences dialog.
When you edit a run configuration (but not a run configuration template), you can specify the following options:
Specify a name for the run/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup Alt+Shift+F10.
Store as project file
Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.
By default, it is disabled, and PyCharm stores run configuration settings in .idea/workspace.xml.
The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.
|Alt+Insert||Create a run/debug configuration.|
|Alt+Delete|| Delete the selected run/debug configuration. Note that you cannot delete default configurations. |
|Ctrl+D|| Create a copy of the selected run/debug configuration. Note that you create copies of default configurations. |
|The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent. |
| View and edit the template (that is, the default run/debug configuration settings). The templates are displayed under the Templates node and used for newly created configurations. |
Move the selected run/debug configuration up and down in the list.
The order of configurations in the list defines the order, in which the configurations appear when you choose a run/debug configuration.
Default templates of run/debug configurations are always sorted alphabetically.
Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders.
To create a folder, select the configurations within a category, click , and specify the folder name. If only a category is in focus, an empty folder is created.
Then, to move a configuration into a folder, between the folders or out of a folder, use drag or and buttons.
To remove grouping, select a folder and click .
| Click this button to sort configurations in the alphabetical order. |
In this area you can specify tasks that must be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.
Click this icon to add one of the following available tasks:
Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in PyCharm yet, add its definition. For more information, see External tools and External Tools.
Run Another Configuration: select to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.
Run File Watchers: select this option to have PyCharm apply all the currently active File Watchers.
Run Grunt task: select this option to run a Grunt task. In the Grunt task dialog that opens, specify the Gruntfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool.
Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the grunt-cli package.
Run Gulp task: select this option to run a Gulp task. In the Gulp task dialog that opens, specify the Gulpfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool.
Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the gulp package.
Run npm Script: select this option to execute an npm script. In the NPM Script dialog that opens, specify the npm run/debug configuration settings.
If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start.
If the Check errors checkbox is cleared, the compiler will show all the detected errors but the run configuration still will be launched.
Generate CoffeeScript Source Maps: select this option to generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located.
Run Remote External tool: adds a remote SSH external tool.
|Alt+Delete|| Click this icon to remove the selected task from the list. |
|Enter||Click this icon to edit the selected task. Make the necessary changes in the dialog that opens. |
|/||Alt+Up/Alt+Down||Click these icons to move the selected task one line up or down in the list. The tasks are performed in the order that they appear in the list. |
|Show this page||Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration. |
|Activate tool window|
By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration.
Otherwise, if the checkbox is cleared, the tool window is hidden. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5.
Last modified: 23 June 2020