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 on Windows and Unix 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

Apr. 12, 2014

Eclim has been updated to fix an issue on Windows that could prevent many features from working.

Apr. 06, 2014

This release includes many bug fixes and refinements as well as a rewrite of eclim's python support to utilize pydev instead of rope.

Warning

Any exiting eclim python projects you have should be re-created with the new python nature:

:ProjectCreate /path/to/project -n python

Sep. 12, 2013

This release fixes the extraction of the necessary vim files when installing scala support.

Jul. 27, 2013

The previous eclim installer for Kepler was still pointing at the Juno update site. This release remedies that.

Jul. 21, 2013

The focus of this release is to bring eclim fully up to date with Eclipse Kepler support. The installer for eclim 2.3.0 now requires that you install against Kepler.

Jul. 14, 2013

This is primarily a bug fix release with a few new features. Unless some critical error is found, this will be the last release targeting Juno. The next release will likely target Kepler though this release should work fine on Kepler as well, with the exception of scala support which has not been tested. Indigo support will continue but will likely end with the release of Luna, possibly sooner.

May 18, 2013

Eclim has been updated to support the Android Development Toolkit version 22.0.0, scala is now supported for both Juno and Indigo, and there are a few other improvements and many bug fixes.

Nov. 25, 2012

The most notable change in this release is support for Eclipse 3.8 with the Indigo release (1.7.13). Both releases also include several small bug fixes.

Nov. 18, 2012

This is another bug fix release which includes support for the latest Android development toolkit (21.0.0).

Oct. 19, 2012

This is a bug fix release for Windows users which fixes executing of eclim commands from vim:

Oct. 07, 2012

Two new eclim updates are once again available with several bug fixes and improvements.

Sep. 09, 2012

Eclim 1.7.9 for Eclipse 3.7 (Indigo) is now available.
This release adds initial support for scala.

Please note that the Scala IDE , which eclim uses to provide scala support, is not yet available for Eclipse 4.2 (Juno), so eclim's scala support will not be available for the eclim 2.2.x releases until sometime after the Scala IDE has been updated for Juno.

Sep. 01, 2012

Another set of releases are now available for both Juno and Indigo. These both include several bug fixes along with new support for creating android projects.

Eclim also has a newly redesigned site using the sphinx bootstrap theme.

Aug. 07, 2012

Two new versions of eclim have been released, one for the latest Eclipse version, Juno, the other a bug fix release for the previous version of Eclipse, Indigo.

Jun. 07, 2012

Eclim 1.7.6 is now available.
This is a minor bug fix release.

Jun. 03, 2012

Eclim 1.7.5 is now available.
This is a minor release with an improved installer, some bug fixes, and a few minor enhancements.

Apr. 22, 2012

Eclim 1.7.4 is now available.
This is a bug fix release.

Mar. 18, 2012

Eclim 1.7.3 is now available.
This version fixes numerious small bugs and adds a handful of small features.

Warning

Non vim users (emacs-eclim, subclim, etc.): The underlying command response format for eclim has changed, which means that any project relying on the old format isn't going to work. So if you are installing eclim for use with a client other than vim, then be sure to check with the client project to see if it has been updated for eclim 1.7.3 or later.

Eclim News Archive