# eclipse-instasearch

**Repository Path**: unknowIfGuestInDream/eclipse-instasearch

## Basic Information

- **Project Name**: eclipse-instasearch
- **Description**: Eclipse plug-in for fast code search
- **Primary Language**: Java
- **License**: EPL-2.0
- **Default Branch**: master
- **Homepage**: https://github.com/tlcsdm/eclipse-instasearch
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-18
- **Last Updated**: 2025-12-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Eclipse-Plugin

## README

# Eclipse plug-in for quick code search

InstaSearch is an Eclipse IDE plug-in for performing quick and advanced search of workspace files. It indexes files using Lucene and keeps the index up to date automatically. The search is performed instantly as-you-type and resulting files are displayed in an Eclipse view.

Each file then can be previewed using few most matching and relevant lines. A double-click on the match leads to the matching line in the file.

Because Eclipse 2024-06 through 2024-12 are built on Apache Lucene 9.10.0 or later,  
plugin version 1.0.0 provides initial support for this Lucene version range.  
* Apache Lucene 9.10.0+
* JDK 17

Starting from version 1.1.0, the plugin supports Eclipse 2025-03 and later, and upgrades its dependency to Apache Lucene 10.0.0 or later.  
* Apache Lucene 10.0.0+
* JDK 21

## Use  

Once InstaSearch is successfully installed, you'll see a nice little "InstaSearch" search tab appear at the bottom:

<img src="readme/demo.png" alt="demo" title="demo"/>

You can also click the `Search` menu option at the top --> `InstaSearch...`

<img src="readme/search.png" alt="search" title="search"/>

Search Tips
---
Lucene [query syntax](http://lucene.apache.org/core/old_versioned_docs/versions/3_0_0/queryparsersyntax.html) can be used for searching. This includes:

* Wildcard searches
  * `app* initialize`
* Excluding words
  * `application -initialize`
* Fuzzy searches to find similar matches
   * `application init~`
* Limit by location - directory, projects or working set
   * `proj:MyProject,OtherProject  application  init `
   * `ws:MyWorkingSet  dir:src  init `
* Limit by filename, extension or modification time
   * `name:app*  ext:java,xml,txt  modified:yesterday  `
* Search by file name initials (e.g. FOS to find FileOutputStream.java)
   * `name:FOS`

To exclude some folders from search indexing, mark them as *Derived* in the folder's properties.
There are also useful [Eclipse Search Tips](https://github.com/tlcsdm/eclipse-instasearch/wiki/Eclipse-search-tips).

**Note**: Fuzzy search is started automatically if no exact matches are found

## Features

* Instantly shows search results
* Shows a preview using relevant lines
* Periodically updates the index
* Matches partial words (e.g. case in CamelCase)
* Opens and highlights matches in files
* Searches JAR source attachments
* Supports filtering by extension/project/working set

## History
Fork of [eclipse-instasearch](https://github.com/ajermakovics/eclipse-instasearch) on Github.

## Build

This project uses [Tycho](https://github.com/eclipse-tycho/tycho) with [Maven](https://maven.apache.org/) to build. It requires Maven 3.9.0 or higher version.

Dev build:

```
mvn clean verify
```

Release build:

```
mvn clean org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=2.0.0 verify
```

## Install

1. For Eclipse 2024-06 ~ 2024-12, add  
   `https://raw.githubusercontent.com/tlcsdm/eclipse-instasearch/update_site_2024/` as the upgrade location in Eclipse.  
   For Eclipse 2025-03 and later, add  
   `https://raw.githubusercontent.com/tlcsdm/eclipse-instasearch/update_site/` as the upgrade location in Eclipse.  
2. Download from [Jenkins](https://jenkins.tlcsdm.com/job/eclipse-plugin/job/eclipse-instasearch)
3. <table style="border: none;">
  <tbody>
    <tr style="border:none;">
      <td style="vertical-align: middle; padding-top: 10px; border: none;">
        <a href='http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=7252883' title='Drag and drop into a running Eclipse Indigo workspace to install eclipse-instasearch'> 
          <img src='https://marketplace.eclipse.org/modules/custom/eclipsefdn/eclipsefdn_marketplace/images/btn-install.svg'/>
        </a>
      </td>
      <td style="vertical-align: middle; text-align: left; border: none;">
        ← Drag it to your eclipse workbench to install! (I recommand Main Toolbar as Drop Target)
      </td>
    </tr>
  </tbody>
</table>