Installing the plug-in

1. Choose File > Settings. The Settings dialog box opens.
2. Select Plugins.
3. Right-click Surround SCM and choose Download and Install.
   
   
4. Click Apply. The plug-in is downloaded and installed.
5. Restart IntelliJ IDEA when installation is complete.

Sharing projects

1. Open the project in IntelliJ IDEA.
2. Select the project root node and choose Version Control > Enable Version Control Integration. The Enable Version Control Integration dialog box opens.
   
   
3. Select Surround SCM and click OK.
4. Right-click the project root node and choose Surround SCM > Work Online. You may be prompted to log in and associate the project with Surround SCM.
5. Click Fix. The Surround SCM Repository Browser opens.
   
   Note: Click Ignore if you do not want to associate the project, but want to be prompted when you open another project. Click Ignore All if you do not want to associate any projects when this instance of IntelliJ IDEA is open.
   
   
6. Select the repository to associate the project with or click Create Repository to create a new repository for the project.
   
   Note: If an existing repository is selected, the working directory must be the project directory. Right-click the repository and choose Set Working Directory to change the working directory. Creating a new repository automatically assigns the project directory as the working directory.
   
   
7. Click OK to close the repository browser. The integration is ready to use.

Performing Surround SCM actions

1. Select the files you want to add to source control.
2. Right-click and choose Surround SCM > Add. The Advanced Add Options dialog box opens.
3. Select any options and click OK. The files are added to Surround SCM.

1. Select the files you want to get.
2. Right-click and choose Surround SCM > Get. The Advanced Get Options dialog box opens.
   
   Note: To get a copy of all files in the project, right-click the project and choose Surround SCM > Pull Project.
3. Select any options and then click OK to get the files.

1. Select the files you want to check out.
2. Right-click and choose Surround SCM > Check Out. The Advanced Check Out Options dialog box opens.
3. Select any options and click OK. The files are checked out.

1. Select the files you want to undo check out for.
2. Right-click and choose Surround SCM > Undo Check Out. The Advanced Undo Check Out Options dialog box opens.
3. Click OK. The files are no longer checked out.

1. Select the files you want to check in.
2. Right-click and choose Surround SCM > Check In. The Advanced Check In Options dialog box opens.
3. Click OK. The files are checked in.

1. Right-click the file you want to view history for and choose Surround SCM > History. The History dialog box opens. You can view historic version information and diff or get versions of the file.
2. Click Close to close the file history.

1. Right-click the file you want to view properties for and choose Surround SCM > Properties.
2. Select Surround SCM to view file information.

1. Right-click the file and choose Surround SCM > Differences. The compare editor displays any differences between the files.

1. Right-click the project folder and choose Surround SCM > Differences. The Repository Differences dialog box opens. You can see if any files are missing locally or from Surround SCM. You can also see if files are out of sync between the Surround SCM repository and the local project folder.

1. Right-click the file you want to rename and choose Surround SCM > Rename. The Rename File dialog box opens.
2. Enter a New Name.
3. Optionally enter any comments.
4. Click OK. The file is renamed in Surround SCM. You are prompted to rename the file in the project.
5. Click Yes to rename the file and update the project to point to the new file. If you do not rename the project file, you cannot work with it unless you add it to Surround SCM or manually rename it.

1. Right-click the file and choose Surround SCM > Refresh File Status. The file status is refreshed.

1. Right-click the file you want to remove and choose Surround SCM > Remove. The Advanced Remove Options dialog box opens.
2. Select Destroy if you want to permanently delete the selected file from Surround SCM.
3. Optionally enter any comments.
4. Click OK. The file is removed.

1. Select the project root node.
2. Choose File > Settings.
3. Set the version control provider for the project to None.

1. Close IntelliJ IDEA.
2. Browse to the project directory.
3. Locate and delete the .MySCMServerInfo file.
4. Browse to any subdirectories or other directories where files used by the project exist and delete the .MySCMServerInfo files.

Configuring Surround SCM preferences

1. Choose File > Settings.
2. Expand Version Control and then expand VCSs.
3. Select Surround SCM. The Surround SCM preferences are displayed.
   
   
4. Make any changes and click OK.

Troubleshooting

• The Surround SCM plug-in is not installed. Rerun the Surround SCM Client installer or install the plug-in from IntelliJ IDEA.
  
  
• You are using an unsupported version of IntelliJ IDEA. See Surround SCM Third-Party Integrations for supported platforms and versions.

• The project is not configured correctly. Make sure the project points to a valid branch/repository. The branch/repository must exist on the Surround SCM Server you are connecting to.
  
  
• IntelliJ IDEA cannot connect to the Surround SCM Server. Make sure the Surround SCM Server is running and that your username and password are correct.
  
  
• The local .MySCMServerInfo file is out of sync. IntelliJ IDEA uses the .MySCMServerInfo file to determine where to look for files in Surround SCM. Go to the project directory and make sure the .MySCMServerInfo file data points to the correct branch/repository. If it points to an incorrect branch/repository, delete it and then refresh the project status to regenerate the .MySCMServerInfo file.  

• The Surround SCM integration is not configured correctly for the IntelliJ IDEA project. Make sure the project points to a valid branch/repository. Surround SCM may guess where you want to add the files based on the information in the .MySCMServerInfo file. However, the add cannot be completed if the .MySCMServerInfo file does not exist.
  
  
• The IntelliJ IDEA project configuration points to the wrong branch. This can be an issue if you maintain the IntelliJ IDEA local project files in Surround SCM and then branch the repository that contains the project files. The local files point to the old branch, which is where the files are added. Configure IntelliJ IDEA to point to the correct branch and then add the files to Surround SCM.