IntelliJ IDEA 2018.2 Help

Run/Debug Configuration: Android Application

Use this dialog box to create configurations used to run or debug Android applications and activities on actual or virtual devices.

This dialog box consists of three tabs:

General Tab

ItemDescription
Module From this drop-down list, select a module to which this configuration will be applied.
Installation OptionsUse this area to configure the following settings:
  • Deploy - use this drop-down list to appoint the .apk file that will be deployed to the target virtual or physical device. You can select one of the following options:
    • Default APK - select this option to have IntelliJ IDEA upload the .apk built from the module specified in the Module drop-down list above. The .apk is built automatically, no preliminary artifact configuration is required from your side.
    • Custom Artifact - select this option to have IntelliJ IDEA upload the .apk built from the code and resources appointed in a manually configured artifact. Select an artifact from the drop-down list which shows all manually created artifact definitions for the selected module. See Working with Artifacts for details.
    • Nothing - select this option to suppress uploading data to the device. This approach may be helpful if you have already deployed your application manually outside IntelliJ IDEA.
  • Install Flags - use this field to specify options for the pm install command.
    For more information, see the package manager page.
Launch Options In this area, appoint the activity that will be launched on the application start.
  • Launch - use this drop-down list to specify the following launch settings:
    • Default Activity - select this option to have IntelliJ IDEA automatically launch the activity marked as start-up.
    • Nothing - select this option to connect to an already running application provided that you have chosen Nothing in the Installation Options area. Executing a run configuration with these settings is the same as clicking the Attach debugger to Android process button addAndroidDebuggerToProcess.png on the toolbar.
    • Specified Activity - select this option to have IntelliJ IDEA launch an activity of your choice upon the application start. This option may be helpful when you want to run or debug a part of your application and have already chosen the Custom Artifact option in the Installation Options area. Type the activity name manually or click Browse browseButton.png and select it in the Select Activity Class dialog box that opens.

      The list of available activities is determined by the choice of the module.

    • URL - select this option to launch a browser when you run your application. You can specify the URL address in the URL field.
  • Launch Flags - use this field to specify additional options for the am start command.
    For more information, see the activity manager page.
Deployment Target Options In this area, select the type of device to run/debug the application on. The available options are:
  • Show Device Chooser Dialog: select this option to have IntelliJ IDEA display the Choose Device dialog box upon the application start.

    If you want to automatically use the device chosen through the Choose Device dialog in the future, select the Use same device for future launches option.

  • USB Device: select this option to have IntelliJ IDEA detect a plugged-in USB device upon the application start.
  • Emulator: select this option to use one of the configured device emulators. From the Prefer Android Virtual Device drop-down list, select a virtual device that will be used to run/debug the specified activity. If you want to add/edit a virtual device configuration, click the Browse button browseButton.png to launch the Android Virtual Device (AVD) Manager (see Managing Virtual Devices for details).

Miscellaneous Tab

In this tab, configure the scope of log data shown during a run/debug session.

ItemDescription
LogcatUse this area to configure logcat settings for your Android run/debug configuration:
  • Show logcat automatically: select this checkbox to show logcat automatically every time an application is deployed and launched successfully.
  • Clear log before launch: select this checkbox if you want data from previous sessions to be removed from the log file before starting the application.
Installation OptionsUse this area to configure the installation options for running or debugging your Android application:
  • Skip installation if APK has not changed: select this checkbox to skip APK installation when you run your application if the APK has not changed.
  • Force stop running application before launching activity: select this checkbox to stop running an already launched application before you start running the activity from IntelliJ IDEA.

Profiling Tab

In this tab, specify the Graphic Trace options.

ItemDescription
Disable precompiled shaders and programsSelect this checkbox if you want to disable precompiled shaders and programs and compile them at the runtime instead.

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 Templates View and edit the default template for the selected run/debug configuration. The templates 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.

Templates

When you select Templates 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: 18 June 2018

See Also