:warning: This repository is in maintenance mode, no new features are being developed. Bug & security fixes will continue to be delivered. Open source contributions are welcome for small features & fixes (no breaking changes)
:warning: Please note that as of January 8, 2024 copyright data will no longer be available due to Copyright Service End-of-Life
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 Licenses Text report that provides Organization level licenses used, copyrights & dependencies data (including license texts & their urls). Optionally the results can be filtered for a specific projects.
The tool is a wrapper around Snyk APIs so users must have API access (including Reporting, Licenses & Dependencies APIs)
Download the latest binary from the releases page
Ensure SNYK_TOKEN
is set and has access to the Organization you want to generate the report for.
help
- show help & all available commands and their optionsjson
- generate the raw JSON licenses & dependencies data for a Snyk Organization (can filter for a specific Snyk project)generate
- generates an HTML report of licenses & dependencies data for a Snyk Organization (can filter for a specific Snyk project)Commands:
snyk-licenses-report generate Generate org licenses & dependencies report in HTML format
[aliases: g]
snyk-licenses-report json Generate org licenses & dependencies data in JSON format
[aliases: j]
Example usage:
snyk-licenses-report --help
snyk-licenses-report --help generate
snyk-licenses-report json --orgPublicId=<ORG_PUBLIC_ID>
snyk-licenses-report generate --orgPublicId=<ORG_PUBLIC_ID>
snyk-licenses-report generate --orgPublicId=<ORG_PUBLIC_ID> --project=<PROJECT_PUBLIC_ID>
DEBUG=snyk-license* snyk-licenses-report generate --orgPublicId=<ORG_PUBLIC_ID>
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.
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>