snyk-licenses-texts

Snyk Licenses Texts

Usage no npm install needed!

<script type="module">
  import snykLicensesTexts from 'https://cdn.skypack.dev/snyk-licenses-texts';
</script>

README

Snyk logo

Known Vulnerabilities

Snyk helps you find, fix and monitor for known vulnerabilities in your dependencies, both on an ad hoc basis and as part of your CI (Build) system.

Snyk snyk-licenses-texts

Snyk Licenses Report that provides Organization level licenses used, copyrights & dependencies data (including license texts & their urls).

Installation

Download the latest binary from the releases page

Usage

Ensure SNYK_TOKEN is set and has access to the Organization you want to generate the report for.

Basic CLI commands

  • help - show help & all available commands and their options
  • json - generate the raw JSON licenses & dependencies data
  • generate - generates an HTML report of licenses & dependencies data

Supported Options

Example usage:

  • See help: snyk-licenses-report help
  • Get JSON output only: snyk-licenses-report json --orgPublicId=<ORG_PUBLIC_ID>
  • Default HTML report (Licenses per Org view): snyk-licenses-report generate --orgPublicId=<ORG_PUBLIC_ID>
  • See more information on what is hapenning behind the scenes: DEBUG=snyk-license* snyk-licenses-report generate --orgPublicId=<ORG_PUBLIC_ID>
  • Custom Handlebars.js template provided: snyk-licenses-report generate --orgPublicId=<ORG_PUBLIC_ID> --template="PATH/TO/TEMPLATE/template.hsb" The data in the template is available is in the format:
    {
  licenses: LicenseReportData;
  orgPublicId: string;
  orgData: OrgData;
}
    See the relevant TypeScript types in the repo for full information.

Development setup

  • npm i
  • npm run test (requires TEST_ORG_ID & SNYK_TEST_TOKEN from 1 password)
  • DEBUG=snyk-license* node dist/index.js generate --orgPublicId=<ORG_PUBLIC_ID>