RubyMine 2018.2 Help

Run/Debug Configuration: PhoneGap/Cordova

Run | Edit Configurations | icons general add svg | PhoneGap/Cordova

Use this dialog box to create configurations for running and debugging applications developed through integration with the help of PhoneGap, Apache Cordova, and Ionic frameworks and intended for running on various mobile platforms, including Android.

Getting access to the Run/Debug Configuration: PhoneGap/Cordova dialog

Make sure the PhoneGap/Cordova plugin is enabled. The plugin is not bundled with RubyMine, but it can be installed from the JetBrains plugin repository as described in Managing Plugins.

PhoneGap/Cordova/Ionic-specific configuration settings

PhoneGap/Cordova Executable Path In this field, specify the location of the executable file phonegap.cmd, cordova.cmd, or ionic.cml (see Installing PhoneGap/Cordova/Ionic).
PhoneGap/Cordova Working Directory In this field, specify the folder under which the PhoneGap/Cordova/Ionic application files to run are stored.
Command From this drop-down list, choose the command to run. The contents of the drop-down list, depend on the actually used framework, namely, on the executable file specified in the PhoneGap/Cordova Executable Path field. The available options are:
  • For PhoneGap:
    • emulate
    • run
    • prepare
    • serve
    • remote build
    • remote run
    See PhoneGap CLI for a list of PhoneGap-specific commands with descriptions.
  • For Cordova:
    • emulate
    • run
    • prepare
    • serve
    See Cordova CLI for a list of Cordova-specific commands with descriptions.
  • For Ionic:
    • emulate
    • run
    • prepare
    • serve
    See Ionic CLI for a list of Ionic-specific commands with descriptions.
Platform From this drop-down list, choose the platform for which the application is intended. The available options are:
  • Android
  • ios To emulate this platform, you need to install the ios-sim command line tool globally. You can do it through the Node Package Manager (npm), see npm and Yarn or by running the sudo npm install ios-sim -g command, depending on your oeprating system.
  • amazon-fireos
  • firefoxos
  • blackberry10
  • ubuntu
  • wp8
  • windows8
  • browser
Learn more about targeted platforms from the Platform Guides.
Specify Target Select this checkbox to appoint an Android physical or virtual device to run the application on and select the required device from the drop-down list. The list shows all the virtual and physical devices that are currently configured on our machine. for details. Learn more about setting up emulators from the Cordova Official website.

If RubyMine displays the following error message: Cannot detect ios-sim in path, make sure you have installed the ios-sim, see Before you start.

Common options

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

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.

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.

Single instance only


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.

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.

icons actions newFolder svg 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 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-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 the alphabetical order.


Under the Templates node in the tree view of run configurations, you can select a run configuration template and edit its default settings. This will not affect the configurations that are already created, but will be used as defaults when creating new configurations of the corresponding type.

When you select the Templates node itself, you will be able to adjust general settings that apply to all run/debug configurations:

Configurations available in Run Dashboard

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

Note that the dashboard will only display the configuration types for which you have created one ore more configurations.
Thus, 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 option is selected for a particular run/debug configuration.
  • If this checkbox is selected, in case of a single instance, launching a new process (for example, by clicking icons toolwindows toolWindowRun 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), RubyMine starts the new process silently.
Temporary configurations limit Specify 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 must be be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.

icons general add svgAlt+Insert 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 RubyMine yet, add its definition. For more information, see Configuring Third-Party 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 File Watchers: select this option to have RubyMine apply all the currently active file watchers.
  • 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 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: select 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, click icons actions edit svg, then in the Configure React Native dialog, choose npm script and select start from the list.
  • 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.
  • 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.

  • 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: 31 August 2018

See Also