Is there an OpenGrok API?

Question

Is there an API for OpenGrok? I'm interested in mining the results in either Perl or Java. At the moment, I could perform HTML scrapping against the results, but seems less-than-ideal.

As per its website, it leverages Lucene, but no real info on how to connect to it other than via HTML.

Answer 1

Opengrok supports a command line interface that may be able to provide what you're looking for.

Example:

$ java -cp ./opengrok.jar org.opensolaris.opengrok.search.Search -R /var/opengrok/etc/configuration.xml -f "My Search"

Answer 2

This fork has a JSON API: https://github.com/Goyaka/OpenGrok/blob/f70d78e743a0a389b46ea36c4785182ee8f03e13/src/com/goyaka/opengrok/web/SearchServlet.java

This issue discusses it: https://github.com/OpenGrok/OpenGrok/issues/422

Answer 3

Starting in OpenGrok 0.13, there is a simple REST API.

With OpenGrok 1.0 there is a JSON API.