Wiki

Clone wiki

IlluminatedCloud / User_Guide / Installing_Illuminated_Cloud

[Home]

Installing Illuminated Cloud

Follow the process outlined below to install the Illuminated Cloud plugin for JetBrains IntelliJ IDEA, PhpStorm, PyCharm, RubyMine, or WebStorm.

After you install Illuminated Cloud, you'll have access to modern IDE features such as:

  • Code completion for Apex classes
  • Syntax highlighting for classes & Visualforce pages
  • Contextually aware reference navigation
  • Integrated API documentation
  • Metadata retrieval & deployment

Prerequisite:

If you haven't already, install one of the following supported IDEs from JetBrains:

To install Illuminated Cloud:

  1. From within a supported JetBrains IDE, select File > Settings (Windows) or Preferences (Mac).

  2. Select Plugins in the left navigation, and start typing Illuminated Cloud in the Search field at the top of the Marketplace view.

    plugin-search-results

  3. In the results that are returned, select Illuminated Cloud 2 by Rose Silver Software and click Install. (The initial version of Illuminated Cloud is only supported for original customers of that version.)

    plugin-installation-options.png

  4. Click Restart IDE to activate the plugin.

    plugin-installation-restart.png

  5. We strongly recommend that you click Yes when prompted to enable Illuminated Cloud's Save All action handler and to create a derived keymap, to maintain consistent behavior with the base IDE.

Illuminated Cloud immediately starts parsing, caching and indexing Salesforce metadata so you can work with it in your projects.

The footer also indicates when your Illuminated Cloud evaluation period will expire:

plugin-installed.png

To install Illuminated Cloud from disk:

If your Internet access or network performance is limited, you can try this alternate method of installing the plugin:

  1. Access the JetBrains plugin repository.

    plugin-download.png

  2. Click Get and download the latest version of the plugin (IlluminatedCloud2.zip). Do not extract this archive—the installation will fail if you do so.

  3. Return to your IDE, select File > Settings (Windows) or Preferences (Mac).

  4. In the Plugins view, click the gear icon and select Install Plugin from Disk.

    plugin-install-from-disk.png

  5. Locate the IlluminatedCloud2.zip file you previously downloaded and click Open to install the plugin.

  6. Click Restart IDE to activate the plugin.

After you've installed Illuminated Cloud 2, it's easy to keep it up-to-date with the latest fixes and features.

[Home]

Updated