Fork me on GitHub

Welcome to Eclim

The power of Eclipse in your favorite editor.

What is it?

Eclim provides the ability to access Eclipse code editing features (code completion, searching, code validation, and many more) via the command line or a local network connection, allowing those features to be integrated with your favorite editor. Eclim provides an integration with Vim, but third party clients have been created to add eclim support to other editors as well (emacs, sublime text 2, textmate).

There are three primary usage scenarios in which eclim is designed to be used:

_images/use_cases.png
  1. The first scenario is for those for which vim is their primary editing interface. In this scenario you run a headless instance of eclipse which all vim instances can then communicate with to provide the various eclipse features.

  2. The second scenario is for those who prefer using vim as their main interface, but frequently end up jumping back to eclipse for any features not provided by eclim. In this case you can run the eclim server inside of the eclipse gui and then interact with it via external vim instances just like the first scenario.

  3. The last scenario is for those who wish to use the eclipse interface full time, but want to use gvim as an embedded eclipse editor. Just like the previous use case, the eclim server is run inside of the eclipse gui and the embedded gvim will interact with it just like external vim instances would. This feature is only support Linux systems (where gvim is compiled with the gtk gui).

    Note

    Please be aware that the embedded vim does not behave like a standard eclipse editor. It’s a separate program (vim) embedded into eclipse, so eclipse features are provided by eclim’s vim plugins and not the usual eclipse key bindings, context menus, etc. For those that just want vim like key bindings in their eclipse editors, vrapper is an excellent alternative which provides exactly that.

Eclim is released under the GPLv3.

How do I get/install it?

You can follow the eclim install guide which will walk you through downloading and installing eclim.

How do I use it?

After you’ve installed eclim, you can refer to the getting started page which will walk you through creating your first project.

Where can I get help?

Mailing Lists

If at any time you have any questions or feedback, feel free to post to one of the eclim mailing lists:

  • eclim-user: For all questions regarding installation, usage, troubleshooting, etc.
  • eclim-dev: For all eclim development related discussions.

IRC (#eclim on freenode.net)

If you would like to get help or ask questions on IRC, then feel free to join #eclim on freenode.net. Please note that I (Eric Van Dewoestine, ervandew on irc) try to stay in the channel as much as possible, but I might not be available to answer questions immediately. It’s also worth noting that I live in California, so if you are in Europe, Asia, or some other timezone whose normal waking hours don’t overlap well with mine, then you may be better off getting help using one of the mailing lists above.

How do I report a bug?

Reporting Bugs

If you’ve found a bug please report the issue to either the eclim-dev mailing list or create a new issue on eclim’s github issue tracker.

When reporting a bug, please include the following information:

  • What OS are you on?
    • Linux users: please include the distro and version.
  • What version of eclim, vim, and eclipse are you using?
    • Linux users: please indicate whether you installed eclipse via your distro’s package manager or not, and if not, please indicate what distribution of eclipse you are using (“Eclipse Classic”, “Eclipse IDE for C/C++ Developers”, some other eclipse bundle).

What’s New?

Rss Feed for What's New

Jul 05, 2018

A new version of eclim is now available with support for Eclipse 4.8 (Photon). This release also contains some fixes for the installer as well as other bug fixes.

Note

Groovy support has been omitted from this release since the groove eclipse feature does not yet support Eclipse 4.8 (Photon).

Feb 11, 2018

The new eclim installer has been fixed to handle spaces in the eclipse path and eclimd has been fixed to run under java 9.

Jan 01, 2018

Eclim has an all new installer that runs entirely on the command line and now supports the new Eclipse directory layout used by the Eclipse GUI installer.

Note

Windows support has been removed. Going forward eclim will only officially support Linux and OSX.

Jul 12, 2017

A new version of eclim is now available with support for Eclipse 4.7 (Oxygen).

Eclim News Archive