In a hurry? Jump to quick start
Apache Rat is a release audit tool, focused on licenses.
Use Rat to improve accuracy and efficiency when checking releases for licenses.
Reviewing releases in the Apache Incubator by hand was error-prone and time-consuming.
Rat arises from the Apache style, but is used more widely. If your release style isn't supported, talk to us.
Apache Rat 0.17-SNAPSHOT ships with tooling for
Rat is extensible. If your build tool isn't supported, please contribute a patch or talk to us.
Rat aspires to be self documenting. Please contribute a patch or talk to us whenever Rat falls short.
There are several standard ways to extend Rat.
Apache Rat is part of the Apache Creadur language- and build-agnostic suite of tools for auditing and comprehending software distributions. Our community develops open source software the Apache way.
Please feel free to contribute a patch, demonstrate a bug, or just talk to us. All welcome :-)
Quick start by
java -jar apache-rat-0.17-SNAPSHOT.jar --help
Read more here.
Use the task library for Apache Ant 1.7 or later
Read more here.
Use the plugin for Apache Maven 3.9.8 or later.
ATTENTION! Maven4 is based on Java 17 and thus cannot be used with RAT, that relies on Java 8.
<plugin> <groupId>org.apache.rat</groupId> <artifactId>apache-rat-plugin</artifactId> <version>0.17-SNAPSHOT</version> </plugin>
Read more here.
Rat allows you to style the output as you see fit. Three stylesheets are included in the rat package.
These stylesheets can be specified using options in the command line, Maven or Ant clients.
In addition, new stylesheets may be developed and applied to create new reports.
Quick start
git clone https://gitbox.apache.org/repos/asf/creadur-rat.git
Read more here.
Build Rat with Apache Maven
Quick start
If you want to build RAT just launch 'mvn' or './mvnw' inside the root folder. It will automatically perform a
mvn clean install