Sourcecolon

Source Code Search Engine based upon OpenGrok

View project onGitHub

Source: (SourceColon)

Source:

Source code search based upon OpenGrok.

Build Status

Objective

Provide simplified interface to search large scale source code tree.

Prerequisites

  • Java SE 7
  • Optional: Exuberant Ctags
    • Excuberant Ctags provides tags for codes. Tags are used in definition search and navigation (class, function, variable index of each code).

Quick Start

Make sure your Java is later than Java SE 7 (1.7.0_xx or above)

% java -version
java version "1.7.0_17"
Java(TM) SE Runtime Environment (build 1.7.0_17-b02)
Java HotSpot(TM) 64-Bit Server VM (build 23.7-b01, mixed mode)

Run SourceColon

$ ./gradlew -Ptarget=<your source code directory>

Open http://localhost:8080/ with your browser.

Usage

Search by full text, definition (excuberant ctags required), symbol, or path of the file. Enter your query on Search boxes.

Search

Then browse your source codes. If the system have excuberant ctags on indexing, navigation to class, package, function/method, etc. are displayed on left pane.

Browse

License

CDDL 1.0. Please refer LICENSE.txt for more details.