licscan

Software license scanner. API reference

Held in this tab only, and sent as Authorization: Bearer on every request. Closing the tab forgets it.

A .tar.gz of a source tree. It is unpacked and scanned the way a clone is, so a file whose only licensing content is See LICENSE for details resolves against its sibling LICENSE — which the same file posted to One file cannot do.

License scanner mode
About these options

SPDX answers in SPDX ids. A license SPDX has no id for goes unnamed, and a license named without a version gets a *-VERSIONLESS label, such as GPL-only-VERSIONLESS for a plain “GPL”, rather than a version the text does not state.

ScanCode answers the way ScanCode does: an SPDX id where SPDX lists the license, and otherwise a key of ScanCode’s license catalog, such as ms-nuget, or unknown where the catalog lacks it. A license named without a version gets the version ScanCode assigns: a plain “GPL” is GPL-1.0-or-later, which the text does not state. Follow external references (on unless unchecked) answers a URL naming another project’s license file, such as a GitHub LICENSE or NuGet’s licenseUrl, with the license ScanCode records for that URL. Concept keys (off unless checked) adds ScanCode’s keys for what a text is rather than which license it names, such as proprietary-license, unknown-license-reference and public-domain.

Licscan reads ScanCode’s catalog as ScanCode mode does, but answers in SPDX’s own forms and never assigns a version: LicenseRef-scancode-… for a license in the catalog, AdditionRef-scancode-… for one of its exceptions, and LicenseRef-licscan-…, carrying the name that was read, for a license the catalog lacks.

The tagger is a model that reads license names in what the rules leave unanswered. Turned off, the rules answer alone: faster, and what they leave stays unanswered. The window cache keeps its readings of text it has read before; it changes no answer, only the time.

Each license found shows its category, the one ScanCode’s catalog classes it in — Permissive, Copyleft, Copyleft Limited, Proprietary Free, Commercial, Non-Commercial, Source-available and the rest — or “—” where the catalog gives none, such as a license named without a version. It changes no answer. SPDX mode reports the licenses SPDX lists and nothing else, so a license SPDX does not list, such as a vendor’s agreement, is named, with its category, only in ScanCode and Licscan mode.

These settings apply to the next scan on any tab.