[Home]

Creating a Project from Files in Version Control

Illuminated Cloud makes it easy for you to create a project from files in your supported version control system.

If you have a version control-managed project that contains Salesforce metadata files, follow the process described below to create Illuminated Cloud projects from them.

1. Select File > New > Project from Version Control and choose the type of version control system being used to store the source files.

   NOTE: In WebStorm and other lightweight IDEs, the menu option is slightly different. Select VCS > Checkout from Version Control and choose the type of version control system being used to store the source files.

2. The details required to check out the project will vary based on the selected version control system. For example, if you select Git you'll see the following dialog:

   

   In this example, you'd provide the following information to connect to the repository where your source files are stored, and create a local version:

   • URL — The full path to the repository where the files are located (e.g., https://github.com/<repository_name>.git).

   • Directory — Specify (or browse for) the local directory to use (e.g., C:\Users\Your_Name\Idea\Projects\).

3. Click Test to verify that the IDE can successfully connect to the repository.

4. Click Clone to check out the project from the repository into the local file system location that you specified.

5. You'll then be prompted to open the project in a new window or the existing window. Choose your preferred option to display the project in the window.

   

You may see a notification in the bottom-right corner of the IDE window stating Invalid configuration for module '<moduleName>':

If so, expand the notification and click the Resolve link. Illuminated Cloud will then proceed to resolve the configuration issues, prompting you as needed. For example:

• If you're notified that modules must be associated with a connection or development package, click OK to proceed. Choose a connection for the project and click OK.

• If there wasn't one already associated with the project, Illuminated Cloud will generate an offline symbol table for the connection. An offline symbol table is required by Illuminated Cloud for code completion, offline API documentation, etc., for Salesforce system Apex classes and SObjects, accessible Apex classes from installed managed packages, and custom SObjects. Click OK to proceed.

• You'll be prompted to reload the project after rebuilding the cache and indices. Yes is the default selection, and is recommended.

  

You can expand External Libraries > Illuminated Cloud > OfflineSymbolTable.zip to view the contents of the generated offline symbol table. For more information, see Generating an Offline Symbol Table.

Illuminated Cloud now knows about all system identifiers, classes, methods, and fields — essential for taking advantage of features such as intelligent code completion, offline system API documentation, etc. You can now begin working with your project metadata.

[Home]