grokit is a developer's tool to setup one of the best available source code search and cross reference engines, Opengrok. This repository contains the source code (without external dependencies) for grokit. If you want to simply download and use grokit with all its dependencies, please visit grokit webpage

Dependencies

Python libraries

• bs4
• lxml

Tools

• Opengrok (ofcourse!)
• JRE
• exuberant-ctags
• Apache Tomcat

Installation

Download jre-8u162 and place the downloaded tar.gz in the tools directory.

Usage:

# Clone the repository
git clone https://github.com/raghusesha/grokit.git
# Download and copy the dependent tools (check the section above) into the tools directory
cd grokit/tools
# download opengrok. e.g., wget http://java.net/projects/opengrok/downloads/download/opengrok-0.12.1.tar.gz
# download jre, ctags and tomcat
cd ..
python grokit.py --ppath=<path to project source> --action=setup

For instant setup and using the tool, Check the videos: http://www.youtube.com/watch?v=XzrPlAfiC1w and http://www.youtube.com/watch?v=BTGnZShDiqA

Platforms Tested On:

Linux

• Ubuntu 12.04 64 bit
• Ubuntu 11.04 64 bit

Windows

• Windows 7 32 bit
• Windows 8 64 bit

Author

Raghu Sesha Iyengar(raghu.sesha@gmail.com, raghu.iyengar@agreeyamobility.net)