license-audit v0.0.5

NPM License Audit

Ever needed to do the license audit & security audit for your npm project?

It's this easy:

npm install -g license-audit

cd /path/to/your/module/
license-audit

Options

• --start [path of the initial json to look for]
• --json output in json format.
• --csv output in csv format.
• --html output in csv format.
• --out [filepath] write the data to a specific file.
• --customPath to add a custom Format file in JSON

• --direct look for direct dependencies only.

• --version The current version.

• --help See help

Examples

license-audit --json > /path/to/licenses.json
license-audit --csv --out /path/to/licenses.csv
license-audit --customPath customFormatExample.json

Custom format

The --customPath option can be used with CSV to specify the columns.

When used with JSON format, it will add the specified items.

The available items are the following:

• name (default)
• dependencyOf
• description
• installedVersion (default)
• latestVersion (default)
• license (default)
• repository (default)
• score
• quality
• popularity
• maintenance

See an example in customFormatExample.json.

Debugging

license-audit uses debug for internal logging. There’s two internal markers:

• license-audit:error for errors
• license-audit:log for non-errors

Set the DEBUG environment variable to one of these to see debug output:

$ export DEBUG=license-audit*; license-audit