
π ScanCode detects licenses, copyrights, dependencies by "scanning code" ... to discover and inventory open source and third-party packages used in your code. Sponsored by NLnet, the Google Summer of Code, Azure credits, nexB and other generous sponsors!
ScanCode Toolkit is a set of code scanning tools that detect the origin (copyrights), license and vulnerabilities of code,
packages and dependencies in a codebase. ScanCode Toolkit is an AboutCode project <https://aboutcode.org>_.
ScanCode Toolkit is the leading tool in scanning depth and accuracy, used by hundreds of software teams. You can use ScanCode Toolkit as a command line tool or as a library.
Instructions to get you up and running on your local machine are at Getting Started <https://scancode-toolkit.readthedocs.io/en/stable/getting-started/index.html>_
The ScanCode Toolkit documentation also provides:
We run 30,000+ tests on each commit on multiple CIs to ensure a good platform compabitility with multiple versions of Windows, Linux and macOS.
+------------+--------------+-------------------------+----------------------------+ | Azure | RTD Build| GitHub actions Docs | GitHub actions Release | +============+==============+=========================+============================+ | |azure| | |docs-rtd| | |docs-github-actions| | |release-github-actions| | +------------+--------------+-------------------------+----------------------------+
ScanCode is heavily tested with an automated test suite of over 30,000 tests.
ScanCode is used by several projects and organizations such as
the Eclipse Foundation <https://www.eclipse.org>,
OpenEmbedded.org <https://www.openembedded.org>,
the FSFE <https://www.fsfe.org>,
the FSF <https://www.fsf.org>,
OSS Review Toolkit <http://oss-review-toolkit.org>,
ClearlyDefined.io <https://clearlydefined.io/>,
RedHat Fabric8 analytics <https://github.com/fabric8-analytics>_,
and many more.
You can also organize and run ScanCode server-side with the
companion ScanCode.io web app <https://github.com/aboutcode-org/scancode.io>_
to organize and store multiple scan projects including scripted scanning pipelines.
As a standalone command-line tool, ScanCode is easy to install, run, and embed in your CI/CD processing pipeline. It runs on Windows, macOS, and Linux.
ScanCode detects licenses, copyrights, package manifests, direct dependencies, and more both in source code and binary files and is considered as the best-in-class and reference tool in this domain, re-used as the core tools for software composition data collection by several open source tools.
ScanCode provides the most accurate license detection engine and does a full comparison (also known as diff or red line comparison) between a database of license texts and your code instead of relying only on approximate regex patterns or probabilistic search, edit distance or machine learning.
Written in Python, ScanCode is easy to extend with plugins to contribute new and improved scanners, data summarization, package manifest parsers, and new outputs.
You can save your scan results as JSON, YAML, HTML, CycloneDX or SPDX or even create your own format with Jinja templates.
ScanCode can process packages, build manifest and lockfile formats to collect
Package URLs and extract metadata. See all available package parsers <https://scancode-toolkit.readthedocs.io/en/stable/reference/index.html>_
for the exhaustive list.
The ScanCode documentation is hosted at
scancode-toolkit.readthedocs.io <https://scancode-toolkit.readthedocs.io/en/latest/>_.
See also https://aboutcode.org for related companion projects and tools.
To cite this repository, visit the main page and click on the 'Cite this repository' button for APA or BibTeX citation formats.
If you have a specific problem, suggestion or bug, please submit a
GitHub issue <https://github.com/aboutcode-org/scancode-toolkit/issues>_.
For quick questions or socializing, join the AboutCode community discussions on Slack <https://join.slack.com/t/aboutcode-org/shared_invite/zt-3li3bfs78-mmtKG0Qhv~G2dSlNCZW2pA>_.
Interested in commercial suppport? Contact the AboutCode team <mailto:[email protected]>_.
Apache-2.0 <apache-2.0.LICENSE>_ is the overall license.CC-BY-4.0 <cc-by-4.0.LICENSE>_ applies to reference datasets.See the NOTICE file <NOTICE>_ and the .ABOUT files <https://github.com/search?q=repo%3Aaboutcode-org%2Fscancode-toolkit+path%3A*.ABOUT&type=code>_ that document the origin and license of
the third-party code used in ScanCode for more details.
.. |azure| image:: https://dev.azure.com/nexB/scancode-toolkit/_apis/build/status/nexB.scancode-toolkit?branchName=develop :target: https://dev.azure.com/nexB/scancode-toolkit/_build/latest?definitionId=1&branchName=develop :alt: Azure tests status (Linux, macOS, Windows)
.. |docs-rtd| image:: https://readthedocs.org/projects/scancode-toolkit/badge/?version=latest :target: https://scancode-toolkit.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. |docs-github-actions| image:: https://github.com/nexB/scancode-toolkit/actions/workflows/docs-ci.yml/badge.svg?branch=develop :target: https://github.com/nexB/scancode-toolkit/actions/workflows/docs-ci.yml :alt: Documentation Tests
.. |release-github-actions| image:: https://github.com/nexB/scancode-toolkit/actions/workflows/scancode-release.yml/badge.svg?event=push :target: https://github.com/nexB/scancode-toolkit/actions/workflows/scancode-release.yml :alt: Release tests
This project is funded, supported and sponsored by:
|europa| |dgconnect|
|ngi| |nlnet|
|aboutcode| |nexb|
This project was funded through the NGI0 Discovery Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 825322.
|ngidiscovery| https://nlnet.nl/project/vulnerabilitydatabase/
This project was funded through the NGI0 Entrust Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 101069594.
|ngizeroentrust| https://nlnet.nl/project/Back2source/
This project was funded through the NGI0 Core Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 101092990.
|ngizerocore| https://nlnet.nl/project/Back2source-next/