segugio
v1.2.1
Published
CLI for easy npm/bower licence scanning
Downloads
4
Readme
segugio
This is a tool for scanning folders, collecting informations (especially licenses) about npm
/bower
modules and report them.
Let's say it is a FOSS scanner. At least, I'm using it this way... :)
Setup
Install segugio
s a global node
module, it's recommended. Anyway, you can even use it programmatically inside a project.
$ npm install -g segugio
How it works as CLI
$ segugio report
to create a report of all bundles (functional unit with a package.json
or a bower.json
).
$ segugio export
to export all the information in a json format.
$ segugio test
to test segugio
functionality.
$ segugio --help
to print out the CLI help.
Tip:
$ segugio export > filename.json
exports a json file.
How it works programmatically
let segugio = require('segugio');
segugio.scan().then(results => {
// do whatever you want with information
}, error => {
// manage the error
});
That's all, folks!