AppCode 2020.3 Help

Application

Run | Edit Configurations | Add New Configuration | Application

ItemDescription
TargetSelect the necessary target from the list.
ConfigurationSelect the configuration type — Debug or Release.
ExecutableSelect a proper executable for your configuration.
Program arguments

In this field, type a list of arguments to be passed to the program in the format you would use in the command line. If necessary, click the the Expand button button and type the desired arguments.

Working directory

Specify the working directory to be used for running the application. 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 and select the directory.

Expand the list to view available path variables that you can use as a path to your working directory. In this case you do not need to specify any additional environment variables in the Environment variables field.

Environment variables

Create environment variables and specify their values.

ItemDescription
Allow location simulationEnable location simulation for the current run/debug configuration.
Location

When the Allow location simulation checkbox is enabled, you can choose the location that will be simulated on your device or simulator. By defaul, the value is set to None, which means that the current device location will be used.

If you cannot find necessary locations in the list, use GPX files to add them. For more information, refer to Simulate location.

Application languageSelect the application language that will be set at runtime.
Application regionSelect the application region that will be set at runtime.
Make application active after launchIf the checkbox is selected, the application will be brought to the foreground after launch. Otherwise, it will run in the background while the IDE stays in focus. This setting is relevant for OS X applications only.

These settings are available only when the Reveal application is installed on your Mac. More information on integration with Reveal see in Debugging iOS Apps with Reveal.

ItemDescription
Inject Reveal library on launchSelect this checkbox to have the Reveal library automatically added to your project on launching Reveal.
Upload Reveal library on the device if necessarySelect this checkbox to have the Reveal library uploaded and signed on your device.

Common

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

Item

Description

Name

Specify a name for the run/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup ⌥⇧F10.

Allow parallel run

Select to allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, AppCode suggests to stop the running instance and start another one. This is helpful when a run/debug configuration consumes a lot of resources and there is no good reason to run multiple instances.

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 AppCode stores run configuration settings in .idea/workspace.xml.

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
the Add button⌘NCreate a run/debug configuration.
the Remove button⌥⌦Delete the selected run/debug configuration. Note that you cannot delete default configurations.
Copy⌃DCreate a copy of the selected run/debug configuration. Note that you create copies of default configurations.
Save configurationThe button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.
Edit TemplatesView 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.
Method up/ Method 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.

Move into new folder / Create new 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, click Folder, 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 Move Up and Move Down buttons.

To remove grouping, select a folder and click Remove Configuration.

Sort configurations Click this button to sort configurations in the alphabetical order.

Before Launch

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.

ItemShortcutDescription
the Add button⌘N

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 AppCode 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 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.
  • Compile TypeScript: select 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.

the Remove button⌥⌦Click this icon to remove the selected task from the list.
EditClick this icon to edit the selected task. Make the necessary changes in the dialog that opens.
Method up/ Method 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 pageSelect 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 ⌥4 or ⌥5.

Last modified: 08 March 2021