Reference articles on history, science, culture and more
Encyclopedia

OpenGrok

Source code search and cross reference engine

OpenGrok is a source code cross-reference and search engine. It helps programmers search, cross-reference, and navigate source code trees to aid program comprehension.

It can read program file formats and version control histories such as Monotone, Subversion, Mercurial, Git, ClearCase, Perforce, AccuRev, Razor, and Bazaar.

The name comes from the term grok, a computing jargon term meaning "intuitive understanding".

OpenGrok is being developed mainly by the community with the help of a few engineers from the Oracle Corporation. OpenGrok is released under the terms of the Common Development and Distribution License (CDDL).

It is mainly written in Java, with some tooling done in Python. It relies on the analysis done by Ctags. There is an official Docker image available.

01Features

OpenGrok supports:

  • Full text search
  • Definition search
  • Identifier search
  • Path search
  • History search
  • Showing matching lines
  • Hierarchical search
  • Query syntax
  • Incremental updates
  • Syntax highlighting cross-references
  • Quick navigation inside files
  • Interface for SCM
  • Usable URLs
  • Individual file download
  • Changes at directory level
  • Multi language support
  • Suggester
  • REST API
Watch videos about OpenGrokExplainers and documentaries on YouTube (opens in a new tab)

Sources and credits

This article is adapted from the Wikipedia article OpenGrok, written by its contributors and licensed under CC BY-SA 4.0. Fathomly has changed the layout, removed citation markers, navigation and maintenance notices, and adjusted punctuation. This adapted version is shared under the same license. For references, see the original article.

Fathomly is not affiliated with or endorsed by the Wikimedia Foundation. Spotted a problem? Tell us.