Node License Finder (nlf)
nlf is a utility for attempting to identify the licenses of modules in a node.js project.
It looks for license information in package.json, readme and license files in the project. Please note, in many cases the utility is looking for standard strings in these files, such as MIT, BSD, Apache, GPL etc - this is not error free, so if you have any concerns at all about the accuracy of the results, you will need to perform a detailed manual review of the project and its dependencies, reading all terms of any included or referenced license.
Use
nlf can be used programmatically, or from the command line.
Options
- -c, --csv (Default:false) - output in csv format
- -d, --no-dev (Default:false) - exclude development dependencies
- -r, --reach (Default: Infinity) - package depth (reach), 0 is current package.json file only
- -s, --summary off|simple|detail (Default: simple) - summary information, not available in csv format
CLI
To install:
$ npm install -g nlf
To use:
$ cd my-module
$ nlfExample output: <pre archy@0.0.2 [license(s): MIT/X11] └── package.json: MIT/X11
commander@0.6.1 [license(s): MIT] └── readme files: MIT
glob@3.2.3 [license(s): BSD] ├── package.json: BSD └── license files: BSD
json-stringify-safe@5.0.0 [license(s): BSD] ├── package.json: BSD └── license files: BSD
read-installed@0.2.2 [license(s): BSD] └── license files: BSD
should@1.2.2 [license(s): MIT] └── readme files: MIT