OpenGrok
A fast and usable source code search and cross-reference engine by Oracle, written in Java. It helps you search, cross-reference, and navigate your source tree with support for many programming languages and version control systems.
What You Can Do After Deployment
- Access the web UI at your assigned domain
- Add source code by mounting repositories into the
/opengrok/src directory
- Search code using full-text search, definition search, symbol search, path search, and history search
- Navigate cross-references by clicking on symbols to jump to definitions and usages
- Browse repositories through the built-in file browser with syntax highlighting
- Trigger re-indexing via the REST API at port 5000
Key Features
- Full-text search across large codebases
- Cross-reference navigation for symbols, definitions, and usages
- Syntax highlighting for 60+ programming languages
- Version control integration (Git, SVN, Mercurial, Bazaar, and more)
- Automatic periodic re-indexing
- REST API for administration
Getting Started
Place your source code repositories as subdirectories under /opengrok/src. The indexer will automatically scan and index them at regular intervals.
License
CDDL-1.0 — GitHub