/license-report

create a short report about a project's dependencies (license, url etc)

Primary LanguageJavaScriptMIT LicenseMIT

license report tool

generate license report of a project's dependencies

install

npm install -g license-report

usage

simple:

cd your/project/
license-report

by default, license-report outputs all licenses from dependencies and devDependencies. To specify one or the other, use --only

license-report --only=dev
license-report --only=prod

explicit package.json:

license-report --package=/path/to/package.json

customize a field's label:

license-report --report.label.department=division

customize a default value (only applicable for some fields):

license-report --department.label=division --department.value=ninjaSquad

another registry:

license-report --registry=https://myregistry.com/

different outputs:

license-report --output=table
license-report --output=json
license-report --output=csv

# replace default ',' separator with something else
license-report --output=csv --delimiter="|" 

# output csv headers (fields) on first row
license-report --output=csv --csvHeaders

exclude:

license-report --exclude=async --exclude=rc

screenshot

debug

export DEBUG=license-report*

see lib/config.js for more details

use rc for further customization

TODO

Requires a serious refactor!

ironSource logo