IntelliJ IDEA 2018.2 Help

Run/Debug Configuration: Pyramid Server

Use this dialog box to create a run/debug configuration for launching a Pyramid server.

Configuration tab

ItemDescription
Config fileIn this field, specify the name of the configuration file development.ini.
Additional optionsIn this field, type the additional options to be passed to the server.

These are the options that pserve accepts. Use pserve --help to learn more about the additonal options.

    Run browserSelect this check box, if you want your Pyramid application to open in the default browser. In the text field below, enter the IP address where your application will be opened.
    ProjectClick this drop-down list to select one of the projects, opened in the same IntelliJ IDEA window, where this run/debug configuration should be used. If there is only one open project, this field is not displayed.
    Environment variablesThis field shows the list of environment variables. If the list contains several variables, they are delimited with semicolons.
    By default, the field contains the variable PYTHONUNBUFFERED set to 1. To fill in the list, click the browse button, or press Shift+Enter and specify the desired set of environment variables in the Environment Variables dialog box.
    To create a new variable, click icons general add, and type the desired name and value. You might want to populate the list with the variables stored as a series of records in a text file, for example:
    Variable1 = Value1 Variable2 = Value2
    Just copy the list of variables from the text file and click Paste (Paste) in the Environmental Variables dialog box. The variables will be added to the table. Click Ok to complete the task. At any time, you can select all variables in the Environment Variables dialog box, click Copy (Copy), and paste them into a text file.
    Python Interpreter
    Interpreter optionsIn this field, specify the string to be passed to the interpreter. If necessary, click shift enter button, and type the string in the editor.
    Working directorySpecify a directory to be used by the running task.
    • When a default run/debug configuration is created by the keyboard shortcut Ctrl+Shift+F10, or by choosing Run on the context menu of a script, the working directory is the one that contains the executable script. This directory may differ from the project directory.
    • When this field is left blank, the bin directory of the IntelliJ IDEA installation will be used.
    Path mappingsThis field appears, if a remote interpreter has been selected in the field Python interpreter.
    Click the browse button browseButton to define the required mappings between the local and remote paths. In the Edit Path Mappings dialog box, use icons general add/icons general remove svg buttons to create new mappings, or delete the selected ones.
    Add content roots to PYTHONPATHSelect this check box to add all content roots of your project to the environment variable PYTHONPATH;
    Add source roots to PYTHONPATHSelect this check box to add all source roots of your project to the environment variable PYTHONPATH;

    Logs tab

    Use this tab to specify which log files generated while running or debugging should be displayed in the console, that is, on the dedicated tabs of the Run or Debug tool window.

    ItemDescription
    Is ActiveSelect check boxes in this column to have the log entries displayed in the corresponding tabs in the Run tool window or Debug tool window.
    Log File Entry

    The read-only fields in this column list the log files to show. The list can contain:

    • Full paths to specific files.
    • Ant patterns that define the range of files to be displayed.
    • Aliases to substitute for full paths or patterns. These aliases are also displayed in the headers of the tabs where the corresponding log files are shown.

      If a log entry pattern defines more than one file, the tab header shows the name of the file instead of the log entry alias.

    Skip ContentSelect this check box to have the previous content of the selected log skipped.
    Save console output to fileSelect this check box to save the console output to the specified location. Type the path manually, or click the browse button and point to the desired location in the dialog that opens.
    Show console when a message is printed to standard output streamSelect this check box to activate the output console and bring it forward if an associated process writes to Standard.out.
    Show console when a message is printed to standard error streamSelect this check box to activate the output console and bring it forward if an associated process writes to Standard.err.
    icons general add svgClick this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.
    icons actions edit svgClick this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.
    icons general remove svgClick this button to remove the selected log entry from the list.

    Common options

    When you edit a run configuration (but not a run configuration template), you can specify the following options for it:

    ItemDescription
    Name In this text box, specify the name for the run/debug configuration. The name will help you identify the created configuration when you choose to edit it later, or when you invoke it, for example. from the Run popup (Shift+Alt+F10).
    Share Select this check box to make the run/debug configuration available to other team members.

    If the directory-based project format is used, the settings for a run/debug configuration are stored in a separate .xml file in the .idea\runConfigurations folder if the run/debug configuration is shared, or in the .idea\workspace.xml file otherwise.

    If the file-based format is used, the settings are stored in the .ipr file for shared configurations, or in the .iws file otherwise.

    Single instance only

    Toolbar

    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.

    ItemShortcutDescription
    icons general add svgAlt+InsertCreate a run/debug configuration.
    icons general remove svgAlt+Delete Delete the selected run/debug configuration. Note that you cannot delete default configurations.
    icons actions copy svg Ctrl+D Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.
    icons general settings svg Edit defaults View and edit the default template for the selected run/debug configuration. The defaults are used for newly created configurations.
    icons actions moveUp svg/icons actions moveDown svgAlt+Up/Alt+Down

    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.

    folder 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 to be grouped, click folder, and specify the name for the folder. 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-and-drop or icons actions moveUp svg and icons actions moveDown svg buttons.

    To remove grouping, select a folder and click icons general remove svg.

    icons objectBrowser sorted svg Sort configurations Click this button to sort configurations in alphabetical order.

    Defaults

    When you select Defaults in the tree view of the run configurations, you can adjust some settings that apply for all run debug configurations.

    ItemDescription
    Configurations available in Run Dashboard

    In this section you can create a list of run configurations available in the Run Dashboard — tool window that helps you execute and manage multiple run/debug configurations.

    Note that the dashboard will only display those configuration types for which you have created one ore more configurations.
    So if you add a configuration type for which no configurations exist in the project, this type will not be displayed on the dashboard until you create a configuration of this type.

    Confirm rerun with process terminationThe behavior of this checkbox depends on whether the Single instance only checkbox is selected for a particular run/debug configuration.
    • If this checkbox is selected, then, in case of a single instance, launching a new process (for example, by clicking run on the main toolbar) while another process is still running, results in showing a dialog box prompting to terminate the current process before launching a new one.
    • If this checkbox is not selected (or in case of multiple instances), IntelliJ IDEA starts the new process silently.
    Temporary configurations limit Specify here the maximum number of temporary configurations to be stored and shown in the Select Run/Debug Configuration drop-down list.

    Before Launch options

    In this area you can specify tasks that should be carried out before starting the selected run/debug configuration. The specified tasks are performed in the order they appear in the list.

    ItemShortcutDescription
    icons general add svgAlt+Insert Click this icon to add one of the following available tasks:
    • Run External tool — select this option to run an application which is external to IntelliJ IDEA. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in IntelliJ IDEA yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
    • Make — select this option to have the project or module compiled. The Make Module command will be carried out if a particular module is specified in the run/debug configuration, and the Make Project command otherwise.

      If an error occurs during the compilation, IntelliJ IDEA won't attempt to start the run/debug configuration.

    • Make, no error check — the same as the Make option but IntelliJ IDEA will try to start the run/debug configuration irrespective of the compilation result.
    • Build Artifacts — select this option to build an artifact or artifacts. In the dialog that opens, select the artifact or artifacts that should be built.
    • Run Another Configuration — select this option to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.
    • Run Ant target — select this option to run an Ant target. In the dialog that opens, select the target to be run.
    • Run Grunt task — select this option to run a Grunt task. In the Grunt task dialog box 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 box 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 Maven Goal — select this option to run a Maven goal. In the dialog that opens, select the goal to be run.
    • Run npm Script — select this option to execute an npm script. In the NPM Script dialog box that opens, specify the npm run/debug configuration settings.
    • Start React Native Bundler — - elect this option to run the bundler automatically, as part of a running or debugging session. by default, this is done through react-native start. If your application uses Expo, you need to run the development server via the start npm task. To do that, clickicons actions edit svg, then in the Configure React Native dialog, choose npm script and select start from the list.
    • Compile TypeScript — elect this option to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected:
      • 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.
    • Upload files to Remote Host — select this option to have the application files automatically uploaded to the server according to the default server access configuration.
    • Run Remote External tool — adds a remote SSH external tool.
    • Run Rake task — add a Rake task to be executed prior to running or debugging. To choose a Rake task, click the browse button browseButton, and select the desired task from the list of available tasks.

      Note that code completion is available here.

      runConfigRakeTask
    • Run JRuby compiler: choose this option to execute JRuby compiler with the specified target path, compiler process heap size, and command line parameters (if any).
    icons general remove svgAlt+Delete Click this icon to remove the selected task from the list.
    icons actions edit svg Enter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
    icons actions moveUp svg/icons actions moveDown svgAlt+Up/Alt+DownClick 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 pageSelect this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.
    Activate tool window

    If this checkbox is selected, which it is by default, the Run or the Debug tool window opens when you start the run/debug configuration.

    Otherwise, the tool window isn't shown. 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: 14 June 2018

    See Also