# README

Istio License Linter

This tool is used to ensure that the dependencies of a repo have acceptable licenses. The tool can be used in three modes:

Linting. This ensures all dependencies of the current repo have unrestricted or reciprocal licenses, producing an error if any modules have a restricted or unknown license:
```
$ license-lint --config <config file>
```
Report. Lists license information for all dependencies:
```
$ license-lint --config <config file> --report
```
CSV. Lists license information for all dependencies in CSV format:
```
$ license-lint --config <config file> --report
```

Dump. Shows all licenses for all dependencies:

$ license-lint --config <config file> --dump

Mirror. Generates a licenses directory enumerating all modules and their exact license files.
```
$ license-lint --mirror
```

The configuration is specified in a YAML file with four stanzas:

unrestricted_licenses:
  - license name 1
  - license name 2
reciprocal_licenses:
  - license name 1
  - license name 2
restricted_licenses:
  - license name 1
  - license name 2
allowlisted_modules:
  - module name 1
  - module name 2