About Apache Rat

Rat audits software distributions, with a special interest in headers. If this isn't quite what you're looking for then take a look at the other products developed by Apache Creadur, including Apache Whisker which audits and generates legal (for example LICENSE) documents for complex software distributions.

Developing Rat

Introducing the Modules

This module, apache-rat-core, is a library containing the basic engine. Other modules allow this engine to be run in various ways.

Modules that run Rat
Runs Rat via Requires Module
An Ant task Apache Ant apache-rat-tasks
The command line Java® apache-rat
A Maven plugin Apache Maven apache-rat-plugin

Support for new build tools and alternative ways to run rat should be coded in new modules building on apache-rat-core. Developers interested in improving existing support for a specific build tool should start by taking a look at that module.

Diving into Core

Browse the source here.

Read the JavaDocs here.

Check out with Subversion

svn co https://svn.apache.org/repos/asf/creadur/rat/trunk/

Build with Apache Maven

mvn install

Subscribe to our mailing lists for a warm welcome one and all.