Setup and installation

Step 1. Install dependencies

npm install

Step 2. Build the application

npm run build

Step 3. Run the application

node build/cli.js -f xlsx -o /tmp/output.xlsx [path to project]    # XLSX output to the specified output file
node build/cli.js -f json -o /tmp/output.json [path to project]    # JSON output to the specified output file
node build/cli.js -f json [path to project]                        # JSON output to the console
node build/cli.js -f text [path to project]                        # human-readable text output
node build/cli.js [path to project]                                # same as above (text is the default format)

Building native binaries for distribution

You can also build native binaries for easier distribution and convenience of use:

npm run dist                                     # macOS only
npm run dist-all                                 # macOS, Linux and Windows

These commands generate native executable binaries under the bin/ directory. They accept the exact same arguments as illustrated above:

bin/license-analysis -f json -o /tmp/output.json [path to project]  # Same command-line arguments as in Step 3

License

This software is MIT licensed.