Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/snyk-tech-services/snyk-licenses-texts
📑 Snyk API powered licenses attribution report tool. Generate licenses information per Snyk Organization with license name, text, dependencies data and copyright information
https://github.com/snyk-tech-services/snyk-licenses-texts
html-report json snyk snyk-tooling vulnerabilities
Last synced: about 1 month ago
JSON representation
📑 Snyk API powered licenses attribution report tool. Generate licenses information per Snyk Organization with license name, text, dependencies data and copyright information
- Host: GitHub
- URL: https://github.com/snyk-tech-services/snyk-licenses-texts
- Owner: snyk-tech-services
- License: other
- Created: 2020-09-02T09:54:47.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-03T10:34:45.000Z (6 months ago)
- Last Synced: 2024-05-14T18:14:50.595Z (about 2 months ago)
- Topics: html-report, json, snyk, snyk-tooling, vulnerabilities
- Language: HTML
- Homepage: https://snyk.io
- Size: 922 KB
- Stars: 12
- Watchers: 3
- Forks: 10
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Lists
- awesome-snyk-community - snyk-licenses-texts - Generate a Snyk organization-level report showing licenses and copyright attribution for all dependencies in use (Snyk CLI, Plugins, Extensions, Filters)
README
***
[](https://snyk.io/test/github/snyk-tech-services/snyk-licenses-texts)
[](https://gist.github.com/cheerfulstoic/d107229326a01ff0f333a1d3476e068d)
: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](https://updates.snyk.io/snyk-open-source-upcoming-end-of-life-notice-for-copyright-service-effective-january-8-2024-280362)**
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 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](https://snyk.docs.apiary.io/) so users must have API access (including Reporting, Licenses & Dependencies APIs)
# Installation
Download the latest binary from the [releases](https://github.com/snyk-tech-services/snyk-licenses-texts/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 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)
### Supported Options
```
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:
- See help: `snyk-licenses-report --help`
- See help and available options for a specific command: `snyk-licenses-report --help generate`
- Get JSON output only: `snyk-licenses-report json --orgPublicId=`
- Default HTML report (Licenses per Org view): `snyk-licenses-report generate --orgPublicId=`
- Default HTML report (Licenses per Org view) filtered for a specific project: `snyk-licenses-report generate --orgPublicId= --project=`
- See more information on what is happening behind the scenes: `DEBUG=snyk-license* snyk-licenses-report generate --orgPublicId=`
- Custom Handlebars.js template provided:
`snyk-licenses-report generate --orgPublicId= --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=`