AppCode 2021.2 Help

Run/debug configurations

AppCode uses run/debug configurations to run, debug, and test your code. Each configuration is a named set of startup properties that define what to execute and what parameters and environment should be used.

When you create a new configuration for a specific kind of executable context, you create it from one of the dedicated configuration templates, which implement the startup logic, define the list of parameters and their default values. The list of available templates is predefined in the installation and can only be extended via plugins. However, you can edit default values of parameters in each template to streamline the creation of new configurations.

Run/debug configurations in AppCode are the equivalents of the Xcode schemes, and they are kept synced with them.

If the Navigation bar is visible (View | Appearance | Navigation Bar), you can access all available run/debug configurations from the selector on the toolbar.

Run Menu

Scroll to the bottom of the list to find them:

Run/debug configurations

Run/debug configurations can be created as:

  • Temporary — created every time you are running a test class or method are using the gutter icons Icons actions execute/ Icons run configurations test state run run.
    The maximum number of temporary configurations is 5. The older ones are automatically deleted when new ones are added. If necessary, you can increase this limit in Preferences | Advanced Settings | IDE | Temporary Run/Debug configurations limit.

  • Permanent — created explicitly from a template or by saving a temporary configuration. Permanent configurations remain as part of your project until you remove them.

So whenever you run/debug or test your code, AppCode either uses an existing permanent run/debug configuration or creates a new temporary one.

Permanent configurations have opaque icons while the icons of temporary configurations are semi-transparent.

Permanent and temporary configurations have different icons

Create permanent run/debug configurations

AppCode provides the following ways to create a permanent run/debug configuration:

Create a permanent run/debug configuration from a test method or class

  1. Place the caret at the declaration of a test method or class and press ⌥⏎. AppCode creates a permanent run/debug configuration of the corresponding type.

    Create run configuration for a class
  2. Set up the run/debug configuration parameters.

Save a temporary configuration as permanent

  • Select a temporary configuration in the run/debug configuration switcher and then click Save Configuration.

    Save a temporary run configuration
  • Alternatively, select a temporary configuration in the Run/debug configurations dialog and click Save on the toolbar.

AppCode provides run/debug configuration templates for different languages, tools, and frameworks. The list of available templates varies depending on the installed and enabled plugins.

Create a run/debug configuration from a template

  1. Open the Run/Debug Configuration dialog in one of the following ways:

    • Select Run | Edit Configurations from the main menu.

    • With the Navigation bar visible (View | Appearance | Navigation Bar), choose Edit Configurations from the run/debug configuration selector.

    • Press ⌥⇧F10 and then press 0.

  2. In the Run/Debug Configuration dialog, click Icons general add on the toolbar or press ⌘N. The list shows the run/debug configuration templates.

    Select the desired template. If you are not sure which template to choose, refer to Run/debug configurations dialog for more information on particular templates.

    Selecting a new run/debug configuration template
  3. Specify the run/debug configuration name in the Name field. This name will be shown in the list of the available run/debug configurations.

  4. Select Allow parallel run if you want to allow multiple instances of the configuration to run at the same time. If this option is disabled, attempting to re-run the configuration will terminate the active session.

  5. Set the run/debug configuration parameters. The list of mandatory and optional parameters may vary depending on the selected run/debug configuration type.

    For the detailed description of the selected template, see the respective section of run/debug configurations reference.

  6. In the Before launch section, define whether you want to perform any specific actions before launching the application, for example, launch an external tool or another build configuration before run. To skip the build stage, remove Build from the Before launch list.

    For information on particular Before launch activities, refer to Before launch

  7. Apply the changes and close the dialog.

Share run/debug configurations

If you are working in a team, you might want to share your run/debug configurations so that your teammates could run the application using the same configuration.

For these purposes, AppCode provides a mechanism to store your run/debug configurations as project files and share them through VCS. The same mechanism can also be used when you want to send your configuration as a file to someone else. This saves a lot of time as run/debug configurations sometimes get sophisticated, and keeping them in sync manually would be tedious and error-prone.

  1. From the main menu, select Run | Edit Configurations. Alternatively, press ⌥⇧F10, then 0.

  2. Select the run/debug configuration you want to share, enable the Store as project file option, and specify the location where the configuration file will be stored.

    If compatibility with AppCode 2019.3 and earlier is required, store the file in the default location.

    Store as project file checkbox
  3. (Optional) If the .idea directory is added to VCS ignored files, the .idea/runConfigurations subfolder will be ignored, too. If you use Git for your project, you can share .idea/runConfigurations only and leave .idea ignored by modifying .gitignore as follows:

    /.idea/* !/.idea/runConfigurations

Run/debug configuration templates

Each type of run/debug configuration is a template that you can edit, so the next time you create a new configuration of that type, its parameters already have the desired values.

Configure the default values for a template

  1. From the main menu, select Run | Edit Configurations. Alternatively, press ⌥⇧F10, then 0.

  2. In the left-hand pane of the run/debug configuration dialog, click Edit configuration templates.

    Run/Debug templates
  3. In the Run/Debug Configuration Templates dialog that opens, select a configuration type.

  4. Specify the desired default parameters and click OK to save the template.

Compound run/debug configurations

Suppose you would like to launch multiple run/debug configurations simultaneously. For example, you may want to run several configurations of different types or a group of test configurations. You can configure this behavior with a compound run/debug configuration.

Create a compound run/debug configuration

  1. From the main menu, select Run | Edit Configurations. Alternatively, press ⌥⇧F10, then 0.

  2. In the Run/Debug Configurations dialog, click the Add button or press ⌘N, then select Compound.

  3. Specify the run/debug configuration name in the Name field. This name will be shown in the list of the available run/debug configurations.

  4. To include a new run/debug configuration into the compound configuration, click Add the Add button and select the desired one from the list.

  5. If necessary, select a device or simulator on which the run/debug configuration will be executed:

    Select devices for compound configuration

    If you've selected a specific device/simulator for each configuration, Multiple specified is shown in the selector:

    Multiple devices selected for the compound configuration

    If you haven't specified any devices/simulators, the minimal simulator version is selected by default. However, you can choose the desired device or simulator from the selector.

  6. Apply the changes.

Run/debug configuration folders

When there are many run/debug configurations of the same type, you can group them in folders so they become easier to distinguish visually.

Once grouped, the run/debug configurations appear in the list under the corresponding folders.

Grouped run configurations

Create a folder for run/debug configurations

  1. From the main menu, select Run | Edit Configurations. Alternatively, press ⌥⇧F10, then 0.

  2. In the Run/Debug Configurations dialog, select a configuration type and click the New Folder icon on the toolbar. A new empty folder for the selected type is created.

  3. Specify the folder name in the text field to the right or accept the default name.

  4. Select the desired run/debug configurations and move them under the target folder.

  5. Apply the changes. If a folder is empty, it will not be saved.

When you no longer need a folder, you can delete it . The run/debug configurations grouped under this folder will be moved under the root of the corresponding run/debug configuration type.

Last modified: 10 September 2021