Installing QL for Eclipse

Important

QL for Eclipse is a plugin that allows you to write and run QL queries locally in your IDE. These topics explain how to run custom queries on project snapshots using the QL for Eclipse plugin.

LGTM for Eclipse is a separate plugin for downloading alerts from LGTM, so that you can fix them easily in your IDE. For more information about this plugin, see IDE integration for LGTM.

Installation options

QL for Eclipse is available as:

  • A free-to-use version, which uses the same QL libraries and tools as LGTM.com, and can be downloaded by anyone.
  • A licensed version, which uses the same QL libraries and tools as the matching version of LGTM Enterprise, and can be downloaded by users with an appropriate license.

If you have a suitable license, you can download both versions of QL for Eclipse. The most suitable version to use depends on how recently the snapshot that you want to analyze was built. For more information, see the sections below.

Free-to-use version

You can analyze open source projects using the free-to-use QL for Eclipse. Download this version, along with snapshots to analyze, from LGTM.com.

Both LGTM.com and the free-to-use QL for Eclipse are frequently updated to use the most up-to-date QL libraries and tools. So to ensure you can always analyze new snapshots downloaded from LGTM.com, it's a good idea to regularly update your free-to-use QL for Eclipse plugin.

For installation instructions, see Installing the free-to-use QL for Eclipse plugin.

Licensed version

The licensed version of QL for Eclipse primarily supports running queries on snapshots downloaded from LGTM Enterprise, and snapshots created using the QL command-line tools. To ensure your snapshots are compatible, make sure that the version numbers of QL for Eclipse, LGTM Enterprise, and the QL command-line tools are the same. You may also analyze snapshots downloaded from LGTM.com, if they are compatible with your version of the licensed plugin. However, since the analysis used on LGTM.com is updated regularly, you may find that some snapshots cannot be analyzed, even with the most recent version of the licensed plugin. If this is the case, and you need to analyze snapshots downloaded from both LGTM Enterprise and LGTM.com, then we recommend you also install the free-to-use QL for Eclipse in a separate Eclipse installation

If you already have Eclipse installed, you can install QL for Eclipse as a plugin. If you don't have Eclipse installed, you can either:

For a summary of useful Eclipse commands, see Eclipse tips for new users.

Related Topics Link IconRelated Topics