Skip to the content
Know your tech before you buy it. Makers: get listed from $49/mo

OpenGrok

oracle.github.io

  • Free plan
  • Windows
  • macOS
  • Linux
  • Web
  • API
  • Self-hosted
7.9 Club score Visit oracle.github.io

What OpenGrok is

OpenGrok is a Java-based engine for searching, cross-referencing and navigating source code trees. It searches full text, definitions, symbols, file paths and revision history, with subtree searches, wildcards and date-range filters. Its read-only web interface presents syntax-highlighted cross-references alongside file and directory history and revision diffs. It supports a wide range of revision control systems, including Git, Mercurial, Subversion, CVS, Perforce, ClearCase, Bazaar, Monotone, Razor, RCS, SCCS, Teamware and AccuRev. Plugins can extend language or revision-control support, and the web application exposes a REST API at `/api/v1/`. OpenGrok includes granular authorization; authentication is delegated to the application server or a reverse proxy. Deployment involves building an index and setting up the web application. Listed requirements include Java 21 through 25, Universal Ctags and a servlet container such as Tomcat 10.x. The project is free and open source, with the latest listed release, 1.14.19, allowing Java 25.

Who it suits

OpenGrok suits teams and developers who need searchable, browsable source trees across supported revision-control systems. It is intended for self-hosted setups, including Linux, macOS and Windows environments.

Good to know, and what to watch

  • Searches symbols, definitions and revision history.
  • Read-only browsing includes diffs and file history.
  • Plugins can extend language and revision-control support.
  • Provides a REST API and granular authorization.
  • Setup requires indexing and deploying the web application.
  • The guide is primarily written for Unix-like systems.
  • The indexer usually runs with an 8 GB JVM heap.

OpenGrok

Free

Open source

Getting started

  1. Open the OpenGrok project website
  2. Install Java 21 through 25 and Universal Ctags
  3. Provide a servlet container such as Tomcat 10.x
  4. Create the source index
  5. Deploy the OpenGrok web application
  6. Access it with a recent browser or use the REST API

Limits to check

The free OpenGrok plan is an open-source, self-hosted project; operation requires creating an index and deploying the web application. The guide says the indexer usually needs an 8 GB JVM heap, with additional memory for the web application.

The Club's review

OpenGrok is an open-source Java engine that indexes source trees for search and read-only code navigation. It is best suited to development teams and IT groups prepared to run their own web application and indexer, particularly when repositories use several version-control systems. Choose it for broad repository coverage and extensibility; look elsewhere if you need a managed service or regular-expression search.

Overview

OpenGrok builds an index of a codebase and presents results through a browser-based, read-only interface. The project is free and released as an open-source project under the CDDL license, so licensing cost is not the barrier. The operational work is: setup involves creating the index and deploying the web application, with guidance aimed primarily at Unix-like systems. Windows is supported with adjusted commands and paths.

This model fits organizations that want their source and search infrastructure under their control. It is less suitable for a small team that wants to sign in to a hosted search product without maintaining Java services, index refreshes, and server capacity.

Key features

Search reaches full text, definitions, symbols, paths, and revision history. Subtree queries, wildcards, and date-range filters make it possible to narrow searches by repository area or change period, which is useful in large or long-lived codebases. Regex search is not supported, a meaningful limitation for developers whose normal workflow depends on regular expressions.

The web browser is designed for investigation rather than editing. It provides syntax-highlighted cross-references, file history, revision diffs, and directory history, allowing a reader to follow relationships and understand how code evolved without checking out a working copy. Code navigation is therefore a core strength, while write-back or editing workflows are outside its role.

Repository support is unusually broad: Git, Mercurial, Subversion, CVS, Perforce, ClearCase, Bazaar, Monotone, Razor, RCS, SCCS, Teamware, and AccuRev are supported. That range is valuable for organizations with legacy and modern systems side by side. Plugins can add programming-language or revision-control support, giving teams a route to cover specialized environments rather than replacing the product.

Integrations can use the REST API at /api/v1/. OpenGrok also provides granular authorization; authentication is supplied by the application server or a reverse proxy. Bearer tokens require HTTPS unless the web application is explicitly configured to permit tokens over an insecure channel, so deployment architecture matters when exposing API access.

Pricing

OpenGrok has one published plan:

PlanPriceWhat it includes
OpenGrokFreeOpen-source project under the CDDL license; indexing scope is a codebase.

There are no paid tiers, seat charges, quotas, or trial terms stated for this plan. The trade-off for the zero price is infrastructure ownership: you supply the host, servlet container, index storage, and operational labor.

Platforms

OpenGrok is offered for API, Linux, macOS, self-hosted deployments, web clients, and Windows. The setup requirements call for Java 21 through 25, Universal Ctags, a servlet container such as Tomcat 10.x, and a recent browser. Version 1.14.19 is described as allowing Java 25.

Capacity planning is part of deployment. The guide says the indexer is usually run with an 8 GB JVM heap and that the web application needs more memory. Those requirements favor teams able to size and monitor a server rather than users expecting a lightweight desktop utility.

Who it's for

OpenGrok is a strong fit for enterprises, platform teams, and development groups that need searchable internal repositories, read-only browsing, and history across heterogeneous revision-control systems. Its plugins and API also suit teams building language support or internal tooling around a central code index.

It is a weaker fit for individuals who need regex queries, teams without Java and servlet-container administration skills, or organizations that prefer a hosted product with infrastructure handled by the vendor. The project is maintained by enthusiasts and volunteers worldwide, with support through discussions and mailing lists and issue tracking through GitHub Issues; buyers wanting a commercial support channel should account for that difference.

Pros and cons

Pros

  • Broad search coverage: definitions, symbols, paths, full text, and revision history support both everyday lookup and historical investigation.
  • Deep repository compatibility: support for numerous revision-control systems helps consolidate search across mixed estates.
  • Useful navigation: cross-references, diffs, and file and directory history make the read-only browser effective for tracing changes.
  • Extensible integration surface: plugins and the /api/v1/ REST API allow adaptation and automation.
  • No license fee: the CDDL open-source plan costs nothing.

Cons

  • Operational overhead: indexing and web deployment require Java, Ctags, a servlet container, and ongoing server administration.
  • Significant memory demand: the indexer commonly uses an 8 GB JVM heap, while the web application needs more.
  • No regex search: regular-expression-driven workflows cannot use their preferred query method.
  • Read-only experience: browsing and review are supported, but code editing is not part of the interface.
  • Community-led maintenance: support is centered on discussions, mailing lists, and GitHub Issues rather than a stated commercial support offering.

Alternatives

Semantic Designs Source Code Search Engine is worth choosing when an evaluation edition covering 10,000 lines of Java, COBOL, C++, and pseudo-code meets your needs and a paid product is acceptable.

Sourcebot is a freemium, self-hosted and web-accessible option with a free Basic plan that includes code search, including regex and symbol search.

ast-grep is a free choice spanning API, extension, desktop, and web platforms when its published scope fits your workflow.

Code Search suits teams seeking a freemium Community plan with unlimited users, full-text search, repository-wide find and replace, a CLI, an MCP server, and SCIP code intelligence.

Chatterbox TTS is an unrelated free, self-hosted open-source model project rather than a source-code search alternative.

Code Fundi is a paid, freemium option for teams wanting hosted development features such as private repository indexes and multi-codebase search and chat.

searchcode is a free-during-beta API, self-hosted, and web option for users focused on public GitHub repository search.

sqry is a free, local, MIT-licensed tool for Linux, macOS, and Windows when running searches on individual machines is preferable.

Verdict

Choose OpenGrok if you need a free, self-hosted index for broad source-tree search, historical browsing, and code navigation across varied revision-control systems, and you can operate its Java-based deployment. Look elsewhere when regex search, hosted convenience, commercial support, or a lighter memory footprint matters more than repository breadth and extensibility.

The verdict

OpenGrok offers broad source-tree search and read-only code navigation, with extension points and an API. Plan for the indexing, deployment and memory requirements when setting it up.

Questions people ask

Is OpenGrok free and open source?

Yes. The OpenGrok plan is free at no cost and is an open-source project released under the CDDL license.

Which platforms are supported?

OpenGrok supports Linux, macOS, Windows, web, self-hosted deployment, and an API.

Which repositories can it index?

Supported systems include Git, Mercurial, Subversion, CVS, Perforce, ClearCase, Bazaar, Monotone, Razor, RCS, SCCS, Teamware, and AccuRev.

Does OpenGrok have an API?

Yes. Its web application provides a REST API at `/api/v1/`.

How is access secured?

OpenGrok provides granular authorization. Authentication is handled by the application server or a reverse proxy, and API bearer tokens require HTTPS unless insecure-token use is enabled.

What the maker publishes

API
The web application provides a REST API under `/api/v1/`. source
API token security
API bearer tokens require HTTPS unless the web application is configured to allow tokens over an insecure channel. source
Code browsing
Its read-only web interface provides file history, revision diffs, directory history, and syntax-highlighted cross-references. source
Deployment
Setup requires creating an index and deploying the web application; the guide is primarily for Unix-like systems and says Windows setup is similar with adjusted commands and paths. source
Extensibility
Plugins can add support for programming languages or revision control systems. source
Maintenance
The project says it is maintained by enthusiasts and volunteers from around the world. source
Purpose
OpenGrok is a Java source code search and cross-reference engine for searching, cross-referencing, and navigating source trees. source
Release
The releases page lists version 1.14.19 as the latest release and describes it as allowing Java 25. source
Repository integrations
The supported revision control systems include Git, Mercurial, Subversion, CVS, Perforce, ClearCase, Bazaar, Monotone, Razor, RCS, SCCS, Teamware, and AccuRev. source
Requirements
The setup guide lists Java 21 through 25, Universal Ctags, a servlet container such as Tomcat 10.x, and a recent browser for clients. source
Resource needs
The guide says the indexer is usually run with an 8 GB JVM heap and the web app needs more memory. source
Search features
It searches full text, definitions, symbols, paths, and revision history, with subtree searches, wildcards, and date-range filters. source
Security
OpenGrok provides a granular authorization framework, while authentication is handled by the application server or a reverse proxy. source
Support
The project directs users to discussions and mailing lists, and asks users to report bugs or feature requests through GitHub Issues. source

Checked against the maker's pages on 5 Oct 2026.