LicenseScout

LicenseScout is a tool to identify third-party artifacts (libraries) and their licenses, in Java as well as JavaScript projects. The goal is to get an overview over the used licenses, and the artifacts for which no license could be detected.

Key features include:

Scanning Java and Javascript/NPM artifacts
Writing reports in different file formats
Writing results to a database
Defining licenses manually for certain artifacts
Exclude artifacts completely

Quick start

You need a working Maven 3 installation
check out all LicenseScout projects
cd org.aposin.licensescout.quickstart
mvn clean install
The reports are written to the directory org.aposin.licensescout.licensereport/target/licensescout
- HTML report: licensereport.html
- CSV report: licensereport.csv
- TXT report: licensereport.txt

Projects overview

Table 1. LicenseScout projects

artifactId	Purpose
`licensescout-parent`	Parent POM for all other LicenseScout projects
`licensescout-core`	Code for the processing core of the LicenseScout
`licensescout-maven-utils`	Utility methods related to the Maven runtime system
`licensescout-maven-plugin`	Code for LicenseScout maven plugin
`licensescout-report-maven-plugin`	Code for LicenseScout maven plugin generating site reports
`org.aposin.licensescout.configuration.sample`	Sample configuration files
`org.aposin.licensescout.licensereport`	Sample for LicenseScout build integration, generates license reports for LicenseScout itself (using the sample configuration)
`org.aposin.licensescout.quickstart`	Compiles the Maven plugin, creates the sample configuration bundle and generates a license report for LicenseScout itself.
`licensescout-documentation`	Documentation and project logos for LicenseScout