AppCode 2017.1 Help

Run/Debug Configurations

Run | Edit Configurations
⌥⇧F10
⌥⇧F9

Run Menu

Use this dialog box to create, edit, or remove run/debug configurations, and configure the default settings that will apply to all newly created run/debug configurations.

The default settings are grouped under the Defaults node in the left-hand part of the dialog box.

Click here for the description of the options that are common for all run/debug configurations.

Find the descriptions of specific run/debug configurations in the following pages:

Common options

ItemDescription
NameIn this text box, specify the name of a new run/debug configuration. This field is not available for the default run/debug configurations.
Defaults This node in the left-hand pane contains the default run/debug configuration settings. Select configuration to modify its default settings in the right-hand pane. The defaults are applied to all newly created run/debug configurations.
Share Select this check box to make the run/debug configuration available to other team members.

The shared run/debug configurations are kept in separate xml files under .idea\runConfigurations folder, while the local run/debug configurations are kept in the .idea\workspace.xml.

This check box is not available when editing the run/debug configuration defaults.

Before launchUse the controls in this area to specify which tasks must performed before applying the run/debug configuration. The tasks are performed in the order they appear in the list. The following options are available:
  • /help/img/idea/2017.1/new.png (N/A): click this icon to add a task to the list. Select one of the following task types:
    • Run External tool: select this option to run an application that is external to AppCode. In the dialog that opens, select the application(s) that you want to run. If the required application is not defined in AppCode yet, add its definition (for details see Configuring Third-Party Tools and External Tools).
    • Run Another Configuration: select this option to execute one on the existing run/debug configuration. Choose a configuration to execute from the dialog box that opens.
    • Compile TypeScript: select 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 check box to configure the behaviour of the compiler in case any errors are detected:
      • If the Check errors check box is selected, the compiler will show all the errors and the run configuration will not start.
      • If the Check errors check box is cleared, the compiler will show all the detected errors but the run configuration still will be launched.
    • Run File Watcher: select this option to run the File Watchers that are active in the current project. For more information, see Using File Watchers.
    • Generate CoffeeScript Source Maps: select this option to generate source maps for your CoffeeScript sources. In the dialog that opens, specify the path to the folder where CoffeeScript files will be generated. For more information, see CoffeeScript Support.
    • Run Remote External tool: select this option to run a remote SSH external tool. In the dialog that opens, specify the SSH external tool that you want to run. For more information, see Remote SSH External Tools.
  • /help/img/idea/2017.1/delete.png (⌥⌦): click this icon to remove the selected task from the list.
  • /help/img/idea/2017.1/edit1.png (): click this icon to modify the selected task. Edit the task settings in the dialog that opens.
  • /help/img/idea/2017.1/arrowUp.png (⌥↑): click this icon to move the selected task up in the list.
  • /help/img/idea/2017.1/arrowDown.png (⌥↓): click this icon to move the selected task down in the list.
  • Show this page: select this check box if you want to display the run/debug configuration settings before applying it.
  • Active tool window: select this option if you want the Run/Debug tool windows to be activated automatically when you run/debug your application. This option is enabled by default.
ItemDescription
Confirm rerun with process terminationThe behavior of this button depends on selecting the check box Single instance only for a particular run/debug configuration.
  • If this check box is selected, then, in case of a single instance, launching a new process (for example, by clicking /help/img/idea/2017.1/run.png on the main toolbar) while the other process is still running, results in showing a dialog box, where one should confirm termination of the current process and launching a new one.
  • If this check box is not selected (or in case of multiple instances), AppCode 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.
Working directoryIn this text box, specify the current directory to be used by the running test. This directory is the starting point for all relative input and output paths. By default, the field contains the directory where the project file resides. To specify another directory, click the Browse button browseButton.png select the directory in the dialog that opensdialog that opens .
Environment variablesClick the Browse button browseButton.png to open the Environment Variables dialog box, where you can create variables and specify their values.

Note that you can copy-paste the contents of the Environment variables field without having to open the Environment Variables dialog box.

Before Launch

Specify which tasks must be performed before applying the run/debug configuration. The specified tasks are performed in the order they appear in the list.
ItemKeyboard shortcutDescription
/help/img/idea/2017.1/new.png N/A Click this icon to add a task to the list. Select the task to be added:
  • Run External tool. Select this option to run an application which is external to AppCode. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in AppCode yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
  • Run Another Configuration. Select this option to have another run/debug configuration executed. In the dialog that opens, select the configuration to run.

    This option is available only if you have already at least one run/debug configuration in the current project.

  • Run File Watchers. Select this option to have AppCode apply all the currently active file watchers, see Using File Watchers for details.
  • 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 Grunt 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 npm Script. Select this check box to execute an npm script. In the NPM Script dialog box that opens, specify the package.json file where the required script is defined, select the script to execute, choose the command to apply to it, and specify the arguments to execute the script with.

    Specify the location of the Node.js interpreter and the parameters to pass to it.

  • Compile TypeScript. Select 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 check box to configure the behaviour of the compiler in case any errors are detected:
    • If the Check errors check box is selected, the compiler will show all the errors and the run configuration will not start.
    • If the Check errors check box is cleared, the compiler will show all the detected errors but the run configuration still will be launched.
  • 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. For more information, see Configuring Synchronization with a Web Server and Uploading and Downloading Files.
/help/img/idea/2017.1/delete.png ⌥⌦ Click this icon to remove the selected task from the list.
/help/img/idea/2017.1/edit1.png Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
/help/img/idea/2017.1/arrowUp.png ⌥↑ Click this icon to move the selected task one line up in the list.
/help/img/idea/2017.1/arrowDown.png ⌥↓ Click this icon to move the selected task one line down in the list.
Show this page Select this check box to have the run/debug configuration settings shown prior to actually starting the run/debug configuration.
Active tool windowSelect this option if you want the Run/Debug tool windows to be activated automatically when you run/debug your application. This option is enabled by default.

See Also

Last modified: 28 March 2017