Eclim installation / upgrading guide.

Before beginning the installation, first confirm that you have met the following requirements.

• Java Development Kit 1.5 or greater.
• Eclipse SDK 3.3.x.
• Vim 7.x.x.
  
  

  Minimum Vim Settings: In order for eclim to function properly, there is a minimum set of vim options that must be enabled in your vimrc file (:h vimrc).

  • set nocompatible

    Execute :h 'compatible' for more info. You can confirm that compatibliity is turned off by executing the following:

                    :echo &compatible
                  

    Which should output '0'.

    
    
  • filetype plugin on

    Execute :h filetype-plugin-on for more info. You can confirm that file type plugins are enabled by executing the following:

                    :filetype
                  

    Which should output 'filetype detection:ON plugin:ON indent:ON', showing at least 'ON' for 'detection' and 'plugin'.

Step 1: Download the eclim installer for your platform.

• Linux (and other unix based systems): eclim_version.sh
• Windows: eclim_version.exe

Step 2: Run the installer.

• Linux (and other unix based systems): You can start the installer by running the script you downloaded (note: you may have to make it executable first).

                $ chmod 755 eclim_version.sh
                $ ./eclim_version.sh
              

• Windows: On Windows systems, simply double click the eclim_version.exe file you downloaded.

After the installer starts up, simply follow the steps in the wizard to install the application.

Step 3: Start the eclimd server and test it.

See the documentation below.

Once you have finished the installation process, you can then start up the eclim server and verify that it is running properly.

1. The first step is to start the eclimd server. To do so follow the directions found here.
2. Once you have started the server you can test it by opening a Vim window and issuing the command, :PingEclim . The result of executing this command should be "eclim version" echoed to the bottom of your Vim window. If however, you receive "unable to connect to eclimd - connect: Connection refused", or something similar, then your eclimd server is not running or something is preventing eclim from connecting to it. If you receive this or any other errors and are unsure of what steps to take, please feel free to visit the forums so that someone can help resolve your issue.
   
   

   Example of successful ping:
   

   
   

   Example of failed ping:
   

3. Regardless of the ping result, you can also verify your vim settings using the command :EclimValidate. This will check various settings and options and report any problems. If all is ok you will receive the following message:

               Result: OK, required settings are valid.
             

Now that you have eclim installed, the next step is to familiarize yourself with at least the core set of commands that eclim provides, all of which are found at the index of the eclim documentation.

After doing that you can then procede to create your first project:

• Java Project Guide

The upgrading procedure is the same as the installation procedure but there are a couple things worth noting.

• The installer will remove the previous version of eclim and install the new one. This includes all the files in the eclim eclipse plugins and the files eclim adds to your .vim or vimfiles directory. So if you made any alterations to any of these files, be sure to back them up prior to upgrading.
• Since the previous version is removed any time you run the installer, whether upgrading or reinstalling the current version, you will need to always select the features you want installed regardless of whether they are already installed. In a future version, the installer will attempt to auto select them for you.